Class SavitzkyGolayRange

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

    public class SavitzkyGolayRange
    extends adams.core.option.AbstractOptionHandler
    Range definition for a SavitzkyGolay filter setup.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_DerivativeOrder
      the order of the derivative.
      protected int m_End
      the end of the range.
      protected int m_NumPoints
      the number of points (window size = numpoints*2 + 1).
      protected int m_PolynomialOrder
      the polynomial order.
      protected int m_Start
      the start of the range.
      • 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
      void defineOptions()
      Adds options to the internal list of options.
      String derivativeOrderTipText()
      Returns the tip text for this property.
      String endTipText()
      Returns the tip text for this property.
      int getDerivativeOrder()
      Returns the order of the derivative.
      int getEnd()
      Returns the last amplitude
      int getNumPoints()
      Returns the number of points for the window (window = numPoints*2 + 1).
      int getPolynomialOrder()
      Returns the polynominal order.
      int getStart()
      Returns the first amplitude
      String globalInfo()
      Returns a string describing the object.
      String numPointsTipText()
      Returns the tip text for this property.
      String polynomialOrderTipText()
      Returns the tip text for this property.
      void setDerivativeOrder​(int value)
      Sets the order of the derivative.
      void setEnd​(int value)
      Sets the last amplitude.
      void setNumPoints​(int value)
      Sets the number of points for the window (window = numPoints*2 + 1).
      void setPolynomialOrder​(int value)
      Sets the polynomial order.
      void setStart​(int value)
      Sets the first amplitude.
      String startTipText()
      Returns the tip text for this property.
      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString
      • Methods inherited from class adams.core.logging.CustomLoggingLevelObject

        setLoggingLevel
      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel
    • Field Detail

      • m_Start

        protected int m_Start
        the start of the range.
      • m_End

        protected int m_End
        the end of the range.
      • m_PolynomialOrder

        protected int m_PolynomialOrder
        the polynomial order.
      • m_DerivativeOrder

        protected int m_DerivativeOrder
        the order of the derivative.
      • m_NumPoints

        protected int m_NumPoints
        the number of points (window size = numpoints*2 + 1).
    • Constructor Detail

      • SavitzkyGolayRange

        public SavitzkyGolayRange()
    • 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
      • setStart

        public void setStart​(int value)
        Sets the first amplitude.
        Parameters:
        value - the first amplitude
      • getStart

        public int getStart()
        Returns the first amplitude
        Returns:
        the first amplitude
      • startTipText

        public String startTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setEnd

        public void setEnd​(int value)
        Sets the last amplitude.
        Parameters:
        value - the last amplitude
      • getEnd

        public int getEnd()
        Returns the last amplitude
        Returns:
        the last amplitude
      • endTipText

        public String endTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setPolynomialOrder

        public void setPolynomialOrder​(int value)
        Sets the polynomial order.
        Parameters:
        value - the order
      • getPolynomialOrder

        public int getPolynomialOrder()
        Returns the polynominal order.
        Returns:
        the order
      • polynomialOrderTipText

        public String polynomialOrderTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setDerivativeOrder

        public void setDerivativeOrder​(int value)
        Sets the order of the derivative.
        Parameters:
        value - the order
      • getDerivativeOrder

        public int getDerivativeOrder()
        Returns the order of the derivative.
        Returns:
        the order
      • derivativeOrderTipText

        public String derivativeOrderTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setNumPoints

        public void setNumPoints​(int value)
        Sets the number of points for the window (window = numPoints*2 + 1).
        Parameters:
        value - the number of points
      • getNumPoints

        public int getNumPoints()
        Returns the number of points for the window (window = numPoints*2 + 1).
        Returns:
        the number of points
      • numPointsTipText

        public String numPointsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.