AddClassification (weka-stable 3.6.8 API)

java.lang.Object
- weka.filters.Filter
- - weka.filters.SimpleFilter
  - - weka.filters.SimpleBatchFilter
    - - weka.filters.supervised.attribute.AddClassification

All Implemented Interfaces:: Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler

public class AddClassification
extends SimpleBatchFilter

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: 6900 $
Author:: fracpete (fracpete at waikato dot ac dot nz)
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Classifier`	`m_ActualClassifier` The actual classifier used to do the classification.
`protected Classifier`	`m_Classifier` The classifier template used to do the classification.
`protected boolean`	`m_OutputClassification` whether to output the classification.
`protected boolean`	`m_OutputDistribution` whether to output the class distribution.
`protected boolean`	`m_OutputErrorFlag` whether to output the error flag.
`protected boolean`	`m_RemoveOldClass` whether to remove the old class attribute.
`protected File`	`m_SerializedClassifierFile` The file from which to load a serialized classifier.
`protected Instances`	`m_SerializedHeader` the header of the file the serialized classifier was trained with.

Fields inherited from class weka.filters.SimpleFilter
m_Debug

Fields inherited from class weka.filters.Filter
m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors
Constructor and Description

AddClassification()

Constructors
Constructor and Description
`AddClassification()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`classifierTipText()` Returns the tip text for this property.
`protected Instances`	`determineOutputFormat(Instances inputFormat)` Determines the output format based on the input format and returns this.
`protected Classifier`	`getActualClassifier()` Returns the actual classifier to use, either from the serialized model or the one specified by the user.
`Capabilities`	`getCapabilities()` Returns the Capabilities of this filter.
`Classifier`	`getClassifier()` Gets the classifier used by the filter.
`protected String`	`getClassifierSpec()` Gets the classifier specification string, which contains the class name of the classifier and any options to the classifier.
`String[]`	`getOptions()` Gets the current settings of the classifier.
`boolean`	`getOutputClassification()` Get whether the classifiction of the classifier is output.
`boolean`	`getOutputDistribution()` Get whether the classifiction of the classifier is output.
`boolean`	`getOutputErrorFlag()` Get whether the classifiction of the classifier is output.
`boolean`	`getRemoveOldClass()` Get whether the old class attribute is removed.
`String`	`getRevision()` Returns the revision string.
`File`	`getSerializedClassifierFile()` Gets the file pointing to a serialized, trained classifier.
`String`	`globalInfo()` Returns a string describing this filter.
`Enumeration`	`listOptions()` Returns an enumeration describing the available options.
`static void`	`main(String[] args)` runs the filter with the given arguments.
`String`	`outputClassificationTipText()` Returns the tip text for this property.
`String`	`outputDistributionTipText()` Returns the tip text for this property.
`String`	`outputErrorFlagTipText()` Returns the tip text for this property.
`protected Instances`	`process(Instances instances)` Processes the given data (may change the provided dataset) and returns the modified version.
`String`	`removeOldClassTipText()` Returns the tip text for this property.
`protected void`	`reset()` resets the filter, i.e., m_ActualClassifier to null.
`String`	`serializedClassifierFileTipText()` Returns the tip text for this property.
`void`	`setClassifier(Classifier value)` Sets the classifier to classify instances with.
`void`	`setOptions(String[] options)` Parses the options for this object.
`void`	`setOutputClassification(boolean value)` Set whether the classification of the classifier is output.
`void`	`setOutputDistribution(boolean value)` Set whether the Distribution of the classifier is output.
`void`	`setOutputErrorFlag(boolean value)` Set whether the classification of the classifier is output.
`void`	`setRemoveOldClass(boolean value)` Set whether the old class attribute is removed.
`void`	`setSerializedClassifierFile(File value)` Sets the file pointing to a serialized, trained classifier.

Methods inherited from class weka.filters.SimpleBatchFilter
batchFinished, hasImmediateOutputFormat, input

Methods inherited from class weka.filters.SimpleFilter
debugTipText, getDebug, setDebug, setInputFormat

Methods inherited from class weka.filters.Filter
batchFilterFile, bufferInput, copyValues, copyValues, filterFile, flushInput, getCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputFormatPeek, outputPeek, push, resetQueue, runFilter, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

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 template used to do the classification.
  - m_SerializedClassifierFile
```
protected File m_SerializedClassifierFile
```
    The file from which to load a serialized classifier.
  - m_ActualClassifier
```
protected Classifier m_ActualClassifier
```
    The actual classifier used to do the classification.
  - m_SerializedHeader
```
protected Instances m_SerializedHeader
```
    the header of the file the serialized classifier was trained with.
  - m_OutputClassification
```
protected boolean m_OutputClassification
```
    whether to output the classification.
  - m_RemoveOldClass
```
protected boolean m_RemoveOldClass
```
    whether to remove the old class attribute.
  - m_OutputDistribution
```
protected boolean m_OutputDistribution
```
    whether to output the class distribution.
  - m_OutputErrorFlag
```
protected boolean m_OutputErrorFlag
```
    whether to output the error flag.
- Constructor Detail
  - AddClassification
```
public AddClassification()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing this filter.
    
    Specified by:
    
    globalInfo in class SimpleFilter
    
    Returns:
    
    a description of the filter 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
    
    Overrides:
    
    listOptions in class SimpleFilter
    
    Returns:
    
    an enumeration of all the available options.
  - setOptions
```
public void setOptions(String[] options)
                throws Exception
```
    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:
    
    setOptions in interface OptionHandler
    
    Overrides:
    
    setOptions in class SimpleFilter
    
    Parameters:
    
    options - the options to use
    
    Throws:
    
    Exception - if setting of options fails
    
    See Also:
    
    SimpleFilter.reset()
  - getOptions
```
public String[] getOptions()
```
    Gets the current settings of the classifier.
    
    Specified by:
    
    getOptions in interface OptionHandler
    
    Overrides:
    
    getOptions in class SimpleFilter
    
    Returns:
    
    an array of strings suitable for passing to setOptions
  - reset
```
protected void reset()
```
    resets the filter, i.e., m_ActualClassifier to null.
    
    Overrides:
    
    reset in class SimpleFilter
    
    See Also:
    
    m_ActualClassifier
  - getActualClassifier
```
protected Classifier getActualClassifier()
```
    Returns the actual classifier to use, either from the serialized model or the one specified by the user.
    
    Returns:
    
    the classifier to use, null in case of an error
  - getCapabilities
```
public Capabilities getCapabilities()
```
    Returns the Capabilities of this filter.
    
    Specified by:
    
    getCapabilities in interface CapabilitiesHandler
    
    Overrides:
    
    getCapabilities in class Filter
    
    Returns:
    
    the capabilities of this object
    
    See Also:
    
    Capabilities
  - classifierTipText
```
public String classifierTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setClassifier
```
public void setClassifier(Classifier value)
```
    Sets the classifier to classify instances with.
    
    Parameters:
    
    value - The classifier to be used (with its options set).
  - getClassifier
```
public Classifier getClassifier()
```
    Gets the classifier used by the filter.
    
    Returns:
    
    The classifier to be used.
  - getClassifierSpec
```
protected 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.
  - serializedClassifierFileTipText
```
public String serializedClassifierFileTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSerializedClassifierFile
```
public File 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
```
public void setSerializedClassifierFile(File value)
```
    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
```
public String 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
```
public String 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
```
public String 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
```
public String 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.
  - determineOutputFormat
```
protected Instances determineOutputFormat(Instances inputFormat)
                                   throws Exception
```
    Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., immediateOutputFormat() returns false, then this method will be called from batchFinished().
    
    Specified by:
    
    determineOutputFormat in class SimpleFilter
    
    Parameters:
    
    inputFormat - the input format to base the output format on
    
    Returns:
    
    the output format
    
    Throws:
    
    Exception - in case the determination goes wrong
    
    See Also:
    
    SimpleBatchFilter.hasImmediateOutputFormat(), SimpleBatchFilter.batchFinished()
  - process
```
protected Instances process(Instances instances)
                     throws Exception
```
    Processes the given data (may change the provided dataset) and returns the modified version. This method is called in batchFinished().
    
    Specified by:
    
    process in class SimpleFilter
    
    Parameters:
    
    instances - the data to process
    
    Returns:
    
    the modified data
    
    Throws:
    
    Exception - in case the processing goes wrong
    
    See Also:
    
    SimpleBatchFilter.batchFinished()
  - getRevision
```
public String getRevision()
```
    Returns the revision string.
    
    Specified by:
    
    getRevision in interface RevisionHandler
    
    Overrides:
    
    getRevision in class Filter
    
    Returns:
    
    the revision
  - main
```
public static void main(String[] args)
```
    runs the filter with the given arguments.
    
    Parameters:
    
    args - the commandline arguments

Class AddClassification

Field Summary

Fields inherited from class weka.filters.SimpleFilter

Fields inherited from class weka.filters.Filter

Constructor Summary

Method Summary

Methods inherited from class weka.filters.SimpleBatchFilter

Methods inherited from class weka.filters.SimpleFilter

Methods inherited from class weka.filters.Filter

Methods inherited from class java.lang.Object

Field Detail

m_Classifier

m_SerializedClassifierFile

m_ActualClassifier

m_SerializedHeader

m_OutputClassification

m_RemoveOldClass

m_OutputDistribution

m_OutputErrorFlag

Constructor Detail

AddClassification

Method Detail

globalInfo

listOptions

setOptions

getOptions

reset

getActualClassifier

getCapabilities

classifierTipText

setClassifier

getClassifier

getClassifierSpec

serializedClassifierFileTipText

getSerializedClassifierFile

setSerializedClassifierFile

outputClassificationTipText

getOutputClassification

setOutputClassification

removeOldClassTipText

getRemoveOldClass

setRemoveOldClass

outputDistributionTipText

getOutputDistribution

setOutputDistribution

outputErrorFlagTipText

getOutputErrorFlag

setOutputErrorFlag

determineOutputFormat

process

getRevision

main