All Packages Class Hierarchy This Package Previous Next Index WEKA's home
Class weka.filters.AbstractTimeSeriesFilter
java.lang.Object
|
+----weka.filters.Filter
|
+----weka.filters.AbstractTimeSeriesFilter
- public abstract class AbstractTimeSeriesFilter
- extends Filter
- implements OptionHandler
An abstract instance filter that assumes instances form time-series data and
performs some merging of attribute values in the current instance with
attribute attribute values of some previous (or future) instance. For
instances where the desired value is unknown either the instance may
be dropped, or missing values used.
Valid filter-specific options are:
-R index1,index2-index4,...
Specify list of columns to calculate new values for.
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 merge 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, use missing values (default is to remove those
instances).
- Version:
- $Revision: 1.4 $
- Author:
- Len Trigg (trigg@cs.waikato.ac.nz)
AbstractTimeSeriesFilter()
-
attributeIndicesTipText()
- Returns the tip text for this property
batchFinished()
- Signifies that this batch of input to the filter is finished.
getAttributeIndices()
- Get the current range selection
getFillWithMissing()
- Gets whether missing values should be used rather than removing instances
where the translated value is not known (due to border effects).
getInstanceRange()
- Gets the number of instances forward to translate values between.
getInvertSelection()
- Get whether the supplied columns are to be removed or kept
getOptions()
- Gets the current settings of the filter.
input(Instance)
- Input an instance for filtering.
listOptions()
- Returns an enumeration describing the available options
setAttributeIndices(String)
- Set which attributes are to be copied (or kept if invert is true)
setAttributeIndicesArray(int[])
- Set which attributes are to be copied (or kept if invert is true)
setFillWithMissing(boolean)
- Sets whether missing values should be used rather than removing instances
where the translated value is not known (due to border effects).
setInputFormat(Instances)
- Sets the format of the input instances.
setInstanceRange(int)
- Sets the number of instances forward to translate values between.
setInvertSelection(boolean)
- Set whether selected columns should be removed or kept.
setOptions(String[])
- Parses a given list of options controlling the behaviour of this object.
AbstractTimeSeriesFilter
public AbstractTimeSeriesFilter()
listOptions
public java.util.Enumeration listOptions()
Returns an enumeration describing the available options
- Returns:
- an enumeration of all the available options
setOptions
public void setOptions(java.lang.String options[]) throws java.lang.Exception
Parses a given list of options controlling the behaviour of this object.
Valid options are:
-R index1,index2-index4,...
Specify list of columns to copy. 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, use missing values (default is to remove those
instances).
- Parameters:
options
- the list of options as an array of strings
- Throws:
- java.lang.Exception - if an option is not supported
getOptions
public java.lang.String[] getOptions()
Gets the current settings of the filter.
- Returns:
- an array of strings suitable for passing to setOptions
setInputFormat
public boolean setInputFormat(Instances instanceInfo) throws java.lang.Exception
Sets the format of the input instances.
- 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:
- java.lang.Exception - if the format couldn't be set successfully
- Overrides:
- setInputFormat in class Filter
input
public boolean input(Instance instance) throws java.lang.Exception
Input an instance for filtering. Ordinarily the instance is processed
and made available for output immediately. Some filters require all
instances be read before producing output.
- Parameters:
instance
- the input instance
- Returns:
- true if the filtered instance may now be
collected with output().
- Throws:
- java.lang.Exception - if the input instance was not of the correct
format or if there was a problem with the filtering.
- Overrides:
- input in class Filter
batchFinished
public boolean batchFinished()
Signifies that this batch of input to the filter is finished. If the
filter requires all instances prior to filtering, output() may now
be called to retrieve the filtered instances.
- Returns:
- true if there are instances pending output
- Throws:
- java.lang.IllegalStateException - if no input structure has been defined
- Overrides:
- batchFinished in class Filter
getFillWithMissing
public boolean getFillWithMissing()
Gets whether missing values should be used rather than removing instances
where the translated value is not known (due to border effects).
- Returns:
- true if so
setFillWithMissing
public void setFillWithMissing(boolean newFillWithMissing)
Sets whether missing values should be used rather than removing instances
where the translated value is not known (due to border effects).
- Parameters:
newFillWithMissing
- true if so
getInstanceRange
public int getInstanceRange()
Gets the number of instances forward to translate values between.
A negative number indicates taking values from a past instance.
- Returns:
- Value of InstanceRange.
setInstanceRange
public void setInstanceRange(int newInstanceRange)
Sets the number of instances forward to translate values between.
A negative number indicates taking values from a past instance.
- Parameters:
newInstanceRange
- Value to assign to InstanceRange.
getInvertSelection
public boolean getInvertSelection()
Get whether the supplied columns are to be removed or kept
- Returns:
- true if the supplied columns will be kept
setInvertSelection
public void setInvertSelection(boolean invert)
Set whether selected columns should be removed or kept. If true the
selected columns are kept and unselected columns are copied. If false
selected columns are copied and unselected columns are kept.
- Parameters:
invert
- the new invert setting
attributeIndicesTipText
public java.lang.String attributeIndicesTipText()
Returns the tip text for this property
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getAttributeIndices
public java.lang.String getAttributeIndices()
Get the current range selection
- Returns:
- a string containing a comma separated list of ranges
setAttributeIndices
public void setAttributeIndices(java.lang.String rangeList)
Set which attributes are to be copied (or kept if invert is true)
- Parameters:
rangeList
- a string representing the list of attributes. Since
the string will typically come from a user, attributes are indexed from
1.
eg: first-3,5,6-last
setAttributeIndicesArray
public void setAttributeIndicesArray(int attributes[])
Set which attributes are to be copied (or kept if invert is true)
- Parameters:
attributes
- an array containing indexes of attributes to select.
Since the array will typically come from a program, attributes are indexed
from 0.
All Packages Class Hierarchy This Package Previous Next Index WEKA's home