Package weka.classifiers.functions
Class PLSClassifier
java.lang.Object
weka.classifiers.Classifier
weka.classifiers.functions.PLSClassifier
- All Implemented Interfaces:
Serializable
,Cloneable
,CapabilitiesHandler
,OptionHandler
,RevisionHandler
A wrapper classifier for the PLSFilter, utilizing the PLSFilter's ability to perform predictions.
Valid options are:
-filter <filter specification> The PLS filter to use. Full classname of filter to include, followed by scheme options. (default: weka.filters.supervised.attribute.PLSFilter)
-D If set, classifier is run in debug mode and may output additional info to the console
Options specific to filter weka.filters.supervised.attribute.PLSFilter ('-filter'):
-D Turns on output of debugging information.
-C <num> The number of components to compute. (default: 20)
-U Updates the class attribute as well. (default: off)
-M Turns replacing of missing values on. (default: off)
-A <SIMPLS|PLS1> The algorithm to use. (default: PLS1)
-P <none|center|standardize> The type of preprocessing that is applied to the data. (default: center)
- Version:
- $Revision: 1.4 $
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildClassifier
(Instances data) builds the classifierdouble
classifyInstance
(Instance instance) Classifies the given test instance.Returns the tip text for this propertyReturns default capabilities of the classifier.Get the PLS filter.String[]
returns the options of the current setupReturns the revision string.Returns a string describing classifierGets an enumeration describing the available options.static void
Main method for running this classifier from commandline.void
Set the PLS filter (only used for setup).void
setOptions
(String[] options) Parses the options for this object.toString()
returns a string representation of the classifierMethods inherited from class weka.classifiers.Classifier
debugTipText, distributionForInstance, forName, getDebug, makeCopies, makeCopy, setDebug
-
Constructor Details
-
PLSClassifier
public PLSClassifier()
-
-
Method Details
-
globalInfo
Returns a string describing classifier- Returns:
- a description suitable for displaying in the explorer/experimenter gui
-
listOptions
Gets an enumeration describing the available options.- Specified by:
listOptions
in interfaceOptionHandler
- Overrides:
listOptions
in classClassifier
- Returns:
- an enumeration of all the available options.
-
getOptions
returns the options of the current setup- Specified by:
getOptions
in interfaceOptionHandler
- Overrides:
getOptions
in classClassifier
- Returns:
- the current options
-
setOptions
Parses the options for this object. Valid options are:-filter <filter specification> The PLS filter to use. Full classname of filter to include, followed by scheme options. (default: weka.filters.supervised.attribute.PLSFilter)
-D If set, classifier is run in debug mode and may output additional info to the console
Options specific to filter weka.filters.supervised.attribute.PLSFilter ('-filter'):
-D Turns on output of debugging information.
-C <num> The number of components to compute. (default: 20)
-U Updates the class attribute as well. (default: off)
-M Turns replacing of missing values on. (default: off)
-A <SIMPLS|PLS1> The algorithm to use. (default: PLS1)
-P <none|center|standardize> The type of preprocessing that is applied to the data. (default: center)
- Specified by:
setOptions
in interfaceOptionHandler
- Overrides:
setOptions
in classClassifier
- Parameters:
options
- the options to use- Throws:
Exception
- if setting of options fails
-
filterTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setFilter
Set the PLS filter (only used for setup).- Parameters:
value
- the kernel filter.- Throws:
Exception
- if not PLSFilter
-
getFilter
Get the PLS filter.- Returns:
- the PLS filter
-
getCapabilities
Returns default capabilities of the classifier.- Specified by:
getCapabilities
in interfaceCapabilitiesHandler
- Overrides:
getCapabilities
in classClassifier
- Returns:
- the capabilities of this classifier
- See Also:
-
buildClassifier
builds the classifier- Specified by:
buildClassifier
in classClassifier
- Parameters:
data
- the training instances- Throws:
Exception
- if something goes wrong
-
classifyInstance
Classifies the given test instance. The instance has to belong to a dataset when it's being classified.- Overrides:
classifyInstance
in classClassifier
- Parameters:
instance
- the instance to be classified- Returns:
- the predicted most likely class for the instance or Instance.missingValue() if no prediction is made
- Throws:
Exception
- if an error occurred during the prediction
-
toString
returns a string representation of the classifier -
getRevision
Returns the revision string.- Specified by:
getRevision
in interfaceRevisionHandler
- Overrides:
getRevision
in classClassifier
- Returns:
- the revision
-
main
Main method for running this classifier from commandline.- Parameters:
args
- the options
-