weka.classifiers.functions

Class FLDA

java.lang.Object

weka.classifiers.AbstractClassifier

weka.classifiers.functions.FLDA

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, weka.classifiers.Classifier, weka.core.BatchPredictor, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.CommandlineRunnable, weka.core.OptionHandler, weka.core.RevisionHandler

public class FLDA
extends weka.classifiers.AbstractClassifier

Builds Fisher's Linear Discriminant function. The threshold is selected so that the separator is half-way between centroids. The class must be binary and all other attributes must be numeric. Missing values are not permitted. Constant attributes are removed using RemoveUseless. No standardization or normalization of attributes is performed.

Valid options are:

 -R
  The ridge parameter.
  (default is 1e-6)

 -output-debug-info
  If set, classifier is run in debug mode and
  may output additional info to the console

 -do-not-check-capabilities
  If set, classifier capabilities are not checked before classifier is built
  (use with caution).

Version:

$Revision: 10382 $

Author:

Eibe Frank, University of Waikato

See Also:

Serialized Form

Field Summary

Fields inherited from class weka.classifiers.AbstractClassifier

BATCH_SIZE_DEFAULT, NUM_DECIMAL_PLACES_DEFAULT

Constructor Summary

Constructors

Constructor and Description
FLDA()

Method Summary

Modifier and Type	Method and Description
void	buildClassifier(weka.core.Instances insts) Builds the classifier.
double[]	distributionForInstance(weka.core.Instance inst) Output class "probabilities".
weka.core.Capabilities	getCapabilities() Returns default capabilities of the classifier.
java.lang.String[]	getOptions() Gets the current settings of IBk.
java.lang.String	getRevision() Returns the revision string.
double	getRidge() Get the value of Ridge.
java.lang.String	globalInfo() Global info for this classifier.
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] argv) Generates an FLDA classifier.
java.lang.String	ridgeTipText() Returns the tip text for this property
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setRidge(double newRidge) Set the value of Ridge.
java.lang.String	toString() Outputs description of classifier as a string.

Methods inherited from class weka.classifiers.AbstractClassifier

batchSizeTipText, classifyInstance, debugTipText, distributionsForInstances, doNotCheckCapabilitiesTipText, forName, getBatchSize, getDebug, getDoNotCheckCapabilities, getNumDecimalPlaces, implementsMoreEfficientBatchPrediction, makeCopies, makeCopy, numDecimalPlacesTipText, postExecution, preExecution, run, runClassifier, setBatchSize, setDebug, setDoNotCheckCapabilities, setNumDecimalPlaces

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

FLDA

public FLDA()

Method Detail

globalInfo

public java.lang.String globalInfo()

Global info for this classifier.

getCapabilities

public weka.core.Capabilities getCapabilities()

Returns default capabilities of the classifier.

Specified by:

getCapabilities in interface weka.classifiers.Classifier

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Overrides:

getCapabilities in class weka.classifiers.AbstractClassifier

Returns:

the capabilities of this classifier

buildClassifier

public void buildClassifier(weka.core.Instances insts)
                     throws java.lang.Exception

Builds the classifier.

Throws:

java.lang.Exception

distributionForInstance

public double[] distributionForInstance(weka.core.Instance inst)
                                 throws java.lang.Exception

Output class "probabilities". These need to be calibrated.

Specified by:

distributionForInstance in interface weka.classifiers.Classifier

Overrides:

distributionForInstance in class weka.classifiers.AbstractClassifier

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Outputs description of classifier as a string.

Overrides:

toString in class java.lang.Object

Returns:

the description

ridgeTipText

public java.lang.String ridgeTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

getRidge

public double getRidge()

Get the value of Ridge.

Returns:

Value of Ridge.

setRidge

public void setRidge(double newRidge)

Set the value of Ridge.

Parameters:

newRidge - Value to assign to Ridge.

listOptions

public java.util.Enumeration<weka.core.Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class weka.classifiers.AbstractClassifier

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:

 -R
  The ridge parameter.
  (default is 1e-6)

 -output-debug-info
  If set, classifier is run in debug mode and
  may output additional info to the console

 -do-not-check-capabilities
  If set, classifier capabilities are not checked before classifier is built
  (use with caution).

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class weka.classifiers.AbstractClassifier

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

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class weka.classifiers.AbstractClassifier

Returns:

an array of strings suitable for passing to setOptions()

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface weka.core.RevisionHandler

Overrides:

getRevision in class weka.classifiers.AbstractClassifier

Returns:

the revision

main

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

Generates an FLDA classifier.

Parameters:

argv - the options