Package adams.flow.transformer.multiheatmapoperation

Class AddConstant

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    public class AddConstant
extends AbstractMultiHeatmapOperation<Heatmap[]>
    Adds the specified constant value to all cells in the heatmaps.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected double m_Value
      the constant value to add.

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      AddConstant()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected Heatmap[] doProcess​(Heatmap[] maps, adams.core.MessageCollection errors)
      Performs the actual processing of the heatmaps.
      Class generates()
      The type of data that is generated.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      double getValue()
      Returns the constant value to add.
      String globalInfo()
      Returns a string describing the object.
      int maxNumSheetsRequired()
      Returns the maximum number of heatmaps that are required for the operation.
      int minNumSheetsRequired()
      Returns the minimum number of heatmaps that are required for the operation.
      void setValue​(double value)
      Sets the constant value to add.
      String valueTipText()
      Returns the tip text for this property.

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

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

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

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

        getLoggingLevel

    • Field Detail

      • m_Value

        protected double m_Value
        the constant value to add.

    • Constructor Detail

      • AddConstant

        public AddConstant()

    • 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

      • setValue

        public void setValue​(double value)
        Sets the constant value to add.
        Parameters:
        value - the value

      • getValue

        public double getValue()
        Returns the constant value to add.
        Returns:
        the value

      • valueTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractMultiHeatmapOperation<Heatmap[]>
        Returns:
        null if no info available, otherwise short string

      • minNumSheetsRequired

        public int minNumSheetsRequired()
        Returns the minimum number of heatmaps that are required for the operation.
        Specified by:
        minNumSheetsRequired in class AbstractMultiHeatmapOperation<Heatmap[]>
        Returns:
        the number of heatmaps that are required, <= 0 means no lower limit

      • maxNumSheetsRequired

        public int maxNumSheetsRequired()
        Returns the maximum number of heatmaps that are required for the operation.
        Specified by:
        maxNumSheetsRequired in class AbstractMultiHeatmapOperation<Heatmap[]>
        Returns:
        the number of heatmaps that are required, <= 0 means no upper limit

      • doProcess

        protected Heatmap[] doProcess​(Heatmap[] maps,
                              adams.core.MessageCollection errors)
        Performs the actual processing of the heatmaps.
        Specified by:
        doProcess in class AbstractMultiHeatmapOperation<Heatmap[]>
        Parameters:
        maps - the heatmaps to process
        errors - for collecting errors
        Returns:
        the generated data