Package adams.flow.transformer.multiheatmapoperation

Class Subtract

  • 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 Subtract
extends AbstractMultiHeatmapOperation<Heatmap>
    Subtracts the values of the other heatmaps from the first one.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • 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
      Subtract()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void check​(Heatmap[] maps)
      Checks the heatmaps.
      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 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.

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

        cleanUpOptions, defineOptions, 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

    • Constructor Detail

      • Subtract

        public Subtract()

    • 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

      • 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