Package adams.data.filter.heatmapcrop

Class AbstractFilteredHeatmapCrop

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    Direct Known Subclasses:
    CropToCentroid
    public abstract class AbstractFilteredHeatmapCrop
extends AbstractHeatmapCrop
    Ancestor for crop algorithms that filter the original heatmap first before performing the actual crop.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.data.filter.Filter m_Filter
      the filter to apply to the data first.

      • 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 Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected Heatmap doCrop​(Heatmap data)
      Performs the actual filtering.
      protected abstract Heatmap doCrop​(Heatmap filtered, Heatmap original)
      Performs the actual cropping, using the pre-filtered heatmap to manipulate the original heatmap.
      String filterTipText()
      Returns the tip text for this property.
      protected adams.data.filter.Filter getDefaultFilter()
      Returns the default pre-filter to use.
      adams.data.filter.Filter getFilter()
      Returns the current pre-filter.
      void setFilter​(adams.data.filter.Filter value)
      Sets the pre-filter.

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_Filter

        protected adams.data.filter.Filter m_Filter
        the filter to apply to the data first.

    • Constructor Detail

      • AbstractFilteredHeatmapCrop

        public AbstractFilteredHeatmapCrop()

    • Method Detail

      • 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

      • getDefaultFilter

        protected adams.data.filter.Filter getDefaultFilter()
        Returns the default pre-filter to use.
        Returns:
        the default

      • setFilter

        public void setFilter​(adams.data.filter.Filter value)
        Sets the pre-filter.
        Parameters:
        value - the filter

      • getFilter

        public adams.data.filter.Filter getFilter()
        Returns the current pre-filter.
        Returns:
        the filter

      • filterTipText

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

      • doCrop

        protected abstract Heatmap doCrop​(Heatmap filtered,
                                  Heatmap original)
        Performs the actual cropping, using the pre-filtered heatmap to manipulate the original heatmap.
        Parameters:
        filtered - the pre-filtered heatmap
        original - the original heatmap
        Returns:
        the final data

      • doCrop

        protected Heatmap doCrop​(Heatmap data)
        Performs the actual filtering.
        Specified by:
        doCrop in class AbstractHeatmapCrop
        Parameters:
        data - the data to filter
        Returns:
        the filtered data