Package weka.attributeSelection

Class FilteredAttributeEval

java.lang.Object
weka.attributeSelection.ASEvaluation
weka.attributeSelection.FilteredAttributeEval
All Implemented Interfaces:
Serializable, AttributeEvaluator, CapabilitiesHandler, OptionHandler, RevisionHandler
public class FilteredAttributeEval extends ASEvaluation implements Serializable, AttributeEvaluator, OptionHandler
Class for running an arbitrary attribute 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.InfoGainAttributeEval -M"
 -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:

  • Constructor Details

    • FilteredAttributeEval

      public FilteredAttributeEval()

  • Method Details

    • 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:

    • 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.InfoGainAttributeEval -M"
       -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

    • attributeEvaluatorTipText

      public String attributeEvaluatorTipText()
      Returns the tip text for this property
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui

    • setAttributeEvaluator

      public void setAttributeEvaluator(ASEvaluation newEvaluator)
      Set the attribute evaluator to use
      Parameters:
      newEvaluator - the attribute evaluator to use

    • getAttributeEvaluator

      public ASEvaluation getAttributeEvaluator()
      Get the attribute evaluator to use
      Returns:
      the attribute evaluator to use

    • 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

    • evaluateAttribute

      public double evaluateAttribute(int attribute) throws Exception
      Evaluates an individual attribute by delegating to the base evaluator.
      Specified by:
      evaluateAttribute in interface AttributeEvaluator
      Parameters:
      attribute - the index of the attribute to be evaluated
      Returns:
      the merit of the attribute according to the base evaluator
      Throws:
      Exception - if the attribute 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