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 attribute value, 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 index
The value's index. (default last)

-N
Set if new boolean attribute nominal.

Version:
$Revision: 1.5 $
Author:
Eibe Frank (eibe@cs.waikato.ac.nz)

Constructor Index

o MakeIndicatorFilter()

Method Index

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 getValueIndex()
Get the index of the first value used.
o input(Instance)
Input an instance for filtering.
o inputFormat(Instances)
Sets the format of the input instances.
o listOptions()
Returns an enumeration describing the available options
o main(String[])
Main method for testing this class.
o setAttributeIndex(int)
Sets index of of the attribute used.
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 of the first value used.

Constructors

o MakeIndicatorFilter 
 public MakeIndicatorFilter()

Methods

o inputFormat 
 public boolean inputFormat(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:
inputFormat 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: 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
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 index
The value's index.

-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 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 getValueIndex 
 public int getValueIndex()
Get the index of the first value used.

Returns:
the index of the first value
o setValueIndex 
 public void setValueIndex(int valIndex)
Sets index of of the first value used.

Parameters:
index - the index of the first value
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