LDA (interruptible-weka 0.1.4 API)

java.lang.Object
- weka.classifiers.AbstractClassifier
- - weka.classifiers.functions.LDA

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable, Classifier, BatchPredictor, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedInstancesHandler

public class LDA
extends AbstractClassifier
implements WeightedInstancesHandler

Generates an LDA model. The covariance matrix is estimated using maximum likelihood from the pooled data.

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

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Instances`	`m_Data` Holds header of training date
`protected MultivariateGaussianEstimator`	`m_Estimator` The pooled estimator
`protected double[]`	`m_GlobalMean` The global mean
`protected double[]`	`m_LogPriors` The logs of the prior probabilities
`protected double[][]`	`m_Means` The per-class mean vectors
`protected RemoveUseless`	`m_RemoveUseless` Rmeove useless filter
`protected double`	`m_Ridge` Ridge parameter

Fields inherited from class weka.classifiers.AbstractClassifier
BATCH_SIZE_DEFAULT, m_BatchSize, m_Debug, m_DoNotCheckCapabilities, m_numDecimalPlaces, NUM_DECIMAL_PLACES_DEFAULT

Constructor Summary

Constructors
Constructor and Description

LDA()

Constructors
Constructor and Description
`LDA()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`buildClassifier(Instances insts)` Builds the classifier.
`double[]`	`distributionForInstance(Instance inst)` Output class probabilities using Bayes' rule.
`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<Option>`	`listOptions()` Returns an enumeration describing the available options.
`static void`	`main(java.lang.String[] argv)` Generates an LDA 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()` Produces textual description of the classifier.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_Data
```
protected Instances m_Data
```
    Holds header of training date
  - m_Estimator
```
protected MultivariateGaussianEstimator m_Estimator
```
    The pooled estimator
  - m_Means
```
protected double[][] m_Means
```
    The per-class mean vectors
  - m_GlobalMean
```
protected double[] m_GlobalMean
```
    The global mean
  - m_LogPriors
```
protected double[] m_LogPriors
```
    The logs of the prior probabilities
  - m_Ridge
```
protected double m_Ridge
```
    Ridge parameter
  - m_RemoveUseless
```
protected RemoveUseless m_RemoveUseless
```
    Rmeove useless filter
- Constructor Detail
  - LDA
```
public LDA()
```
- Method Detail
  - globalInfo
```
public java.lang.String globalInfo()
```
    Global info for this classifier.
  - 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<Option> listOptions()
```
    Returns an enumeration describing the available options.
    
    Specified by:
    
    listOptions in interface OptionHandler
    
    Overrides:
    
    listOptions in class 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 OptionHandler
    
    Overrides:
    
    setOptions in class 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 OptionHandler
    
    Overrides:
    
    getOptions in class AbstractClassifier
    
    Returns:
    
    an array of strings suitable for passing to setOptions()
  - getCapabilities
```
public Capabilities getCapabilities()
```
    Returns default capabilities of the classifier.
    
    Specified by:
    
    getCapabilities in interface Classifier
    
    Specified by:
    
    getCapabilities in interface CapabilitiesHandler
    
    Overrides:
    
    getCapabilities in class AbstractClassifier
    
    Returns:
    
    the capabilities of this classifier
    
    See Also:
    
    Capabilities
  - buildClassifier
```
public void buildClassifier(Instances insts)
                     throws java.lang.Exception
```
    Builds the classifier.
    
    Specified by:
    
    buildClassifier in interface Classifier
    
    Parameters:
    
    insts - set of instances serving as training data
    
    Throws:
    
    java.lang.Exception - if the classifier has not been generated successfully
  - distributionForInstance
```
public double[] distributionForInstance(Instance inst)
                                 throws java.lang.Exception
```
    Output class probabilities using Bayes' rule.
    
    Specified by:
    
    distributionForInstance in interface Classifier
    
    Overrides:
    
    distributionForInstance in class AbstractClassifier
    
    Parameters:
    
    inst - the instance to be classified
    
    Returns:
    
    an array containing the estimated membership probabilities of the test instance in each class or the numeric prediction
    
    Throws:
    
    java.lang.Exception - if distribution could not be computed successfully
  - toString
```
public java.lang.String toString()
```
    Produces textual description of the classifier.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the textual description
  - getRevision
```
public java.lang.String getRevision()
```
    Returns the revision string.
    
    Specified by:
    
    getRevision in interface RevisionHandler
    
    Overrides:
    
    getRevision in class AbstractClassifier
    
    Returns:
    
    the revision
  - main
```
public static void main(java.lang.String[] argv)
```
    Generates an LDA classifier.
    
    Parameters:
    
    argv - the options

Class LDA

Field Summary

Fields inherited from class weka.classifiers.AbstractClassifier

Constructor Summary

Method Summary

Methods inherited from class weka.classifiers.AbstractClassifier

Methods inherited from class java.lang.Object

Field Detail

m_Data

m_Estimator

m_Means

m_GlobalMean

m_LogPriors

m_Ridge

m_RemoveUseless

Constructor Detail

LDA

Method Detail

globalInfo

ridgeTipText

getRidge

setRidge

listOptions

setOptions

getOptions

getCapabilities

buildClassifier

distributionForInstance

toString

getRevision

main