Package adams.data.spectrumfilter

Class SAX

  • All Implemented Interfaces:
    adams.core.ClassCrossReference, adams.core.CleanUpHandler, adams.core.CrossReference, 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 SAX
extends adams.data.filter.AbstractSAX<Spectrum>
implements adams.core.ClassCrossReference
    Performs Symbolic Aggregate approXimation (SAX).
    The data must be normalized using knir.data.filter.RowNorm beforehand.
    For more information see:

    Chiu, B., Keogh, E., Lonardi, S. (2003). Probabilistic Discovery of Time Series Motifs.

    See also:
    knir.data.filter.RowNorm 

     @proceedings{Chiu2003,
    author = {Chiu, B. and Keogh, E. and Lonardi, S.},
    booktitle = {9th ACM SIGKDD International Conference on Knowledge Discovery and Data Mining},
    pages = {493-498},
    title = {Probabilistic Discovery of Time Series Motifs},
    year = {2003},
    location = {Washington, DC, USA},
    PDF = {http://www.cs.ucr.edu/\~eamonn/SIGKDD_Motif.pdf}
 }
 


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 
    -num-windows <int> (property: numWindows)
    The number of windows to use for Piecewise Aggregate Approximation (PAA).
    default: 10
    minimum: 1
 
    -num-bins <int> (property: numBins)
    The number of bins to use for the Gaussian.
    default: 10
    minimum: 1
 
    -output-labels <boolean> (property: outputLabels)
    If enabled, labels are output instead of distances.
    default: true
    Version:
    $Revision: 1286 $
    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.AbstractFilter

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

    • Field Summary

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

        m_BreakPoints, m_DistMatrix, m_NumBins, m_NumWindows, m_OutputLabels

      • 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
      SAX()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] getClassCrossReferences()
      Returns the cross-referenced classes.
      protected double getMeanDeltaX​(Spectrum data)
      Computes the mean difference between data points on the X axis.
      protected double getX​(adams.data.container.DataPoint point)
      Obtains the X value from the given data point.
      protected double getY​(adams.data.container.DataPoint point)
      Obtains the Y value from the given data point.
      String globalInfo()
      Returns a string describing the object.
      protected adams.data.container.DataPoint newDataPoint​(double x, double y)
      Creates a new data point from the X and Y values.

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

        defineOptions, getNumBins, getNumWindows, getOutputLabels, getTechnicalInformation, numBinsTipText, numWindowsTipText, outputLabelsTipText, processData, reset, setNumBins, setNumWindows, setOutputLabels

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

        checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, 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

      • SAX

        public SAX()

    • 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

      • getClassCrossReferences

        public Class[] getClassCrossReferences()
        Returns the cross-referenced classes.
        Specified by:
        getClassCrossReferences in interface adams.core.ClassCrossReference
        Returns:
        the classes

      • getMeanDeltaX

        protected double getMeanDeltaX​(Spectrum data)
        Computes the mean difference between data points on the X axis.
        Specified by:
        getMeanDeltaX in class adams.data.filter.AbstractSAX<Spectrum>
        Parameters:
        data - the data to use for the calculation
        Returns:
        the mean

      • getX

        protected double getX​(adams.data.container.DataPoint point)
        Obtains the X value from the given data point.
        Specified by:
        getX in class adams.data.filter.AbstractSAX<Spectrum>
        Parameters:
        point - the data point to extract the X value from
        Returns:
        the X value

      • getY

        protected double getY​(adams.data.container.DataPoint point)
        Obtains the Y value from the given data point.
        Specified by:
        getY in class adams.data.filter.AbstractSAX<Spectrum>
        Parameters:
        point - the data point to extract the Y value from
        Returns:
        the Y value

      • newDataPoint

        protected adams.data.container.DataPoint newDataPoint​(double x,
                                                      double y)
        Creates a new data point from the X and Y values.
        Specified by:
        newDataPoint in class adams.data.filter.AbstractSAX<Spectrum>
        Parameters:
        x - the raw X value
        y - the raw Y value
        Returns:
        the data point