weka.filters.supervised.attribute

Class MultiClassFLDA

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.supervised.attribute.MultiClassFLDA

All Implemented Interfaces:

java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedInstancesHandler

public class MultiClassFLDA
extends SimpleBatchFilter
implements OptionHandler, WeightedInstancesHandler

Implements Fisher's linear discriminant analysis for dimensionality reduction. Note that this implementation adds the value of the ridge parameter to the diagonal of the pooled within-class scatter matrix. Valid options are:

 -R
  The ridge parameter to add to the diagonal of the pooled within-class scatter matrix.
  (default is 1e-6)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double	m_Ridge Ridge parameter
protected no.uib.cipr.matrix.Matrix	m_WeightingMatrix Stores the weighting matrix.

Fields inherited from class weka.filters.Filter

m_Debug, m_DoNotCheckCapabilities, m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors

Constructor and Description
MultiClassFLDA()

Method Summary

Modifier and Type	Method and Description
boolean	allowAccessToFullInputFormat() Returns whether to allow the determineOutputFormat(Instances) method access to the full dataset rather than just the header.
protected no.uib.cipr.matrix.Vector	computeMean(Instances data, double[] totalWeight, int aI) Computes the mean vector for the given dataset.
protected Instances	determineOutputFormat(Instances inputFormat) Determines the output format for the data that is produced by this filter.
Capabilities	getCapabilities() Returns the Capabilities of this filter.
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() Provides information regarding this class.
protected no.uib.cipr.matrix.Vector	instanceToVector(Instance inst) Turns an instance with a class into a vector without a class.
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] argv) Main method for testing this class.
protected Instances	process(Instances instances) Takes a batch of data and transforms it.
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.

Methods inherited from class weka.filters.SimpleBatchFilter

batchFinished, hasImmediateOutputFormat, input

Methods inherited from class weka.filters.SimpleFilter

reset, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, 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_WeightingMatrix

protected no.uib.cipr.matrix.Matrix m_WeightingMatrix

Stores the weighting matrix.

m_Ridge

protected double m_Ridge

Ridge parameter

Constructor Detail

MultiClassFLDA

public MultiClassFLDA()

Method Detail

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

globalInfo

public java.lang.String globalInfo()

Provides information regarding this class.

Specified by:

globalInfo in class SimpleFilter

Returns:

string describing the method that this class implements

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 Filter

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 to add to the diagonal of the pooled within-class scatter matrix.
  (default is 1e-6)

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class Filter

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 Filter

Returns:

an array of strings suitable for passing to setOptions()

allowAccessToFullInputFormat

public boolean allowAccessToFullInputFormat()

Returns whether to allow the determineOutputFormat(Instances) method access to the full dataset rather than just the header.

Default implementation returns false.

Overrides:

allowAccessToFullInputFormat in class SimpleBatchFilter

Returns:

whether determineOutputFormat has access to the full input dataset

computeMean

protected no.uib.cipr.matrix.Vector computeMean(Instances data,
                                                double[] totalWeight,
                                                int aI)

Computes the mean vector for the given dataset.

instanceToVector

protected no.uib.cipr.matrix.Vector instanceToVector(Instance inst)

Turns an instance with a class into a vector without a class.

determineOutputFormat

protected Instances determineOutputFormat(Instances inputFormat)
                                   throws java.lang.Exception

Determines the output format for the data that is produced by this filter.

Specified by:

determineOutputFormat in class SimpleFilter

Parameters:

inputFormat - the input format to base the output format on

Returns:

the output format

Throws:

java.lang.Exception - if a problem occurs when the output format is generated

See Also:

SimpleFilter.hasImmediateOutputFormat(), Filter.batchFinished()

process

protected Instances process(Instances instances)
                     throws java.lang.Exception

Takes a batch of data and transforms it.

Specified by:

process in class SimpleFilter

Parameters:

instances - the data to process

Returns:

the processed instances

Throws:

java.lang.Exception - is thrown if a problem occurs

See Also:

Filter.batchFinished()

getRevision

public java.lang.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(java.lang.String[] argv)

Main method for testing this class.

Parameters:

argv - should contain arguments to the filter: use -h for help