PAATransformer

java.lang.Object
- weka.filters.Filter
- - weka.filters.SimpleFilter
  - - weka.filters.SimpleStreamFilter
    - - weka.filters.unsupervised.timeseries.PAATransformer

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

Direct Known Subclasses:

SAXTransformer
```
public class PAATransformer
extends weka.filters.SimpleStreamFilter
implements weka.filters.UnsupervisedFilter, weka.core.TechnicalInformationHandler
```
A filter to perform the Piecewise Aggregate Approximation transformation to time series.

It uses the "N/n not equal an integer" generalization. Furthermore, it is extended to handle weights for data points in time series.

Warning: The lower bounding property may not hold for the distance measure when weights are used or N/n is not equal to an integer!

For more information see:
Byoung-Kee Yi, Christos Faloutsos: Fast Time Sequence Indexing for Arbitrary L_p Norms. In: Proceedings of the 26th VLDB Conference, 385-394, 2000.

Eamonn Keogh, Kaushik Chakrabarti, Michael Pazzani, Sharad Mehrotra (2001). Dimensionality Reduction for Fast Similarity Search in Large Time Series Databases. Knowledge and information Systems. 3(3):263-286.

Li Wei. Code for "N/n not equal an integer'. URL http://www.cs.ucr.edu/~eamonn/SAX_2006_ver.zip.
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).
```
Version:

$Revision: 1000 $

Author:

Benjamin Weber ( benweber at student dot ethz dot ch )

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PAATransformer()

Constructors
Constructor and Description
`PAATransformer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`weka.core.Capabilities`	`getCapabilities()` Returns the Capabilities of this filter.
`boolean`	`getInvertRange()` Returns whether the attribute ranges should be inverted
`weka.core.Capabilities`	`getMultiInstanceCapabilities()` Returns the capabilities of this multi-instance filter for the relational data (i.e., the bags).
`java.lang.String[]`	`getOptions()` Gets the current settings of the filter.
`java.lang.String`	`getRange()` Gets the attribute ranges to which the filter should be applied
`java.lang.String`	`getRevision()` Returns the revision string.
`weka.core.TechnicalInformation`	`getTechnicalInformation()`
`int`	`getW()` Gets the `W` factor for the PAA transformation
`java.lang.String`	`globalInfo()` Returns a string describing this filter.
`java.lang.String`	`invertRangeTipText()` Returns the tip text for the invert range option
`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.
`java.lang.String`	`rangeTipText()` Returns the tip text for the `ranges` option
`boolean`	`setInputFormat(weka.core.Instances instanceInfo)` This method needs to be called before the filter is used to transform instances.
`void`	`setInvertRange(boolean inversion)` Sets whether the attribute ranges should be inverted
`void`	`setOptions(java.lang.String[] options)` Parses a given list of options
`void`	`setRange(java.lang.String range)` Sets the attribute ranges to which the filter should be applied
`void`	`setW(int W)` Sets the `W` factor for the PAA transformation
`java.lang.String`	`wTipText()` Returns the tip text for the `W` parameter

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
  - PAATransformer
```
public PAATransformer()
```
- Method Detail
  - getCapabilities
```
public weka.core.Capabilities getCapabilities()
```
    Returns the Capabilities of this filter.
    
    Specified by:
    
    getCapabilities in interface weka.core.CapabilitiesHandler
    
    Overrides:
    
    getCapabilities in class weka.filters.Filter
  - getMultiInstanceCapabilities
```
public weka.core.Capabilities getMultiInstanceCapabilities()
```
    Returns the capabilities of this multi-instance filter for the relational data (i.e., the bags).
    
    Returns:
    
    the capabilities of this object
    
    See Also:
    
    Capabilities
  - 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 weka.filters.Filter
  - 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 weka.filters.Filter
  - 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).
```
    Specified by:
    
    setOptions in interface weka.core.OptionHandler
    
    Overrides:
    
    setOptions in class weka.filters.Filter
    
    Parameters:
    
    options - the list of options as an array of strings
    
    Throws:
    
    java.lang.Exception - if an option is not supported
  - getW
```
public int getW()
```
    Gets the W factor for the PAA transformation
    
    Returns:
    
    the W factor
  - setW
```
public void setW(int W)
```
    Sets the W factor for the PAA transformation
    
    Parameters:
    
    W - the W factor
  - wTipText
```
public java.lang.String wTipText()
```
    Returns the tip text for the W parameter
    
    Returns:
    
    the tip text
  - getRange
```
public java.lang.String getRange()
```
    Gets the attribute ranges to which the filter should be applied
    
    Returns:
    
    the attribute ranges
  - setRange
```
public void setRange(java.lang.String range)
```
    Sets the attribute ranges to which the filter should be applied
    
    Parameters:
    
    range - the attribute ranges
  - rangeTipText
```
public java.lang.String rangeTipText()
```
    Returns the tip text for the ranges option
    
    Returns:
    
    the tip text
  - getInvertRange
```
public boolean getInvertRange()
```
    Returns whether the attribute ranges should be inverted
    
    Returns:
    
    ranges inversion
  - setInvertRange
```
public void setInvertRange(boolean inversion)
```
    Sets whether the attribute ranges should be inverted
    
    Parameters:
    
    inversion - inversion
  - invertRangeTipText
```
public java.lang.String invertRangeTipText()
```
    Returns the tip text for the invert range option
    
    Returns:
    
    the tip text
  - globalInfo
```
public java.lang.String globalInfo()
```
    Returns a string describing this filter.
    
    Specified by:
    
    globalInfo in class weka.filters.SimpleFilter
  - getRevision
```
public java.lang.String getRevision()
```
    Returns the revision string.
    
    Specified by:
    
    getRevision in interface weka.core.RevisionHandler
    
    Overrides:
    
    getRevision in class weka.filters.Filter
  - getTechnicalInformation
```
public weka.core.TechnicalInformation getTechnicalInformation()
```
    Specified by:
    
    getTechnicalInformation in interface weka.core.TechnicalInformationHandler
  - setInputFormat
```
public boolean setInputFormat(weka.core.Instances instanceInfo)
                       throws java.lang.Exception
```
    This method needs to be called before the filter is used to transform instances. Will return true for this filter because the output format can be collected immediately. This specialised version of setInputFormat() calls the setInputFormat() method in SimpleFilter and then sets the output locators for relational and string attributes correctly. We also set the input locators correctly here.
    
    Overrides:
    
    setInputFormat in class weka.filters.SimpleFilter
    
    Throws:
    
    java.lang.Exception
  - 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

Class PAATransformer

Constructor Summary

Method Summary

Methods inherited from class weka.filters.SimpleStreamFilter

Methods inherited from class weka.filters.Filter

Methods inherited from class java.lang.Object

Methods inherited from interface weka.core.OptionHandler

Constructor Detail

PAATransformer

Method Detail

getCapabilities

getMultiInstanceCapabilities

listOptions

getOptions

setOptions

getW

setW

wTipText

getRange

setRange

rangeTipText

getInvertRange

setInvertRange

invertRangeTipText

globalInfo

getRevision

getTechnicalInformation

setInputFormat

main