All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.filters.NumericTransformFilter

java.lang.Object
   |
   +----weka.filters.Filter
           |
           +----weka.filters.NumericTransformFilter

public class NumericTransformFilter
extends Filter
implements OptionHandler
Transforms numeric attributes using a given transformation method.

Valid filter-specific options are:

-R index1,index2-index4,...
Specify list of columns to transform. First and last are valid indexes. (default none). Non-numeric columns are skipped.

-V
Invert matching sense.

-C string
Name of the class containing the method used for transformation. (default java.lang.Math)

-M string
Name of the method used for the transformation. (default abs)

Author:
Eibe Frank (eibe@cs.waikato.ac.nz)

Constructor Index

 o NumericTransformFilter()
Default constructor -- sets the default transform method to java.lang.Math.abs().

Method Index

 o attributeIndicesTipText()
Returns the tip text for this property
 o getAttributeIndices()
Get the current range selection
 o getClassName()
Get the class containing the transformation method.
 o getInvertSelection()
Get whether the supplied columns are to be transformed or not
 o getMethodName()
Get the transformation method.
 o getOptions()
Gets the current settings of the filter.
 o input(Instance)
Input an instance for filtering.
 o listOptions()
Returns an enumeration describing the available options
 o main(String[])
Main method for testing this class.
 o setAttributeIndices(String)
Set which attributes are to be transformed (or kept if invert is true).
 o setAttributeIndicesArray(int[])
Set which attributes are to be transformed (or kept if invert is true)
 o setClassName(String)
Sets the class containing the transformation method.
 o setInputFormat(Instances)
Sets the format of the input instances.
 o setInvertSelection(boolean)
Set whether selected columns should be transformed or not.
 o setMethodName(String)
Set the transformation method.
 o setOptions(String[])
Parses the options for this object.

Constructors

 o NumericTransformFilter
 public NumericTransformFilter()
Default constructor -- sets the default transform method to java.lang.Math.abs().

Methods

 o setInputFormat
 public boolean setInputFormat(Instances instanceInfo) throws 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: Exception
if the input format can't be set successfully
Overrides:
setInputFormat in class Filter
 o input
 public boolean input(Instance instance) throws Exception
Input an instance for filtering. The instance is processed and made available for output immediately.

Parameters:
instance - the input instance
Returns:
true if the filtered instance may now be collected with output().
Throws: IllegalStateException
if no input format has been set.
Throws: InvocationTargetException
if there is a problem applying the configured transform method.
Overrides:
input in class Filter
 o listOptions
 public Enumeration listOptions()
Returns an enumeration describing the available options

Returns:
an enumeration of all the available options
 o setOptions
 public void setOptions(String options[]) throws Exception
Parses the options for this object. Valid options are:

-R index1,index2-index4,...
Specify list of columns to transform. First and last are valid indexes. (default none). Non-numeric columns are skipped.

-V
Invert matching sense.

-C string
Name of the class containing the method used for transformation. (default java.lang.Math)

-M string
Name of the method used for the transformation. (default abs)

Parameters:
options - the list of options as an array of strings
Throws: Exception
if an option is not supported
 o getOptions
 public String[] getOptions()
Gets the current settings of the filter.

Returns:
an array of strings suitable for passing to setOptions
 o getClassName
 public String getClassName()
Get the class containing the transformation method.

Returns:
string describing the class
 o setClassName
 public void setClassName(String name) throws ClassNotFoundException
Sets the class containing the transformation method.

Parameters:
name - the name of the class
Throws: ClassNotFoundException
if class can't be found
 o getMethodName
 public String getMethodName()
Get the transformation method.

Returns:
string describing the transformation method.
 o setMethodName
 public void setMethodName(String name) throws NoSuchMethodException
Set the transformation method.

Parameters:
name - the name of the method
Throws: NoSuchMethodException
if method can't be found in class
 o getInvertSelection
 public boolean getInvertSelection()
Get whether the supplied columns are to be transformed or not

Returns:
true if the supplied columns will be kept
 o setInvertSelection
 public void setInvertSelection(boolean invert)
Set whether selected columns should be transformed or not.

Parameters:
invert - the new invert setting
 o attributeIndicesTipText
 public String attributeIndicesTipText()
Returns the tip text for this property

Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getAttributeIndices
 public String getAttributeIndices()
Get the current range selection

Returns:
a string containing a comma separated list of ranges
 o setAttributeIndices
 public void setAttributeIndices(String rangeList)
Set which attributes are to be transformed (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
Throws: InvalidArgumentException
if an invalid range list is supplied
 o setAttributeIndicesArray
 public void setAttributeIndicesArray(int attributes[])
Set which attributes are to be transformed (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.
Throws: InvalidArgumentException
if an invalid set of ranges is supplied
 o main
 public static void main(String argv[])
Main method for testing this class.

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home