Class AddClassification
java.lang.Object
weka.filters.Filter
weka.filters.SimpleFilter
weka.filters.SimpleBatchFilter
weka.filters.supervised.attribute.AddClassification
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler,WeightedAttributesHandler,WeightedInstancesHandler
public class AddClassification
extends SimpleBatchFilter
implements WeightedAttributesHandler, WeightedInstancesHandler
A filter for adding the classification, the class
distribution and an error flag to a dataset with a classifier. The classifier
is either trained on the data itself or provided as serialized model.
Valid options are:
-D Turns on output of debugging information.
-W <classifier specification> Full class name of classifier to use, followed by scheme options. eg: "weka.classifiers.bayes.NaiveBayes -D" (default: weka.classifiers.rules.ZeroR)
-serialized <file> Instead of training a classifier on the data, one can also provide a serialized model and use that for tagging the data.
-classification Adds an attribute with the actual classification. (default: off)
-remove-old-class Removes the old class attribute. (default: off)
-distribution Adds attributes with the distribution for all classes (for numeric classes this will be identical to the attribute output with '-classification'). (default: off)
-error Adds an attribute indicating whether the classifier output a wrong classification (for numeric classes this is the numeric difference). (default: off)
- Version:
- $Revision: 14534 $
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the tip text for this property.Returns the Capabilities of this filter.Gets the classifier used by the filter.String[]Gets the current settings of the classifier.booleanGet whether the classifiction of the classifier is output.booleanGet whether the classifiction of the classifier is output.booleanGet whether the classifiction of the classifier is output.booleanGet whether the old class attribute is removed.Returns the revision string.Gets the file pointing to a serialized, trained classifier.Returns a string describing this filter.Returns an enumeration describing the available options.static voidruns the filter with the given arguments.Returns the tip text for this property.Returns the tip text for this property.Returns the tip text for this property.Returns the tip text for this property.Returns the tip text for this property.voidsetClassifier(Classifier value) Sets the classifier to classify instances with.voidsetOptions(String[] options) Parses the options for this object.voidsetOutputClassification(boolean value) Set whether the classification of the classifier is output.voidsetOutputDistribution(boolean value) Set whether the Distribution of the classifier is output.voidsetOutputErrorFlag(boolean value) Set whether the classification of the classifier is output.voidsetRemoveOldClass(boolean value) Set whether the old class attribute is removed.voidsetSerializedClassifierFile(File value) Sets the file pointing to a serialized, trained classifier.Methods inherited from class weka.filters.SimpleBatchFilter
allowAccessToFullInputFormat, batchFinished, input, inputMethods inherited from class weka.filters.SimpleFilter
setInputFormatMethods inherited from class weka.filters.Filter
batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
AddClassification
public AddClassification()
-
-
Method Details
-
globalInfo
Returns a string describing this filter.- Specified by:
globalInfoin classSimpleFilter- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classFilter- Returns:
- an enumeration of all the available options.
-
setOptions
Parses the options for this object. Valid options are:-D Turns on output of debugging information.
-W <classifier specification> Full class name of classifier to use, followed by scheme options. eg: "weka.classifiers.bayes.NaiveBayes -D" (default: weka.classifiers.rules.ZeroR)
-serialized <file> Instead of training a classifier on the data, one can also provide a serialized model and use that for tagging the data.
-classification Adds an attribute with the actual classification. (default: off)
-remove-old-class Removes the old class attribute. (default: off)
-distribution Adds attributes with the distribution for all classes (for numeric classes this will be identical to the attribute output with '-classification'). (default: off)
-error Adds an attribute indicating whether the classifier output a wrong classification (for numeric classes this is the numeric difference). (default: off)
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classFilter- Parameters:
options- the options to use- Throws:
Exception- if setting of options fails
-
getOptions
Gets the current settings of the classifier.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classFilter- Returns:
- an array of strings suitable for passing to setOptions
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
classifierTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setClassifier
Sets the classifier to classify instances with.- Parameters:
value- The classifier to be used (with its options set).
-
getClassifier
Gets the classifier used by the filter.- Returns:
- The classifier to be used.
-
serializedClassifierFileTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getSerializedClassifierFile
Gets the file pointing to a serialized, trained classifier. If it is null or pointing to a directory it will not be used.- Returns:
- the file the serialized, trained classifier is located in
-
setSerializedClassifierFile
Sets the file pointing to a serialized, trained classifier. If the argument is null, doesn't exist or pointing to a directory, then the value is ignored.- Parameters:
value- the file pointing to the serialized, trained classifier
-
outputClassificationTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getOutputClassification
public boolean getOutputClassification()Get whether the classifiction of the classifier is output.- Returns:
- true if the classification of the classifier is output.
-
setOutputClassification
public void setOutputClassification(boolean value) Set whether the classification of the classifier is output.- Parameters:
value- whether the classification of the classifier is output.
-
removeOldClassTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getRemoveOldClass
public boolean getRemoveOldClass()Get whether the old class attribute is removed.- Returns:
- true if the old class attribute is removed.
-
setRemoveOldClass
public void setRemoveOldClass(boolean value) Set whether the old class attribute is removed.- Parameters:
value- whether the old class attribute is removed.
-
outputDistributionTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getOutputDistribution
public boolean getOutputDistribution()Get whether the classifiction of the classifier is output.- Returns:
- true if the distribution of the classifier is output.
-
setOutputDistribution
public void setOutputDistribution(boolean value) Set whether the Distribution of the classifier is output.- Parameters:
value- whether the distribution of the classifier is output.
-
outputErrorFlagTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getOutputErrorFlag
public boolean getOutputErrorFlag()Get whether the classifiction of the classifier is output.- Returns:
- true if the classification of the classifier is output.
-
setOutputErrorFlag
public void setOutputErrorFlag(boolean value) Set whether the classification of the classifier is output.- Parameters:
value- whether the classification of the classifier is output.
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classFilter- Returns:
- the revision
-
main
runs the filter with the given arguments.- Parameters:
args- the commandline arguments
-