Package adams.data.spectrumfilter

Class SimpleSavitzkyGolay

  • 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.filter.Filter>, adams.core.SizeOfHandler, adams.core.TechnicalInformationHandler, adams.data.filter.Filter<Spectrum>, Serializable, Comparable
    public class SimpleSavitzkyGolay
extends adams.data.filter.AbstractSimpleSavitzkyGolay<Spectrum>
    A filter that applies a simplified Savitzky-Golay smoothing.

    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.

    BibTeX: 
     @article{Savitzky1964,
    author = {A. Savitzky and Marcel J.E. Golay},
    journal = {Analytical Chemistry},
    pages = {1627-1639},
    title = {Smoothing and Differentiation of Data by Simplified Least Squares Procedures},
    volume = {36},
    year = {1964},
    HTTP = {http://dx.doi.org/10.1021/ac60214a047}
 }


    Valid options are: 

    -D (property: debug)
         If set to true, scheme may output additional info to the console.
 
    -windowSize <int> (property: windowSize)
         The window size to use for smoothing.
         default: 7
    Version:
    $Revision: 2242 $
    Author:
    dale (dale at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

        adams.data.filter.AbstractFilter.FilterJob<T extends adams.data.container.DataContainer>

    • Field Summary

      • Fields inherited from class adams.data.filter.AbstractSimpleSavitzkyGolay

        m_WindowSize

      • Fields inherited from class adams.data.filter.AbstractFilter

        m_DontUpdateID

      • 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 double getValue​(adams.data.container.DataPoint point)
      Returns the Y-value of the point.
      protected adams.data.container.DataPoint newDataPoint​(adams.data.container.DataPoint old, double y)
      Creates a new DataPoint based on the old one and the new Y-value.

      • Methods inherited from class adams.data.filter.AbstractSimpleSavitzkyGolay

        defineOptions, getTechnicalInformation, getWindowSize, globalInfo, initialize, processData, setWindowSize, windowSizeTipText

      • Methods inherited from class adams.data.filter.AbstractFilter

        checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy

      • 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, setLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Constructor Detail

      • SimpleSavitzkyGolay

        public SimpleSavitzkyGolay()

    • Method Detail

      • getValue

        protected double getValue​(adams.data.container.DataPoint point)
        Returns the Y-value of the point.
        Specified by:
        getValue in class adams.data.filter.AbstractSimpleSavitzkyGolay<Spectrum>
        Parameters:
        point - the DataPoint to get the Y-value from
        Returns:
        the Y-value

      • newDataPoint

        protected adams.data.container.DataPoint newDataPoint​(adams.data.container.DataPoint old,
                                                      double y)
        Creates a new DataPoint based on the old one and the new Y-value.
        Specified by:
        newDataPoint in class adams.data.filter.AbstractSimpleSavitzkyGolay<Spectrum>
        Parameters:
        old - the old DataPoint
        y - the new Y-value
        Returns:
        the new DataPoint