Class FastWavelet

  • 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 FastWavelet
    extends adams.data.filter.AbstractFastWavelet<Spectrum>
    A filter that transforms the data with a wavelet.

    For more information see:

    (2009). JSci - A science API for Java.

    BibTeX:
     @misc{missing_id,
        title = {JSci - A science API for Java},
        year = {2009},
        HTTP = {http://jsci.sourceforge.net/}
     }
     


    Valid options are:

    -D <int> (property: debugLevel)
        The greater the number the more additional info the scheme may output to
        the console (0 = off).
        default: 0
        minimum: 0
     
    -wavelet <Haar|CDF2 4|Daubechies2|Symmlet8> (property: waveletType)
        The wavelet type to use for transforming the data.
        default: HAAR
     
    -padding <Zero> (property: paddingType)
        The padding type to use.
        default: ZERO
     
    -inverse (property: inverseTransform)
        If true, then the inverse transform is performed (wavelet -> normal space
        ).
     
    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.AbstractFastWavelet

        adams.data.filter.AbstractFastWavelet.WaveletType
      • 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.AbstractFastWavelet

        m_InverseTransform, m_PaddingType, m_WaveletType
      • 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
      FastWavelet()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected double getValue​(adams.data.container.DataPoint point)
      Returns the X-value of the DataPoint.
      protected adams.data.container.DataPoint newDataPoint​(adams.data.container.DataPoint oldPoint, double x)
      Creates a new DataPoint based on the old one and the new X value.
      protected adams.data.container.DataPoint newDataPoint​(List<adams.data.container.DataPoint> points, int index, double x)
      Creates a new DataPoint based on the index and the new X value.
      • Methods inherited from class adams.data.filter.AbstractFastWavelet

        defineOptions, getInverseTransform, getPaddingType, getTechnicalInformation, getWaveletType, globalInfo, inverseTransformTipText, paddingTypeTipText, processData, setInverseTransform, setPaddingType, setWaveletType, waveletTypeTipText
      • 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

      • FastWavelet

        public FastWavelet()
    • Method Detail

      • getValue

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

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

        protected adams.data.container.DataPoint newDataPoint​(List<adams.data.container.DataPoint> points,
                                                              int index,
                                                              double x)
        Creates a new DataPoint based on the index and the new X value. Used for padded points.
        Specified by:
        newDataPoint in class adams.data.filter.AbstractFastWavelet<Spectrum>
        Parameters:
        points - the original points
        index - the index of the padded point
        x - the new X value
        Returns:
        the new DataPoint