Package adams.gui.visualization.spectrum

Class SpectrumPaintletNumericField

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.gui.visualization.core.Paintlet>, adams.core.SizeOfHandler, adams.gui.core.AntiAliasingSupporter, adams.gui.visualization.core.Paintlet, adams.gui.visualization.core.PaintletWithMarkers, Serializable
    public class SpectrumPaintletNumericField
extends SpectrumPaintlet
    Paintlet for painting the spectral graph. Colors are determined by the value of the specified numeric field in the report.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Field

        protected adams.data.report.Field m_Field
        the report field to get the numeric value from.

      • m_Generator

        protected adams.gui.visualization.core.ColorGradientGenerator m_Generator
        the color gradient generator to use.

      • m_DefaultColor

        protected Color m_DefaultColor
        the default color if field is missing.

      • m_Colors

        protected transient Color[] m_Colors
        the colors.

    • Constructor Detail

      • SpectrumPaintletNumericField

        public SpectrumPaintletNumericField()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Overrides:
        globalInfo in class SpectrumPaintlet
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class SpectrumPaintlet

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.core.option.AbstractOptionHandler

      • setField

        public void setField​(adams.data.report.Field value)
        Sets the numeric field to determine the color with.
        Parameters:
        value - the numeric field

      • getField

        public adams.data.report.Field getField()
        Returns the numeric field to determine the color with.
        Returns:
        the numeric field

      • fieldTipText

        public String fieldTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setGenerator

        public void setGenerator​(adams.gui.visualization.core.ColorGradientGenerator value)
        Sets the color gradient generator to use.
        Parameters:
        value - the generator

      • getGenerator

        public adams.gui.visualization.core.ColorGradientGenerator getGenerator()
        Returns the color gradient generator to use.
        Returns:
        the generator

      • generatorTipText

        public String generatorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setDefaultColor

        public void setDefaultColor​(Color value)
        Sets the default color to use when then report field is missing or invalid.
        Parameters:
        value - the color

      • getDefaultColor

        public Color getDefaultColor()
        Returns the default color to use when then report field is missing or invalid.
        Returns:
        the color

      • defaultColorTipText

        public String defaultColorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getColor

        public Color getColor​(int index)
        Returns the color for the data with the given index.
        Overrides:
        getColor in class SpectrumPaintlet
        Parameters:
        index - the index of the spectrum
        Returns:
        the color for the spectrum