Package adams.data.instancesanalysis.pls

Class OPLS

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.instancesanalysis.pls.AbstractPLS

adams.data.instancesanalysis.pls.AbstractSingleClassPLS

adams.data.instancesanalysis.pls.OPLS

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, TechnicalInformationHandler, Serializable, weka.core.CapabilitiesHandler, GenericPLSMatrixAccess

public class OPLS
extends AbstractSingleClassPLS

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS	m_Base	the base PLS algorithm.
protected com.github.waikatodatamining.matrix.algorithm.pls.OPLS	m_OPLS	the actual algorithm.

Fields inherited from class adams.data.instancesanalysis.pls.AbstractSingleClassPLS

m_ClassMean, m_ClassStdDev, m_Filter, m_Missing, PARAM_CLASSVALUES

Fields inherited from class adams.data.instancesanalysis.pls.AbstractPLS

m_Initialized, m_NumComponents, m_OutputFormat, m_PredictionType, m_PreprocessingType, m_ReplaceMissing

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
OPLS()

Method Summary

Modifier and Type	Method	Description
String	baseTipText()	Returns the tip text for this property
void	defineOptions()	Adds options to the internal list of options.
weka.core.Instances	determineOutputFormat(weka.core.Instances input)	Determines the output format based on the input format and returns this.
protected weka.core.Instances	doTransform(weka.core.Instances data, Map<String,Object> params)	Transforms the data, initializes if necessary.
com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS	getBase()	Sets the base PLS algorithm to use.
weka.core.matrix.Matrix	getLoadings()	Returns the loadings, if available.
weka.core.matrix.Matrix	getMatrix(String name)	Returns the matrix with the specified name.
String[]	getMatrixNames()	Returns the all the available matrices.
TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
String	globalInfo()	Returns a string describing the object.
boolean	hasLoadings()	Whether the algorithm supports return of loadings.
void	setBase(com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS value)	Sets the base PLS algorithm to use.

Methods inherited from class adams.data.instancesanalysis.pls.AbstractSingleClassPLS

postTransform, preTransform, reset

Methods inherited from class adams.data.instancesanalysis.pls.AbstractPLS

getCapabilities, getDefaultPreprocessingType, getNumComponents, getOutputFormat, getPredictionType, getPreprocessingType, getReplaceMissing, isInitialized, numComponentsTipText, predictionTypeTipText, preprocessingTypeTipText, replaceMissingTipText, setNumComponents, setPredictionType, setPreprocessingType, setReplaceMissing, transform

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Base

protected com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS m_Base

the base PLS algorithm.

m_OPLS

protected com.github.waikatodatamining.matrix.algorithm.pls.OPLS m_OPLS

the actual algorithm.

Constructor Detail

OPLS

public OPLS()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface TechnicalInformationHandler

Specified by:

getTechnicalInformation in class AbstractPLS

Returns:

the technical information about this class

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractPLS

setBase

public void setBase(com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS value)

Sets the base PLS algorithm to use.

Parameters:

value - the base algorithm

getBase

public com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS getBase()

Sets the base PLS algorithm to use.

Returns:

the base algorithm

baseTipText

public String baseTipText()

Returns the tip text for this property

Returns:

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

getMatrixNames

public String[] getMatrixNames()

Returns the all the available matrices.

Specified by:

getMatrixNames in interface GenericPLSMatrixAccess

Specified by:

getMatrixNames in class AbstractPLS

Returns:

the names of the matrices

getMatrix

public weka.core.matrix.Matrix getMatrix(String name)

Returns the matrix with the specified name.

Specified by:

getMatrix in interface GenericPLSMatrixAccess

Specified by:

getMatrix in class AbstractPLS

Parameters:

name - the name of the matrix

Returns:

the matrix, null if not available

hasLoadings

public boolean hasLoadings()

Whether the algorithm supports return of loadings.

Specified by:

hasLoadings in interface GenericPLSMatrixAccess

Specified by:

hasLoadings in class AbstractPLS

Returns:

true if supported

See Also:

getLoadings()

getLoadings

public weka.core.matrix.Matrix getLoadings()

Returns the loadings, if available.

Specified by:

getLoadings in interface GenericPLSMatrixAccess

Specified by:

getLoadings in class AbstractPLS

Returns:

the loadings, null if not available

determineOutputFormat

public weka.core.Instances determineOutputFormat(weka.core.Instances input)
                                          throws Exception

Determines the output format based on the input format and returns this.

Overrides:

determineOutputFormat in class AbstractSingleClassPLS

Parameters:

input - the input format to base the output format on

Returns:

the output format

Throws:

Exception - in case the determination goes wrong

doTransform

protected weka.core.Instances doTransform(weka.core.Instances data,
                                          Map<String,Object> params)
                                   throws Exception

Transforms the data, initializes if necessary.

Specified by:

doTransform in class AbstractPLS

Parameters:

data - the data to use

params - additional parameters

Returns:

the transformed data

Throws:

Exception