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

Class weka.filters.NominalToBinaryFilter 

java.lang.Object
   |
   +----weka.filters.Filter
           |
           +----weka.filters.NominalToBinaryFilter
public class NominalToBinaryFilter
extends Filter
implements OptionHandler
Converts all nominal attributes into binary numeric attributes. An attribute with k values is transformed into k-1 new binary attributes (in a similar manner to CART if a numeric class is assigned). Currently requires that a class attribute be set (but this should be changed).

Valid filter-specific options are:

-N
If binary attributes are to be coded as nominal ones.

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

Constructor Index

o NominalToBinaryFilter()

Method Index

o batchFinished()
Signify that this batch of input to the filter is finished.
o getBinaryAttributesNominal()
Gets if binary attributes are to be treated as nominal ones.
o getOptions()
Gets the current settings of the filter.
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 setBinaryAttributesNominal(boolean)
Sets if binary attributes are to be treates as nominal ones.
o setOptions(String[])
Parses the options for this object.

Constructors

o NominalToBinaryFilter 
 public NominalToBinaryFilter()

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. Filter requires all training instances be read before producing output.

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 batchFinished 
 public boolean batchFinished() throws Exception
Signify 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: Exception
if no input structure has been defined
Overrides:
batchFinished 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:

-N
If binary attributes are to be coded as nominal ones.

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 getBinaryAttributesNominal 
 public boolean getBinaryAttributesNominal()
Gets if binary attributes are to be treated as nominal ones.

Returns:
true if binary attributes are to be treated as nominal ones
o setBinaryAttributesNominal 
 public void setBinaryAttributesNominal(boolean bool)
Sets if binary attributes are to be treates as nominal ones.

Parameters:
bool - true if binary attributes are to be treated as nominal ones
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