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

Class weka.filters.supervised.attribute.NominalToBinary 

java.lang.Object
    |
    +----weka.filters.Filter
            |
            +----weka.filters.supervised.attribute.NominalToBinary
public class NominalToBinary
extends Filter
implements SupervisedFilter, OptionHandler
Converts all nominal attributes into binary numeric attributes. An attribute with k values is transformed into k binary attributes if the class is nominal (using the one-attribute-per-value approach). Binary attributes are left binary. If the class is numeric, k - 1 new binary attributes are generated (in the manner described in "Classification and Regression Trees").

Valid filter-specific options are:

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

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

Constructor Index

o NominalToBinary()
 

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 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 setInputFormat(Instances)
Sets the format of the input instances.
o setOptions(String[])
Parses the options for this object.

Constructor Detail

o NominalToBinary
public NominalToBinary()

Method Detail

o 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 input format can't be set successfully
Overrides:
setInputFormat in class Filter
o input
public boolean input(Instance instance)
          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:
java.lang.IllegalStateException - if no input format has been set
Overrides:
input in class Filter
o batchFinished
public boolean batchFinished()
          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:
java.lang.IllegalStateException - if no input structure has been defined
Overrides:
batchFinished in class Filter
o listOptions
public java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
Returns:
an enumeration of all the available options.
o setOptions
public void setOptions(java.lang.String options[]) throws java.lang.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:
java.lang.Exception - if an option is not supported
o getOptions
public java.lang.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(java.lang.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