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

Class weka.filters.MakeIndicatorFilter

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

public class MakeIndicatorFilter
extends Filter
implements OptionHandler
Creates a new dataset with a boolean attribute replacing a nominal attribute. In the new dataset, a value of 1 is assigned to an instance that exhibits a particular range of attribute values, a 0 to an instance that doesn't. The boolean attribute is coded as numeric by default.

Valid filter-specific options are:

-C col
Index of the attribute to be changed. (default "last")

-V index1,index2-index4,...
Specify list of values to indicate. First and last are valid indices. (default "last")

-N
Set if new boolean attribute nominal.

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

Constructor Index

 o MakeIndicatorFilter()

Method Index

 o attributeIndexTipText()
 o getAttributeIndex()
Get the index of the attribute used.
 o getNumeric()
Check if new attribute is to be numeric.
 o getOptions()
Gets the current settings of the filter.
 o getValueIndices()
Get the indices of the indicator values.
 o getValueRange()
Get the range containing the indicator values.
 o globalInfo()
 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 numericTipText()
 o setAttributeIndex(int)
Sets index of of the attribute used.
 o setInputFormat(Instances)
Sets the format of the input instances.
 o setNumeric(boolean)
Sets if the new Attribute is to be numeric.
 o setOptions(String[])
Parses the options for this object.
 o setValueIndex(int)
Sets index of the indicator value.
 o setValueIndices(String)
Sets indices of the indicator values.
 o setValueIndicesArray(int[])
Set which attributes are to be deleted (or kept if invert is true)
 o valueIndicesTipText()

Constructors

 o MakeIndicatorFilter
 public MakeIndicatorFilter()

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: UnsupportedAttributeTypeException
the selecte attribute is not nominal
Throws: UnsupportedAttributeTypeException
the selecte attribute has fewer than two values.
Overrides:
setInputFormat in class Filter
 o input
 public boolean input(Instance instance)
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.
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:

-C col
Index of the attribute to be changed.

-V index1,index2-index4,...
Specify list of values to indicate. First and last are valid indices. (default "last")

-N
Set if new boolean attribute nominal.

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 globalInfo
 public String globalInfo()
Returns:
a description of the filter suitable for displaying in the explorer/experimenter gui
 o attributeIndexTipText
 public String attributeIndexTipText()
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getAttributeIndex
 public int getAttributeIndex()
Get the index of the attribute used.

Returns:
the index of the attribute
 o setAttributeIndex
 public void setAttributeIndex(int attIndex)
Sets index of of the attribute used.

Parameters:
index - the index of the attribute
 o getValueRange
 public Range getValueRange()
Get the range containing the indicator values.

Returns:
the range containing the indicator values
 o valueIndicesTipText
 public String valueIndicesTipText()
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getValueIndices
 public String getValueIndices()
Get the indices of the indicator values.

Returns:
the indices of the indicator values
 o setValueIndices
 public void setValueIndices(String range)
Sets indices of the indicator values.

Parameters:
range - the string representation of the indicator value indices
See Also:
Range
 o setValueIndex
 public void setValueIndex(int index)
Sets index of the indicator value.

Parameters:
index - the index of the indicator value
 o setValueIndicesArray
 public void setValueIndicesArray(int indices[])
Set which attributes are to be deleted (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 numericTipText
 public String numericTipText()
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o setNumeric
 public void setNumeric(boolean bool)
Sets if the new Attribute is to be numeric.

Parameters:
bool - true if new Attribute is to be numeric
 o getNumeric
 public boolean getNumeric()
Check if new attribute is to be numeric.

Returns:
true if new attribute is to be numeric
 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