Package adams.data.spectrumoutlier

Class MinMax

  • 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<adams.data.container.DataContainer>, Serializable, Comparable
    public class MinMax
extends adams.data.outlier.AbstractOutlierDetector<adams.data.container.DataContainer>
    Detects data containers where a report value is too high/low.

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -min <double> (property: min)
    Min value of field in report.
    default: 25.0
 
    -max <double> (property: max)
    Max value of field in report.
    default: 40.0
 
    -field <adams.data.report.Field> (property: field)
    Field in report.
    default: Toluene-d8\\tConc
    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 boolean m_CheckMax
      whether to check the upper bound.
      protected boolean m_CheckMin
      whether to check the lower bound.
      protected adams.data.report.Field m_Field
      the report field.
      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
      MinMax()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String checkMaxTipText()
      Returns the tip text for this property.
      String checkMinTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      String fieldTipText()
      Returns the tip text for this property.
      boolean getCheckMax()
      Returns whether to check the upper bound.
      boolean getCheckMin()
      Returns whether to check the lower bound.
      adams.data.report.Field getField()
      Returns the field.
      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​(adams.data.container.DataContainer data)
      Performs the actual detection.
      void setCheckMax​(boolean value)
      Sets whether to check the upper bound.
      void setCheckMin​(boolean value)
      Sets whether to check the lower bound.
      void setField​(adams.data.report.Field value)
      Sets the field.
      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, toCommandLine, toString

      • Methods inherited from class adams.core.logging.CustomLoggingLevelObject

        setLoggingLevel

      • 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_Field

        protected adams.data.report.Field m_Field
        the report field.

      • m_Min

        protected double m_Min
        min.

      • m_CheckMin

        protected boolean m_CheckMin
        whether to check the lower bound.

      • m_Max

        protected double m_Max
        max.

      • m_CheckMax

        protected boolean m_CheckMax
        whether to check the upper bound.

    • Constructor Detail

      • MinMax

        public MinMax()

    • 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

      • setField

        public void setField​(adams.data.report.Field value)
        Sets the field.
        Parameters:
        value - the field

      • getField

        public adams.data.report.Field getField()
        Returns the field.
        Returns:
        the field

      • fieldTipText

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

      • setMin

        public void setMin​(double value)
        Sets the minimum.
        Parameters:
        value - min

      • getMin

        public double getMin()
        Returns the currently set minimum.
        Returns:
        the minimum

      • 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.

      • setCheckMin

        public void setCheckMin​(boolean value)
        Sets whether to check the lower bound.
        Parameters:
        value - true if to check

      • getCheckMin

        public boolean getCheckMin()
        Returns whether to check the lower bound.
        Returns:
        true if to check

      • checkMinTipText

        public String checkMinTipText()
        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 - min

      • getMax

        public double getMax()
        Returns the currently set max.
        Returns:
        the max

      • 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.

      • setCheckMax

        public void setCheckMax​(boolean value)
        Sets whether to check the upper bound.
        Parameters:
        value - true if to check

      • getCheckMax

        public boolean getCheckMax()
        Returns whether to check the upper bound.
        Returns:
        true if to check

      • checkMaxTipText

        public String checkMaxTipText()
        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​(adams.data.container.DataContainer data)
        Performs the actual detection.
        Specified by:
        processData in class adams.data.outlier.AbstractOutlierDetector<adams.data.container.DataContainer>
        Parameters:
        data - the data to process
        Returns:
        the detections