Class HeatmapCrop

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<>, adams.core.SizeOfHandler,<Heatmap>, Serializable, Comparable

    public class HeatmapCrop
    Generates a cropped heatmap by applying the specified crop algorithm.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
    -no-id-update <boolean> (property: dontUpdateID)
        If enabled, suppresses updating the ID of data containers.
        default: false
    -algorithm <> (property: algorithm)
        The height of the cropped region.
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class<T extends>
    • Field Summary

      Modifier and Type Field Description
      protected AbstractHeatmapCrop m_Algorithm
      the crop algorithm.
      • Fields inherited from class

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

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel
    • Constructor Summary

      Constructor Description
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String algorithmTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      AbstractHeatmapCrop getAlgorithm()
      Returns the crop algorithm.
      String globalInfo()
      Returns a string describing the object.
      protected Heatmap processData​(Heatmap data)
      Performs the actual filtering.
      void setAlgorithm​(AbstractHeatmapCrop value)
      Sets the crop algorithm.
      • Methods inherited from class

        checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy
      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, 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.logging.LoggingLevelHandler

        getLoggingLevel, setLoggingLevel
      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled
      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine
    • Constructor Detail

      • HeatmapCrop

        public HeatmapCrop()
    • 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
        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
        defineOptions in class<Heatmap>
      • setAlgorithm

        public void setAlgorithm​(AbstractHeatmapCrop value)
        Sets the crop algorithm.
        value - the algorithm
      • getAlgorithm

        public AbstractHeatmapCrop getAlgorithm()
        Returns the crop algorithm.
        the algorithm
      • algorithmTipText

        public String algorithmTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • processData

        protected Heatmap processData​(Heatmap data)
        Performs the actual filtering.
        Specified by:
        processData in class<Heatmap>
        data - the data to filter
        the filtered data