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, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.CommandlineRunnable, weka.core.OptionHandler, weka.core.RevisionHandler, weka.core.WeightedInstancesHandler

public class MultiClassFLDA
extends weka.filters.SimpleBatchFilter
implements weka.core.OptionHandler, weka.core.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)

Version:

$Revision: 12341 $

Author:

Eibe Frank (eibe@cs.waikato.ac.nz)

See Also:

Serialized Form

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.
weka.core.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.
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] argv) Main method for testing this class.
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, input, input

Methods inherited from class weka.filters.SimpleFilter

setInputFormat

Methods 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

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

MultiClassFLDA

public MultiClassFLDA()

Method Detail

getCapabilities

public weka.core.Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Overrides:

getCapabilities in class weka.filters.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 weka.filters.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<weka.core.Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class weka.filters.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 weka.core.OptionHandler

Overrides:

setOptions in class weka.filters.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 weka.core.OptionHandler

Overrides:

getOptions in class weka.filters.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 weka.filters.SimpleBatchFilter

Returns:

whether determineOutputFormat has access to the full input dataset

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface weka.core.RevisionHandler

Overrides:

getRevision in class weka.filters.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