Package adams.data.instancesanalysis.pls

Class KernelPLS

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.instancesanalysis.pls.AbstractPLS

adams.data.instancesanalysis.pls.AbstractMultiClassPLS

adams.data.instancesanalysis.pls.KernelPLS

All Implemented Interfaces:

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

public class KernelPLS
extends AbstractMultiClassPLS

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.transformation.kernel.AbstractKernel	m_Kernel	the kernel to use.
protected com.github.waikatodatamining.matrix.algorithm.pls.KernelPLS	m_KernelPLS	the actual algorithm.
protected int	m_MaxIter	Inner NIPALS loop maximum number of iterations
protected double	m_Tol	Inner NIPALS loop improvement tolerance

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

m_ClassAttributeIndices, m_ClassAttributes, 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
KernelPLS()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected weka.core.Instances	doTransform(weka.core.Instances data, Map<String,Object> params)	Transforms the data, initializes if necessary.
com.github.waikatodatamining.matrix.transformation.kernel.AbstractKernel	getKernel()	Sets the kernel 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.
int	getMaxIter()	Sets the inner NIPALS loop improvement tolerance.
adams.core.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.
double	getTol()	Sets the inner NIPALS loop maximum number of iterations.
String	globalInfo()	Returns a string describing the object.
boolean	hasLoadings()	Whether the algorithm supports return of loadings.
String	kernelipText()	Returns the tip text for this property
String	maxIteripText()	Returns the tip text for this property
void	setKernel(com.github.waikatodatamining.matrix.transformation.kernel.AbstractKernel value)	Sets the kernel to use.
void	setMaxIter(int value)	Sets the inner NIPALS loop improvement tolerance.
void	setTol(double value)	Sets the inner NIPALS loop maximum number of iterations.
String	tolipText()	Returns the tip text for this property

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

classAttributesTipText, determineOutputFormat, getClassAttributes, getDefaultClassAttributes, postTransform, preTransform, reset, setClassAttributes

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_Kernel

protected com.github.waikatodatamining.matrix.transformation.kernel.AbstractKernel m_Kernel

the kernel to use.

m_Tol

protected double m_Tol

Inner NIPALS loop improvement tolerance

m_MaxIter

protected int m_MaxIter

Inner NIPALS loop maximum number of iterations

m_KernelPLS

protected com.github.waikatodatamining.matrix.algorithm.pls.KernelPLS m_KernelPLS

the actual algorithm.

Constructor Detail

KernelPLS

public KernelPLS()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getTechnicalInformation

public adams.core.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 adams.core.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractMultiClassPLS

setKernel

public void setKernel(com.github.waikatodatamining.matrix.transformation.kernel.AbstractKernel value)

Sets the kernel to use.

Parameters:

value - the kernel

getKernel

public com.github.waikatodatamining.matrix.transformation.kernel.AbstractKernel getKernel()

Sets the kernel to use.

Returns:

the kernel

kernelipText

public String kernelipText()

Returns the tip text for this property

Returns:

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

setTol

public void setTol(double value)

Sets the inner NIPALS loop maximum number of iterations.

Parameters:

value - the iterations

getTol

public double getTol()

Sets the inner NIPALS loop maximum number of iterations.

Returns:

the iterations

tolipText

public String tolipText()

Returns the tip text for this property

Returns:

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

setMaxIter

public void setMaxIter(int value)

Sets the inner NIPALS loop improvement tolerance.

Parameters:

value - the tolerance

getMaxIter

public int getMaxIter()

Sets the inner NIPALS loop improvement tolerance.

Returns:

the tolerance

maxIteripText

public String maxIteripText()

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

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