Package adams.data.filter.heatmapthreshold

Class AbstractHeatmapThreshold

  • 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:
    AbstractBufferedImageBasedHeatmapThreshold, Manual
    public abstract class AbstractHeatmapThreshold
extends adams.core.option.AbstractOptionHandler
    Ancestor for algorithsm that determine a threshold from a heatmap.
    Version:
    $Revision$
    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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      double calcThreshold​(Heatmap map)
      Calculates the threshold for the given heatmap.
      protected void check​(Heatmap map)
      Checks whether the heatmap can be processed, throws an IllegalArgumentException if not.
      protected abstract double doCalcThreshold​(Heatmap map)
      Performs the actual calculation of the threshold.

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

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

    • Constructor Detail

      • AbstractHeatmapThreshold

        public AbstractHeatmapThreshold()

    • Method Detail

      • check

        protected void check​(Heatmap map)
        Checks whether the heatmap can be processed, throws an IllegalArgumentException if not.

        Default implementation only checks whether a heatmap is present.
        Parameters:
        map - the heatmap to check.

      • doCalcThreshold

        protected abstract double doCalcThreshold​(Heatmap map)
        Performs the actual calculation of the threshold.
        Parameters:
        map - the map to base the calculation on
        Returns:
        the threshold

      • calcThreshold

        public double calcThreshold​(Heatmap map)
        Calculates the threshold for the given heatmap.
        Parameters:
        map - the map to base the calculation on
        Returns:
        the threshold