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

Class weka.filters.AttributeSelectionFilter

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

public class AttributeSelectionFilter
extends Filter
implements OptionHandler
Filter for doing attribute selection.

Valid options are:

-S <"Name of search class [search options]">
Set search method for subset evaluators.
eg. -S "weka.attributeSelection.BestFirst -S 8"

-E <"Name of attribute/subset evaluation class [evaluator options]">
Set the attribute/subset evaluator.
eg. -E "weka.attributeSelection.CfsSubsetEval -L"

Version:
$Revision: 1.19 $
Author:
Mark Hall (mhall@cs.waikato.ac.nz)

Constructor Index

 o AttributeSelectionFilter()
Constructor

Method Index

 o batchFinished()
Signify that this batch of input to the filter is finished.
 o getEvaluator()
Get the name of the attribute/subset evaluator
 o getOptions()
Gets the current settings for the attribute selection (search, evaluator) etc.
 o getSearch()
Get the name of the search method
 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 setEvaluator(ASEvaluation)
set a string holding the name of a attribute/subset evaluator
 o setOptions(String[])
Parses a given list of options.
 o setSearch(ASSearch)
Set as string holding the name of a search class

Constructor Detail

 o AttributeSelectionFilter
public AttributeSelectionFilter()
          Constructor

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. Valid options are:

-S <"Name of search class [search options]">
Set search method for subset evaluators.
eg. -S "weka.attributeSelection.BestFirst -S 8"

-E <"Name of attribute/subset evaluation class [evaluator options]">
Set the attribute/subset evaluator.
eg. -E "weka.attributeSelection.CfsSubsetEval -L"

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 for the attribute selection (search, evaluator) etc.
Returns:
an array of strings suitable for passing to setOptions()
 o setEvaluator
public void setEvaluator(ASEvaluation evaluator)
          set a string holding the name of a attribute/subset evaluator
 o setSearch
public void setSearch(ASSearch search)
          Set as string holding the name of a search class
 o getEvaluator
public ASEvaluation getEvaluator()
          Get the name of the attribute/subset evaluator
Returns:
the name of the attribute/subset evaluator as a string
 o getSearch
public ASSearch getSearch()
          Get the name of the search method
Returns:
the name of the search method as a string
 o input
public boolean input(Instance instance) throws java.lang.Exception
          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.
java.lang.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 java.lang.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:
java.lang.IllegalStateException - if no input structure has been defined.
java.lang.Exception - if there is a problem during the attribute selection.
Overrides:
batchFinished in class Filter
 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