weka.filters.unsupervised.timeseries

Class SAXTransformer

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleStreamFilter

weka.filters.unsupervised.timeseries.PAATransformer

weka.filters.unsupervised.timeseries.SAXTransformer

All Implemented Interfaces:

java.io.Serializable, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.CommandlineRunnable, weka.core.OptionHandler, weka.core.RevisionHandler, weka.core.TechnicalInformationHandler, weka.filters.StreamableFilter, weka.filters.UnsupervisedFilter

public class SAXTransformer
extends PAATransformer

A filter to perform the Symbolic Aggregate Approximation transformation to time series.

The filter can handle arbitrarily big alphabet sizes.

For more information see:
Jessica Lin, Eamonn Keogh, Stefano Lonardi, Bill Chiu: A Symbolic Representation of Time Series, with Implications for Streaming Algorithms. In: Proceedings 8th ACM SIGMOD Workshop on Research issues in Data Mining and Knowledge Discovery , 2-11, 2003.

It makes use of the PAATransformer filter

Valid options are:

 -R <index1,index2-index3,...>
  Specifies the attributes that should be transformed.
  The attributes must be relational attributes and must contain only
  numeric attributes which are each transformed separately.
  First and last are valid indices. (default Empty)

 -V
  Inverts the specified attribute range (default don't invert)

 -W <CompressionFactor>
  Specifies the compression factor w for the PAA transformation.
  A time series of length n will be compressed to one of length w.
  (default 100).

 -A <AlphabetSize>
  Specifies the alphabet size a for the SAX transformation.
  The transformed data points will have discrete values.
  (default 10)

Version:

$Revision: 1000 $

Author:

Benjamin Weber ( benweber at student dot ethz dot ch )

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SAXTransformer()

Method Summary

Modifier and Type	Method and Description
java.lang.String	alphabetSizeTipText() Returns the tip text for the alphabet size
int	getAlphabetSize() Returns the alphabet size
java.lang.String[]	getOptions() Gets the current settings of the filter.
java.lang.String	getRevision() Returns the revision string.
weka.core.TechnicalInformation	getTechnicalInformation()
java.lang.String	globalInfo() Returns a string describing this filter.
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main method for running this filter.
void	setAlphabetSize(int alphabetSize) Sets the alphabet size
void	setOptions(java.lang.String[] options) Parses a given list of options

Methods inherited from class weka.filters.unsupervised.timeseries.PAATransformer

getCapabilities, getInvertRange, getMultiInstanceCapabilities, getRange, getW, invertRangeTipText, rangeTipText, setInputFormat, setInvertRange, setRange, setW, wTipText

Methods inherited from class weka.filters.SimpleStreamFilter

batchFinished, input

Methods inherited from class weka.filters.Filter

batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

SAXTransformer

public SAXTransformer()

Method Detail

listOptions

public java.util.Enumeration<weka.core.Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class PAATransformer

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class PAATransformer

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options

Valid options are:

 -R <index1,index2-index3,...>
  Specifies the attributes that should be transformed.
  The attributes must be relational attributes and must contain only
  numeric attributes which are each transformed separately.
  First and last are valid indices. (default Empty)

 -V
  Inverts the specified attribute range (default don't invert)

 -W <CompressionFactor>
  Specifies the compression factor w for the PAA transformation.
  A time series of length n will be compressed to one of length w.
  (default 100).

 -A <AlphabetSize>
  Specifies the alphabet size a for the SAX transformation.
  The transformed data points will have discrete values.
  (default 10)

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class PAATransformer

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getAlphabetSize

public int getAlphabetSize()

Returns the alphabet size

Returns:

alphabet size

setAlphabetSize

public void setAlphabetSize(int alphabetSize)

Sets the alphabet size

Parameters:

alphabetSize - the new alphabet size

alphabetSizeTipText

public java.lang.String alphabetSizeTipText()

Returns the tip text for the alphabet size

Returns:

the tip text

globalInfo

public java.lang.String globalInfo()

Returns a string describing this filter.

Overrides:

globalInfo in class PAATransformer

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface weka.core.RevisionHandler

Overrides:

getRevision in class PAATransformer

getTechnicalInformation

public weka.core.TechnicalInformation getTechnicalInformation()

Specified by:

getTechnicalInformation in interface weka.core.TechnicalInformationHandler

Overrides:

getTechnicalInformation in class PAATransformer

main

public static void main(java.lang.String[] args)

Main method for running this filter.

Parameters:

args - arguments for the filter: use -h for help