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

Class weka.filters.CopyAttributesFilter

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

public class CopyAttributesFilter
extends Filter
implements OptionHandler
An instance filter that copies a range of attributes in the dataset. This is used in conjunction with other filters that overwrite attribute during the course of their operation -- this filter allows the original attributes to be kept as well as the new attributes.

Valid filter-specific options are:

-R index1,index2-index4,...
Specify list of columns to copy. First and last are valid indexes. Attribute copies are placed at the end of the dataset. (default none)

-V
Invert matching sense (i.e. copy all non-specified columns)

Version:
$Revision: 1.10 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)

Constructor Index

 o CopyAttributesFilter()
 

Method Index

 o attributeIndicesTipText()
Returns the tip text for this property
 o getAttributeIndices()
Get the current range selection
 o getInvertSelection()
Get whether the supplied columns are to be removed or kept
 o getOptions()
Gets the current settings of the filter.
 o globalInfo()
Returns a string describing this filter
 o input(Instance)
Input an instance for filtering.
 o invertSelectionTipText()
Returns the tip text for this property
 o listOptions()
Returns an enumeration describing the available options
 o main(String[])
Main method for testing this class.
 o setAttributeIndices(String)
Set which attributes are to be copied (or kept if invert is true)
 o setAttributeIndicesArray(int[])
Set which attributes are to be copied (or kept if invert is true)
 o setInputFormat(Instances)
Sets the format of the input instances.
 o setInvertSelection(boolean)
Set whether selected columns should be removed or kept.
 o setOptions(String[])
Parses a given list of options controlling the behaviour of this object.

Constructor Detail

 o CopyAttributesFilter
public CopyAttributesFilter()

Method Detail

 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 a given list of options controlling the behaviour of this object. Valid options are:

-R index1,index2-index4,...
Specify list of columns to copy. First and last are valid indexes. (default none)

-V
Invert matching sense (i.e. copy all non-specified columns)

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 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 a problem occurs setting the input format
Overrides:
setInputFormat in class Filter
 o input
public boolean input(Instance instance)
          Input an instance for filtering. Ordinarily the instance is processed and made available for output immediately. Some filters require all 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 defined.
Overrides:
input in class Filter
 o globalInfo
public java.lang.String globalInfo()
          Returns a string describing this filter
Returns:
a description of the filter suitable for displaying in the explorer/experimenter gui
 o invertSelectionTipText
public java.lang.String invertSelectionTipText()
          Returns the tip text for this property
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getInvertSelection
public boolean getInvertSelection()
          Get whether the supplied columns are to be removed or kept
Returns:
true if the supplied columns will be kept
 o setInvertSelection
public void setInvertSelection(boolean invert)
          Set whether selected columns should be removed or kept. If true the selected columns are kept and unselected columns are copied. If false selected columns are copied and unselected columns are kept.
Parameters:
invert - the new invert setting
 o getAttributeIndices
public java.lang.String getAttributeIndices()
          Get the current range selection
Returns:
a string containing a comma separated list of ranges
 o attributeIndicesTipText
public java.lang.String attributeIndicesTipText()
          Returns the tip text for this property
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o setAttributeIndices
public void setAttributeIndices(java.lang.String rangeList) throws java.lang.Exception
          Set which attributes are to be copied (or kept if invert is true)
Parameters:
rangeList - a string representing the list of attributes. Since the string will typically come from a user, attributes are indexed from 1.
eg: first-3,5,6-last
Throws:
java.lang.Exception - if an invalid range list is supplied
 o setAttributeIndicesArray
public void setAttributeIndicesArray(int attributes[]) throws java.lang.Exception
          Set which attributes are to be copied (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:
java.lang.Exception - if an invalid set of ranges is supplied
 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