Package adams.data.spectrumoutlier

Class Swapped

  • 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 Swapped
extends adams.data.outlier.AbstractOutlierDetector<Spectrum>
    Smooths spectrum (using SavitzkyGolay) and then splits it into two halves. Compares the amplitudes in the two halves, expecting the ones in the left half to be larger. If this is not the case, the spectrum gets flagged as outlier.
    It is possible to flip left and right half.

    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
 
    -flip (property: flip)
    If enabled, the left and right half get swapped for the comparison.
    Version:
    $Revision: 2242 $
    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 boolean m_Flip
      whether to flip the halves.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      String flipTipText()
      Returns the tip text for this property.
      boolean getFlip()
      Returns whether to swap left and right half for the comparison.
      String globalInfo()
      Returns a string describing the object.
      protected List<String> processData​(Spectrum data)
      Performs the actual detection.
      void setFlip​(boolean value)
      Sets whether to swap left and right half for the comparison.

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

        protected boolean m_Flip
        whether to flip the halves.

    • Constructor Detail

      • Swapped

        public Swapped()

    • 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

      • setFlip

        public void setFlip​(boolean value)
        Sets whether to swap left and right half for the comparison.
        Parameters:
        value - if true the halves get swapped

      • getFlip

        public boolean getFlip()
        Returns whether to swap left and right half for the comparison.
        Returns:
        true if the halves get swapped

      • flipTipText

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