Class SimpleSubRange

  • 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 SimpleSubRange
    extends AbstractNumericClassPostProcessor
    Generates an Evaluation object based on the actual class values that fall within the specified interval ranges.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    -minimum <double> (property: minimum)
        The minimum value that the values must satisfy; use NaN (not a number) to
        ignore minimum.
        default: NaN
     
    -minimum-included <boolean> (property: minimumIncluded)
        If enabled, then the minimum value gets included (testing '<=' rather than
        '<').
        default: false
     
    -maximum <double> (property: maximum)
        The maximum value that the values must satisfy; use NaN (not a number) to
        ignore maximum.
        default: NaN
     
    -maximum-included <boolean> (property: maximumIncluded)
        If enabled, then the maximum value gets included (testing '>=' rather than
        '>').
        default: false
     
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Minimum

        protected double m_Minimum
        the minimum value.
      • m_MinimumIncluded

        protected boolean m_MinimumIncluded
        whether the minimum value is included.
      • m_Maximum

        protected double m_Maximum
        the maximum value.
      • m_MaximumIncluded

        protected boolean m_MaximumIncluded
        whether the maximum value is included.
    • Constructor Detail

      • SimpleSubRange

        public SimpleSubRange()
    • 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
      • setMinimum

        public void setMinimum​(double value)
        Sets the minimum.
        Parameters:
        value - the minimum
      • getMinimum

        public double getMinimum()
        Returns the minimum.
        Returns:
        the minimum
      • minimumTipText

        public String minimumTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui
      • setMinimumIncluded

        public void setMinimumIncluded​(boolean value)
        Sets whether to exclude the minimum.
        Parameters:
        value - true to exclude minimum
      • getMinimumIncluded

        public boolean getMinimumIncluded()
        Returns whether the minimum is included.
        Returns:
        true if minimum included
      • minimumIncludedTipText

        public String minimumIncludedTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui
      • setMaximum

        public void setMaximum​(double value)
        Sets the maximum.
        Parameters:
        value - the maximum
      • getMaximum

        public double getMaximum()
        Returns the maximum.
        Returns:
        the maximum
      • maximumTipText

        public String maximumTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui
      • setMaximumIncluded

        public void setMaximumIncluded​(boolean value)
        Sets whether to exclude the maximum.
        Parameters:
        value - true to exclude maximum
      • getMaximumIncluded

        public boolean getMaximumIncluded()
        Returns whether the maximum is included.
        Returns:
        true if maximum included
      • maximumIncludedTipText

        public String maximumIncludedTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui
      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractWekaEvaluationPostProcessor
        Returns:
        null if no info available, otherwise short string
      • doPostProcess

        protected List<weka.classifiers.Evaluation> doPostProcess​(weka.classifiers.Evaluation eval)
        Post-processes the evaluation.
        Specified by:
        doPostProcess in class AbstractWekaEvaluationPostProcessor
        Parameters:
        eval - the Evaluation to post-process
        Returns:
        the generated evaluations