Package adams.data.multispectrumoperation.outlierremoval

Class AbstractOutlierRemoval

  • 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
    Direct Known Subclasses:
    CorrelationBasedThreshold, CosineSimilarityBasedThreshold, MeanSpectrumCosineSimilarityBasedThreshold, PassThrough
    public abstract class AbstractOutlierRemoval
extends adams.core.option.AbstractOptionHandler
implements adams.core.QuickInfoSupporter
    Ancestor for outlier removal schemes that work on multiple spectra.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected String check​(MultiSpectrum multi)
      Hook method for checking the data before performing outlier removal.
      protected abstract MultiSpectrum doRemoveOutliers​(MultiSpectrum multi, adams.core.MessageCollection errors)
      Performs the actual outlier removal.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      MultiSpectrum removeOutliers​(MultiSpectrum multi, adams.core.MessageCollection errors)
      Performs the outlier removal.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, 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

    • Constructor Detail

      • AbstractOutlierRemoval

        public AbstractOutlierRemoval()

    • Method Detail

      • getQuickInfo

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

      • check

        protected String check​(MultiSpectrum multi)
        Hook method for checking the data before performing outlier removal.
        Parameters:
        multi - the data to check
        Returns:
        null if checks passed, otherwise error message

      • doRemoveOutliers

        protected abstract MultiSpectrum doRemoveOutliers​(MultiSpectrum multi,
                                                  adams.core.MessageCollection errors)
        Performs the actual outlier removal.
        Parameters:
        multi - the data to process
        errors - for collecting errors
        Returns:
        the clean data, null if failed to process

      • removeOutliers

        public MultiSpectrum removeOutliers​(MultiSpectrum multi,
                                    adams.core.MessageCollection errors)
        Performs the outlier removal.
        Parameters:
        multi - the data to process
        errors - for collecting errors
        Returns:
        the clean data, null if failed to process