Package adams.data.conversion

Class HeatmapToBufferedImage

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.data.conversion.AbstractConversion>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.conversion.Conversion, HeatmapToBufferedImageConversion, Serializable
    public class HeatmapToBufferedImage
extends adams.data.conversion.AbstractConversion
implements HeatmapToBufferedImageConversion
    Turns a heatmap into a BufferedImage. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -generator <adams.gui.visualization.core.ColorGradientGenerator> (property: generator)
    The generator to use for creating the gradient colors.
    default: adams.gui.visualization.core.BiColorGenerator
 
    -missing-value-color <java.awt.Color> (property: missingValueColor)
    The color to use for missing values.
    default: #00ffffff
 
    -use-fixed-range <boolean> (property: useFixedRange)
    Whether to use pre-defined min/max values or ones determined from the heatmap 
    itself.
    default: false
 
    -min <double> (property: min)
    The minimum to use in case of using a fixed range.
    default: 0.0
 
    -max <double> (property: max)
    The maximum to use in case of using a fixed range.
    default: 100.0
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.gui.visualization.core.ColorGradientGenerator m_Generator
      the generator to use.
      protected Color[] m_GradientColors
      the gradient colors.
      protected double m_Max
      the fixed max.
      protected double m_Min
      the fixed min.
      protected Color m_MissingValueColor
      the color for missing values.
      protected boolean m_UseFixedRange
      whether to use a fixed min/max.

      • Fields inherited from class adams.data.conversion.AbstractConversion

        m_Input, m_Output, m_Owner, m_Stopped

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class accepts()
      Returns the class that is accepted as input.
      protected String checkData()
      Checks whether the data can be processed.
      void defineOptions()
      Adds options to the internal list of options.
      protected Object doConvert()
      Performs the actual conversion.
      Class generates()
      Returns the class that is generated as output.
      String generatorTipText()
      Returns the tip text for this property.
      adams.gui.visualization.core.ColorGradientGenerator getGenerator()
      Returns the color generator.
      protected Color[] getGradientColors()
      Generates the gradient colors.
      double getMax()
      Returns the maximum in case of using a fixed range.
      double getMin()
      Returns the minimum in case of using a fixed range.
      Color getMissingValueColor()
      Returns the color for missing values.
      boolean getUseFixedRange()
      Returns whether to use a fixed range.
      String globalInfo()
      Returns a string describing the object.
      double grayToIntensity​(Heatmap map, int gray)
      Turns the gray value back into an intensity value.
      String maxTipText()
      Returns the tip text for this property.
      String minTipText()
      Returns the tip text for this property.
      String missingValueColorTipText()
      Returns the tip text for this property.
      protected void reset()
      Resets the object.
      void setGenerator​(adams.gui.visualization.core.ColorGradientGenerator value)
      Sets the color generator.
      void setMax​(double value)
      Sets the maximum in case of using a fixed range.
      void setMin​(double value)
      Sets the minimum in case of using a fixed range.
      void setMissingValueColor​(Color value)
      Sets the color for missing values.
      void setUseFixedRange​(boolean value)
      Sets whether to use a fixed range.
      String useFixedRangeTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.data.conversion.AbstractConversion

        cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.CleanUpHandler

        cleanUp

      • Methods inherited from interface adams.data.conversion.Conversion

        convert, getInput, getInput, getOutput, getOutput, getOwner, setInput, setOwner

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

      • Methods inherited from interface adams.core.QuickInfoSupporter

        getQuickInfo

      • Methods inherited from interface adams.core.Stoppable

        stopExecution

    • Field Detail

      • m_Generator

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

      • m_MissingValueColor

        protected Color m_MissingValueColor
        the color for missing values.

      • m_UseFixedRange

        protected boolean m_UseFixedRange
        whether to use a fixed min/max.

      • m_Min

        protected double m_Min
        the fixed min.

      • m_Max

        protected double m_Max
        the fixed max.

      • m_GradientColors

        protected Color[] m_GradientColors
        the gradient colors.

    • Constructor Detail

      • HeatmapToBufferedImage

        public HeatmapToBufferedImage()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        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 adams.core.option.AbstractOptionHandler

      • reset

        protected void reset()
        Resets the object.
        Overrides:
        reset in class adams.data.conversion.AbstractConversion

      • setGenerator

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

      • getGenerator

        public adams.gui.visualization.core.ColorGradientGenerator getGenerator()
        Returns the color generator.
        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.

      • setMissingValueColor

        public void setMissingValueColor​(Color value)
        Sets the color for missing values.
        Parameters:
        value - the color

      • getMissingValueColor

        public Color getMissingValueColor()
        Returns the color for missing values.
        Returns:
        the color

      • missingValueColorTipText

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

      • setUseFixedRange

        public void setUseFixedRange​(boolean value)
        Sets whether to use a fixed range.
        Parameters:
        value - true if to use fixed range

      • getUseFixedRange

        public boolean getUseFixedRange()
        Returns whether to use a fixed range.
        Returns:
        true if to use fixed range

      • useFixedRangeTipText

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

      • setMin

        public void setMin​(double value)
        Sets the minimum in case of using a fixed range.
        Parameters:
        value - the minimum

      • getMin

        public double getMin()
        Returns the minimum in case of using a fixed range.
        Returns:
        the minimum

      • minTipText

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

      • setMax

        public void setMax​(double value)
        Sets the maximum in case of using a fixed range.
        Parameters:
        value - the maximum

      • getMax

        public double getMax()
        Returns the maximum in case of using a fixed range.
        Returns:
        the maximum

      • maxTipText

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

      • accepts

        public Class accepts()
        Returns the class that is accepted as input.
        Specified by:
        accepts in interface adams.data.conversion.Conversion
        Specified by:
        accepts in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • generates

        public Class generates()
        Returns the class that is generated as output.
        Specified by:
        generates in interface adams.data.conversion.Conversion
        Specified by:
        generates in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • getGradientColors

        protected Color[] getGradientColors()
        Generates the gradient colors.
        Returns:
        the colors

      • checkData

        protected String checkData()
        Checks whether the data can be processed.
        Overrides:
        checkData in class adams.data.conversion.AbstractConversion
        Returns:
        null if checks passed, otherwise error message

      • doConvert

        protected Object doConvert()
                    throws Exception
        Performs the actual conversion.
        Specified by:
        doConvert in class adams.data.conversion.AbstractConversion
        Returns:
        the converted data
        Throws:
        Exception - if something goes wrong with the conversion

      • grayToIntensity

        public double grayToIntensity​(Heatmap map,
                              int gray)
        Turns the gray value back into an intensity value.
        Specified by:
        grayToIntensity in interface HeatmapToBufferedImageConversion
        Parameters:
        map - the map that got converted
        gray - the gray value (0-255)
        Returns:
        the generated intensity value