Package adams.data.filter.heatmapthreshold

Class Manual

  • 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
    public class Manual
extends AbstractHeatmapThreshold
    Performs no calculation, simply returns the user-specified threshold. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -threshold <double> (property: threshold)
    The threshold to use.
    default: 0.0
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected double m_Threshold
      the manual threshold.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected double doCalcThreshold​(Heatmap map)
      Performs the actual calculation of the threshold.
      double getThreshold()
      Returns the threshold to use.
      String globalInfo()
      Returns a string describing the object.
      void setThreshold​(double value)
      Sets the threshold to use.
      String thresholdTipText()
      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_Threshold

        protected double m_Threshold
        the manual threshold.

    • Constructor Detail

      • Manual

        public Manual()

    • 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

      • setThreshold

        public void setThreshold​(double value)
        Sets the threshold to use.
        Parameters:
        value - the threshold

      • getThreshold

        public double getThreshold()
        Returns the threshold to use.
        Returns:
        the threshold

      • thresholdTipText

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

      • doCalcThreshold

        protected double doCalcThreshold​(Heatmap map)
        Performs the actual calculation of the threshold.
        Specified by:
        doCalcThreshold in class AbstractHeatmapThreshold
        Parameters:
        map - the map to base the calculation on
        Returns:
        the threshold