TimeSeriesDelta

Overview | Package | Class | Tree | Deprecated | Index | Help | Weka's home

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## weka.filters.unsupervised.attribute
Class TimeSeriesDelta

    java.lang.Object
      weka.filters.Filter
          weka.filters.unsupervised.attribute.AbstractTimeSeries
              weka.filters.unsupervised.attribute.TimeSeriesTranslate
                  weka.filters.unsupervised.attribute.TimeSeriesDelta

All Implemented Interfaces:
  java.io.Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler, UnsupervisedFilter

    public class TimeSeriesDelta

extends TimeSeriesTranslate

An instance filter that assumes instances form time-series data and replaces attribute values in the current instance with the difference between the current value and the equivalent attribute attribute value of some previous (or future) instance. For instances where the time-shifted value is unknown either the instance may be dropped, or missing values used. Skips the class attribute if it is set.

Valid options are:

     -R <index1,index2-index4,...>
      Specify list of columns to translate in time. First and
      last are valid indexes. (default none)

     -V
      Invert matching sense (i.e. calculate for all non-specified columns)

     -I <num>
      The number of instances forward to translate values
      between. A negative number indicates taking values from
      a past instance. (default -1)

     -M
      For instances at the beginning or end of the dataset where
      the translated values are not known, remove those instances
      (default is to use missing values).

Version:
  $Revision: 1.7 $
Author:
  Len Trigg (trigg@cs.waikato.ac.nz)
See Also:
  Serialized Form

Constructor Summary
`TimeSeriesDelta()`

Method Summary
`Capabilities` | `getCapabilities()` Returns the Capabilities of this filter.
`java.lang.String` | `getRevision()` Returns the revision string.
`java.lang.String` | `globalInfo()` Returns a string describing this classifier
`static void` | `main(java.lang.String[] argv)` Main method for testing this class.
`boolean` | `setInputFormat(Instances instanceInfo)` Sets the format of the input instances.

Methods inherited from class weka.filters.unsupervised.attribute.AbstractTimeSeries
`attributeIndicesTipText, batchFinished, fillWithMissingTipText, getAttributeIndices, getFillWithMissing, getInstanceRange, getInvertSelection, getOptions, input, instanceRangeTipText, invertSelectionTipText, listOptions, setAttributeIndices, setAttributeIndicesArray, setFillWithMissing, setInstanceRange, setInvertSelection, setOptions`

Methods inherited from class weka.filters.Filter
`batchFilterFile, filterFile, getCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### TimeSeriesDelta

    public TimeSeriesDelta()

Method Detail

### globalInfo

    public java.lang.String globalInfo()

  Returns a string describing this classifier

  Overrides:
    `globalInfo` in class `TimeSeriesTranslate`
  Returns:
    a description of the classifier suitable for displaying in the explorer/experimenter gui

### getCapabilities

    public Capabilities getCapabilities()

  Returns the Capabilities of this filter.

  Specified by:
    `getCapabilities` in interface `CapabilitiesHandler`
  Overrides:
    `getCapabilities` in class `TimeSeriesTranslate`
  Returns:
    the capabilities of this object
  See Also:
    `Capabilities`

### setInputFormat

    public boolean setInputFormat(Instances instanceInfo)
                           throws java.lang.Exception

  Sets the format of the input instances.

  Overrides:
    `setInputFormat` in class `TimeSeriesTranslate`
  Parameters:
    `instanceInfo` - an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).
  Returns:
    true if the outputFormat may be collected immediately
  Throws:
    `UnsupportedAttributeTypeException` - if selected attributes are not numeric.
    `java.lang.Exception` - if the format couldn't be set successfully

### getRevision

    public java.lang.String getRevision()

  Returns the revision string.

  Specified by:
    `getRevision` in interface `RevisionHandler`
  Overrides:
    `getRevision` in class `TimeSeriesTranslate`
  Returns:
    the revision

### main

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

  Main method for testing this class.

  Parameters:
    `argv` - should contain arguments to the filter: use -h for help

Overview | Package | Class | Tree | Deprecated | Index | Help | Weka's home

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD