Package adams.data.spectrumoutlier

Class MinWaves

  • 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<Spectrum>, Serializable, Comparable
    public class MinWaves
extends adams.data.outlier.AbstractOutlierDetector<Spectrum>
    Detects spectra that have too few wave numbers.

    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-waves <int> (property: minWaves)
    The minimum number of wave numbers that a spectrum must have.
    default: 800
    Author:
    FracPete (fracpete at 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 int m_MinWaves
      minimum number of wave numbers that the spectrum must contain.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      int getMinWaves()
      Returns the currently set minimum number of wave numbers.
      String globalInfo()
      Returns a string describing the object.
      String minWavesTipText()
      Returns the tip text for this property.
      protected List<String> processData​(Spectrum data)
      Performs the actual detection.
      void setMinWaves​(int value)
      Sets the minimum number of wave numbers.

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

        protected int m_MinWaves
        minimum number of wave numbers that the spectrum must contain.

    • Constructor Detail

      • MinWaves

        public MinWaves()

    • 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

      • setMinWaves

        public void setMinWaves​(int value)
        Sets the minimum number of wave numbers.
        Parameters:
        value - the number of waves

      • getMinWaves

        public int getMinWaves()
        Returns the currently set minimum number of wave numbers.
        Returns:
        the minimum number of waves

      • minWavesTipText

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