Package adams.data.spectrumfilter

Class Derivative

  • 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.data.filter.Filter<Spectrum>, Serializable, Comparable
    public class Derivative
extends adams.data.filter.AbstractDerivative<Spectrum>
    A filter for generating derivatives of spectra.

    Valid options are: 

    -D (property: debug)
         If set to true, scheme may output additional info to the console.
 
    -order <int> (property: order)
         The order of the derivative to calculate.
         default: 1
 
    -scaling <float> (property: scalingRange)
         The range to scale the abundances to after each derivation step; use 0 to
          turn off and -1 to set it to the input range.
         default: 0.0
    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.filter.AbstractDerivative

        adams.data.filter.AbstractDerivative.Point

      • 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.AbstractDerivative

        m_Order, m_ScalingRange

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Derivative()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String globalInfo()
      Returns a string describing the object.
      protected adams.data.container.DataPoint toDataPoint​(adams.data.filter.AbstractDerivative.Point point)
      Turns the intermediate format point back into a DataPoint.
      protected adams.data.filter.AbstractDerivative.Point toPoint​(adams.data.container.DataPoint point)
      Turns the DataPoint into the intermediate format.

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

        defineOptions, derive, getOrder, getScalingRange, orderTipText, processData, scalingRangeTipText, setOrder, setScalingRange

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

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

        getLogger, isLoggingEnabled

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

        cleanUpOptions, getOptionManager, toCommandLine

    • Constructor Detail

      • Derivative

        public Derivative()

    • 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

      • toPoint

        protected adams.data.filter.AbstractDerivative.Point toPoint​(adams.data.container.DataPoint point)
        Turns the DataPoint into the intermediate format.
        Specified by:
        toPoint in class adams.data.filter.AbstractDerivative<Spectrum>
        Parameters:
        point - the DataPoint to convert
        Returns:
        the generated intermediate format point

      • toDataPoint

        protected adams.data.container.DataPoint toDataPoint​(adams.data.filter.AbstractDerivative.Point point)
        Turns the intermediate format point back into a DataPoint.
        Specified by:
        toDataPoint in class adams.data.filter.AbstractDerivative<Spectrum>
        Parameters:
        point - the intermediate format point to convert
        Returns:
        the generated DataPoint