weka.filters.unsupervised.timeseries

Class OneDimensionalTimeSeriesToString

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleStreamFilter

weka.filters.unsupervised.timeseries.OneDimensionalTimeSeriesToString

All Implemented Interfaces:

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

public class OneDimensionalTimeSeriesToString
extends weka.filters.SimpleStreamFilter

A filter to concatenate the string representations of data points of a one dimensional time series that are given as values of a relational attribute (e.g., output of the SAXTransformer). This can then be processed with tools such as the StringToWordVector 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
  one attribute.
  First and last are valid indices. (default Empty)

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

Version:

$Revision: 1000 $

Author:

Benjamin Weber ( benweber at student dot ethz dot ch )

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OneDimensionalTimeSeriesToString()

Method Summary

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
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	globalInfo()
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.
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

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, getRevision, isFirstBatchDone, isNewBatch, isOutputFormatDefined, main, 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

OneDimensionalTimeSeriesToString

public OneDimensionalTimeSeriesToString()

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

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
  one attribute.
  First and last are valid indices. (default Empty)

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

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

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

Specified by:

globalInfo in class weka.filters.SimpleFilter

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