FilteredSubsetEval (weka-stable 3.6.8 API)

java.lang.Object
- weka.attributeSelection.ASEvaluation
- - weka.attributeSelection.FilteredSubsetEval

All Implemented Interfaces:

Serializable, SubsetEvaluator, CapabilitiesHandler, OptionHandler, RevisionHandler
```
public class FilteredSubsetEval
extends ASEvaluation
implements Serializable, SubsetEvaluator, OptionHandler
```
Class for running an arbitrary subset evaluator on data that has been passed through an arbitrary filter (note: filters that alter the order or number of attributes are not allowed). Like the evaluator, the structure of the filter is based exclusively on the training data.
Valid options are:
```
 -W <evaluator specification>
  Full name of base evaluator to use, followed by evaluator options.
  eg: "weka.attributeSelection.CfsSubsetEval -L"
```
```
 -F <filter specification>
  Full class name of filter to use, followed
  by filter options.
  eg: "weka.filters.supervised.instance.SpreadSubsample -M 1"
```
Version:

$Revision: 5562 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected SubsetEvaluator`	`m_evaluator` Base evaluator
`protected Filter`	`m_filter` Filter
`protected Instances`	`m_filteredInstances` Filtered instances structure

Constructor Summary

Constructors
Constructor and Description

FilteredSubsetEval()

Constructors
Constructor and Description
`FilteredSubsetEval()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`buildEvaluator(Instances data)` Initializes a filtered attribute evaluator.
`double`	`evaluateSubset(BitSet subset)` evaluates a subset of attributes
`String`	`filterTipText()` Returns the tip text for this property
`Capabilities`	`getCapabilities()` Returns default capabilities of the evaluator.
`protected String`	`getEvaluatorSpec()` Get the evaluator + options as a string
`Filter`	`getFilter()` Get the filter to use
`protected String`	`getFilterSpec()` Get the filter + options as a string
`String[]`	`getOptions()` Gets the current settings of the subset evaluator.
`String`	`getRevision()` Returns the revision string.
`ASEvaluation`	`getSubsetEvaluator()` Get the subset evaluator to use
`String`	`globalInfo()`
`Enumeration`	`listOptions()` Returns an enumeration describing the available options.
`static void`	`main(String[] args)` Main method for testing this class.
`void`	`setFilter(Filter newFilter)` Set the filter to use
`void`	`setOptions(String[] options)` Parses a given list of options.
`void`	`setSubsetEvaluator(ASEvaluation newEvaluator)` Set the subset evaluator to use
`String`	`subsetEvaluatorTipText()` Returns the tip text for this property
`String`	`toString()` Describe the attribute evaluator

Methods inherited from class weka.attributeSelection.ASEvaluation
forName, makeCopies, postProcess, runEvaluator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_evaluator
```
protected SubsetEvaluator m_evaluator
```
    Base evaluator
  - m_filter
```
protected Filter m_filter
```
    Filter
  - m_filteredInstances
```
protected Instances m_filteredInstances
```
    Filtered instances structure
- Constructor Detail
  - FilteredSubsetEval
```
public FilteredSubsetEval()
```
- Method Detail
  - getCapabilities
```
public Capabilities getCapabilities()
```
    Returns default capabilities of the evaluator.
    
    Specified by:
    
    getCapabilities in interface CapabilitiesHandler
    
    Overrides:
    
    getCapabilities in class ASEvaluation
    
    Returns:
    
    the capabilities of this evaluator.
    
    See Also:
    
    Capabilities
  - globalInfo
```
public String globalInfo()
```
    Returns:
    
    a description of the evaluator suitable for displaying in the explorer/experimenter gui
  - listOptions
```
public Enumeration listOptions()
```
    Returns an enumeration describing the available options.
    
    Specified by:
    
    listOptions in interface OptionHandler
    
    Returns:
    
    an enumeration of all the available options.
  - setOptions
```
public void setOptions(String[] options)
                throws Exception
```
    Parses a given list of options.
    Valid options are:
```
 -W <evaluator specification>
  Full name of base evaluator to use, followed by evaluator options.
  eg: "weka.attributeSelection.CfsSubsetEval -L"
```
```
 -F <filter specification>
  Full class name of filter to use, followed
  by filter options.
  eg: "weka.filters.supervised.instance.SpreadSubsample -M 1"
```
    Specified by:
    
    setOptions in interface OptionHandler
    
    Parameters:
    
    options - the list of options as an array of strings
    
    Throws:
    
    Exception - if an option is not supported
  - getOptions
```
public String[] getOptions()
```
    Gets the current settings of the subset evaluator.
    
    Specified by:
    
    getOptions in interface OptionHandler
    
    Returns:
    
    an array of strings suitable for passing to setOptions
  - getEvaluatorSpec
```
protected String getEvaluatorSpec()
```
    Get the evaluator + options as a string
    
    Returns:
    
    a String containing the name of the evalautor + any options
  - subsetEvaluatorTipText
```
public String subsetEvaluatorTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setSubsetEvaluator
```
public void setSubsetEvaluator(ASEvaluation newEvaluator)
```
    Set the subset evaluator to use
    
    Parameters:
    
    newEvaluator - the subset evaluator to use
  - getSubsetEvaluator
```
public ASEvaluation getSubsetEvaluator()
```
    Get the subset evaluator to use
    
    Returns:
    
    the subset evaluator to use
  - getFilterSpec
```
protected String getFilterSpec()
```
    Get the filter + options as a string
    
    Returns:
    
    a String containing the name of the filter + any options
  - filterTipText
```
public String filterTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setFilter
```
public void setFilter(Filter newFilter)
```
    Set the filter to use
    
    Parameters:
    
    newFilter - the filter to use
  - getFilter
```
public Filter getFilter()
```
    Get the filter to use
    
    Returns:
    
    the filter to use
  - getRevision
```
public String getRevision()
```
    Returns the revision string.
    
    Specified by:
    
    getRevision in interface RevisionHandler
    
    Overrides:
    
    getRevision in class ASEvaluation
    
    Returns:
    
    the revision
  - buildEvaluator
```
public void buildEvaluator(Instances data)
                    throws Exception
```
    Initializes a filtered attribute evaluator.
    
    Specified by:
    
    buildEvaluator in class ASEvaluation
    
    Parameters:
    
    data - set of instances serving as training data
    
    Throws:
    
    Exception - if the evaluator has not been generated successfully
  - evaluateSubset
```
public double evaluateSubset(BitSet subset)
                      throws Exception
```
    evaluates a subset of attributes
    
    Specified by:
    
    evaluateSubset in interface SubsetEvaluator
    
    Parameters:
    
    subset - a bitset representing the attribute subset to be evaluated
    
    Returns:
    
    the "merit" of the subset
    
    Throws:
    
    Exception - if the subset could not be evaluated
  - toString
```
public String toString()
```
    Describe the attribute evaluator
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a description of the attribute evaluator as a string
  - main
```
public static void main(String[] args)
```
    Main method for testing this class.
    
    Parameters:
    
    args - the options

Class FilteredSubsetEval

Field Summary

Constructor Summary

Method Summary

Methods inherited from class weka.attributeSelection.ASEvaluation

Methods inherited from class java.lang.Object

Field Detail

m_evaluator

m_filter

m_filteredInstances

Constructor Detail

FilteredSubsetEval

Method Detail

getCapabilities

globalInfo

listOptions

setOptions

getOptions

getEvaluatorSpec

subsetEvaluatorTipText

setSubsetEvaluator

getSubsetEvaluator

getFilterSpec

filterTipText

setFilter

getFilter

getRevision

buildEvaluator

evaluateSubset

toString

main