weka.classifiers
Class FilteredClassifier

java.lang.Object
  |
  +--weka.classifiers.Classifier
        |
        +--weka.classifiers.DistributionClassifier
              |
              +--weka.classifiers.FilteredClassifier

All Implemented Interfaces:

java.lang.Cloneable, OptionHandler, java.io.Serializable

public class FilteredClassifier

extends DistributionClassifier

implements OptionHandler

Class for running an arbitrary classifier on data that has been passed through an arbitrary filter.

Valid options from the command line are:

-B classifierstring
Classifierstring should contain the full class name of a classifier followed by options to the classifier. (required).

-F filterstring
Filterstring should contain the full class name of a filter followed by options to the filter. (required).

Author:

Len Trigg (trigg@cs.waikato.ac.nz)

See Also:

Serialized Form

Field Summary

protected Classifier	m_Classifier The classifier
protected Filter	m_Filter The filter
protected Instances	m_FilteredInstances The instance structure of the filtered instances

Constructor Summary

FilteredClassifier()
Default constructor specifying ZeroR as the classifier and AllFilter as the filter.

FilteredClassifier(Classifier classifier, Filter filter)
Constructor that specifies the subclassifier and filter to use.

Method Summary

void	buildClassifier(Instances data) Build the classifier on the filtered data.
double[]	distributionForInstance(Instance instance) Classifies a given instance after filtering.
Classifier	getClassifier() Gets the classifier used.
protected java.lang.String	getClassifierSpec() Gets the classifier specification string, which contains the class name of the classifier and any options to the classifier
Filter	getFilter() Gets the filter used.
protected java.lang.String	getFilterSpec() Gets the filter specification string, which contains the class name of the filter and any options to the filter
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
java.util.Enumeration	listOptions() Returns an enumeration describing the available options
static void	main(java.lang.String[] argv) Main method for testing this class.
void	setClassifier(Classifier classifier) Sets the classifier
void	setFilter(Filter filter) Sets the filter
void	setOptions(java.lang.String[] options) Parses a given list of options.
java.lang.String	toString() Output a representation of this classifier

Methods inherited from class weka.classifiers.DistributionClassifier

classifyInstance

Methods inherited from class weka.classifiers.Classifier

forName, makeCopies

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Classifier

protected Classifier m_Classifier

The classifier

m_Filter

protected Filter m_Filter

The filter

m_FilteredInstances

protected Instances m_FilteredInstances

The instance structure of the filtered instances

Constructor Detail

FilteredClassifier

public FilteredClassifier()

Default constructor specifying ZeroR as the classifier and AllFilter as the filter. Both of these are just placeholders for more useful selections.

FilteredClassifier

public FilteredClassifier(Classifier classifier,
                          Filter filter)

Constructor that specifies the subclassifier and filter to use.

Parameters:

classifier - the Classifier to receive filtered instances.

filter - the Filter that will process instances before passing to the Classifier.

Method Detail

listOptions

public java.util.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(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options. Valid options are:

-B classifierstring
Classifierstring should contain the full class name of a classifier followed by options to the classifier. (required).

-F filterstring
Filterstring should contain the full class name of a filter followed by options to the filter. (required).

Specified by:

setOptions in interface OptionHandler

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 Classifier.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setClassifier

public void setClassifier(Classifier classifier)

Sets the classifier

Parameters:

classifier - the classifier with all options set.

getClassifier

public Classifier getClassifier()

Gets the classifier used.

Returns:

the classifier

getClassifierSpec

protected java.lang.String getClassifierSpec()

Gets the classifier specification string, which contains the class name of the classifier and any options to the classifier

Returns:

the classifier string.

setFilter

public void setFilter(Filter filter)

Sets the filter

Parameters:

filter - the filter with all options set.

getFilter

public Filter getFilter()

Gets the filter used.

Returns:

the filter

getFilterSpec

protected java.lang.String getFilterSpec()

Gets the filter specification string, which contains the class name of the filter and any options to the filter

Returns:

the filter string.

buildClassifier

public void buildClassifier(Instances data)
                     throws java.lang.Exception

Build the classifier on the filtered data.

Overrides:

buildClassifier in class Classifier

Parameters:

data - the training data

Throws:

java.lang.Exception - if the classifier could not be built successfully

distributionForInstance

public double[] distributionForInstance(Instance instance)
                                 throws java.lang.Exception

Classifies a given instance after filtering.

Overrides:

distributionForInstance in class DistributionClassifier

Parameters:

instance - the instance to be classified

Throws:

java.lang.Exception - if instance could not be classified successfully

toString

public java.lang.String toString()

Output a representation of this classifier

Overrides:

toString in class java.lang.Object

main

public static void main(java.lang.String[] argv)

Main method for testing this class.

Parameters:

argv - should contain the following arguments: -t training file [-T test file] [-c class index]