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.
- Version:
- $Revision: 1.14 $
- Author:
- Eibe Frank (eibe@cs.waikato.ac.nz)
MakeIndicatorFilter()
-
attributeIndexTipText()
-
getAttributeIndex()
- Get the index of the attribute used.
getNumeric()
- Check if new attribute is to be numeric.
getOptions()
- Gets the current settings of the filter.
getValueIndices()
- Get the indices of the indicator values.
getValueRange()
- Get the range containing the indicator values.
globalInfo()
-
input(Instance)
- Input an instance for filtering.
listOptions()
- Returns an enumeration describing the available options
main(String[])
- Main method for testing this class.
numericTipText()
-
setAttributeIndex(int)
- Sets index of of the attribute used.
setInputFormat(Instances)
- Sets the format of the input instances.
setNumeric(boolean)
- Sets if the new Attribute is to be numeric.
setOptions(String[])
- Parses the options for this object.
setValueIndex(int)
- Sets index of the indicator value.
setValueIndices(String)
- Sets indices of the indicator values.
setValueIndicesArray(int[])
- Set which attributes are to be deleted (or kept if invert is true)
valueIndicesTipText()
-
MakeIndicatorFilter
public MakeIndicatorFilter()
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:
- UnsupportedAttributeTypeException - the selecte attribute is not nominal
- UnsupportedAttributeTypeException - the selecte attribute has fewer than two values.
- Overrides:
- setInputFormat in class Filter
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:
- java.lang.IllegalStateException - if no input format has been set.
- Overrides:
- input in class Filter
listOptions
public java.util.Enumeration listOptions()
Returns an enumeration describing the available options
- Returns:
- an enumeration of all the available options
setOptions
public void setOptions(java.lang.String options[]) throws java.lang.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:
- java.lang.Exception - if an option is not supported
getOptions
public java.lang.String[] getOptions()
Gets the current settings of the filter.
- Returns:
- an array of strings suitable for passing to setOptions
globalInfo
public java.lang.String globalInfo()
- Returns:
- a description of the filter suitable for
displaying in the explorer/experimenter gui
attributeIndexTipText
public java.lang.String attributeIndexTipText()
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getAttributeIndex
public int getAttributeIndex()
Get the index of the attribute used.
- Returns:
- the index of the attribute
setAttributeIndex
public void setAttributeIndex(int attIndex)
Sets index of of the attribute used.
- Parameters:
index
- the index of the attribute
getValueRange
public Range getValueRange()
Get the range containing the indicator values.
- Returns:
- the range containing the indicator values
valueIndicesTipText
public java.lang.String valueIndicesTipText()
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getValueIndices
public java.lang.String getValueIndices()
Get the indices of the indicator values.
- Returns:
- the indices of the indicator values
setValueIndices
public void setValueIndices(java.lang.String range)
Sets indices of the indicator values.
- Parameters:
range
- the string representation of the indicator value indices
- See Also:
- Range
setValueIndex
public void setValueIndex(int index)
Sets index of the indicator value.
- Parameters:
index
- the index of the indicator value
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
numericTipText
public java.lang.String numericTipText()
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
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
getNumeric
public boolean getNumeric()
Check if new attribute is to be numeric.
- Returns:
- true if new attribute is to be numeric
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