Package adams.data.threewayoutlier

Class ValueRange

  • 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.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.data.outlier.OutlierDetector>, adams.core.SizeOfHandler, adams.data.outlier.OutlierDetector<ThreeWayData>, Serializable, Comparable
    public class ValueRange
extends adams.data.outlier.AbstractOutlierDetector<ThreeWayData>
    Detects data containers where a least one value is too low or too high. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -min <double> (property: min)
    Minimum accepted value; use -Infinity to ignore bound.
    default: -Infinity
 
    -max <double> (property: max)
    Maximum accepted value; use +Infinity to ignore bound.
    default: Infinity
    Author:
    Dale (dale at cs dot waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class adams.data.outlier.AbstractOutlierDetector

        adams.data.outlier.AbstractOutlierDetector.DetectorJob<T extends adams.data.container.DataContainer>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected double m_Max
      max.
      protected double m_Min
      min.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      double getMax()
      Returns the currently set max.
      double getMin()
      Returns the currently set minimum.
      String globalInfo()
      Returns a string describing the object.
      String maxTipText()
      Returns the tip text for this property.
      String minTipText()
      Returns the tip text for this property.
      protected List<String> processData​(ThreeWayData data)
      Performs the actual detection.
      void setMax​(double value)
      Sets the max.
      void setMin​(double value)
      Sets the minimum.

      • Methods inherited from class adams.data.outlier.AbstractOutlierDetector

        checkData, cleanUp, compareTo, destroy, detect, equals, forCommandLine, forName, getOutlierDetectors, getQuickInfo, reset, 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

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Min

        protected double m_Min
        min.

      • m_Max

        protected double m_Max
        max.

    • Constructor Detail

      • ValueRange

        public ValueRange()

    • 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

      • setMin

        public void setMin​(double value)
        Sets the minimum.
        Parameters:
        value - the minimum, Double.NEGATIVE_INFINITY for no bound

      • getMin

        public double getMin()
        Returns the currently set minimum.
        Returns:
        the minimum, Double.NEGATIVE_INFINITY for no bound

      • minTipText

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

      • setMax

        public void setMax​(double value)
        Sets the max.
        Parameters:
        value - the maximum, {@link Double#POSITIVE_INFINITY\} for no bound

      • getMax

        public double getMax()
        Returns the currently set max.
        Returns:
        the maximum, {@link Double#POSITIVE_INFINITY\} for no bound

      • maxTipText

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

      • processData

        protected List<String> processData​(ThreeWayData data)
        Performs the actual detection.
        Specified by:
        processData in class adams.data.outlier.AbstractOutlierDetector<ThreeWayData>
        Parameters:
        data - the data to process
        Returns:
        the detections