Package adams.data.spectrumsmoothing

Class SavitzkyGolayBased

  • 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.ShallowCopySupporter<adams.data.smoothing.AbstractSmoother>, adams.core.SizeOfHandler, adams.core.TechnicalInformationHandler, Serializable, Comparable
    public class SavitzkyGolayBased
extends adams.data.smoothing.AbstractSavitzkyGolayBased<Spectrum>
    A Savitzky-Golay based smoothing algorithm.
    It uses a Savitzky-Golay filter with derivative order 0 and adding of mass-spec data turned on.

    For more information on Savitzky-Golay see:

    A. Savitzky, Marcel J.E. Golay (1964). Smoothing and Differentiation of Data by Simplified Least Squares Procedures. Analytical Chemistry. 36:1627-1639.

    William H. Press, Saul A. Teukolsky, William T. Vetterling, Brian P. Flannery (1992). Savitzky-Golay Smoothing Filters.

    Valid options are: 

    -D (property: debug)
         If set to true, scheme may output additional info to the console.
 
    -polynomial <int> (property: polynomialOrder)
         The polynomial order to use, must be at least 2.
         default: 2
 
    -left <int> (property: numPointsLeft)
         The number of points left of a data point, >= 0.
         default: 3
 
    -right <int> (property: numPointsRight)
         The number of points right of a data point, >= 0.
         default: 3
    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.smoothing.AbstractSmoother

        adams.data.smoothing.AbstractSmoother.SmootherJob<T extends adams.data.container.DataContainer>

    • Field Summary

      • Fields inherited from class adams.data.smoothing.AbstractSavitzkyGolayBased

        m_SavitzkyGolay

      • 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 Concrete Methods 
      Modifier and Type Method Description
      protected adams.data.filter.AbstractSavitzkyGolay getDefault()
      Returns the default Savitzky-Golay filter.

      • Methods inherited from class adams.data.smoothing.AbstractSavitzkyGolayBased

        defineOptions, getNumPointsLeft, getNumPointsRight, getPolynomialOrder, getTechnicalInformation, globalInfo, initialize, numPointsLeftTipText, numPointsRightTipText, polynomialOrderTipText, processData, setNumPointsLeft, setNumPointsRight, setPolynomialOrder

      • Methods inherited from class adams.data.smoothing.AbstractSmoother

        checkData, cleanUp, compareTo, destroy, equals, forCommandLine, forName, getSmoothers, reset, shallowCopy, shallowCopy, smooth

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, 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

    • Constructor Detail

      • SavitzkyGolayBased

        public SavitzkyGolayBased()

    • Method Detail

      • getDefault

        protected adams.data.filter.AbstractSavitzkyGolay getDefault()
        Returns the default Savitzky-Golay filter.
        Specified by:
        getDefault in class adams.data.smoothing.AbstractSavitzkyGolayBased<Spectrum>
        Returns:
        the default filter