Package adams.ml.preprocessing.supervised

Class PLS

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.ml.preprocessing.AbstractFilter

adams.ml.preprocessing.AbstractColumnSubsetFilter

adams.ml.preprocessing.AbstractColumnSubsetBatchFilter

adams.ml.preprocessing.supervised.PLS

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, CapabilitiesHandler, BatchFilter, ColumnSubsetFilter, Filter, Serializable

public class PLS
extends AbstractColumnSubsetBatchFilter

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_ActualAlgorithm	the actual PLS algorithm to use.
protected com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS	m_Algorithm	the PLS algorithm to use.
protected SpreadSheet	m_Loadings	the loadings.

Fields inherited from class adams.ml.preprocessing.AbstractColumnSubsetFilter

m_ClassColumns, m_ColRange, m_ColRegExp, m_ColumnSubset, m_DataColumns, m_DropOtherColumns, m_OtherColumns

Fields inherited from class adams.ml.preprocessing.AbstractFilter

m_Initialized, m_OutputFormat

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
PLS()

Method Summary

Modifier and Type	Method	Description
String	algorithmTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Dataset	doFilter(Dataset data)	Filters the dataset coming through.
protected void	doInitFilter(Dataset data)	Filter-specific initialization.
com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS	getAlgorithm()	Returns the algorithm to use.
Capabilities	getCapabilities()	Returns the capabilities.
String	globalInfo()	Returns a string describing the object.
protected Dataset	initOutputFormat(Dataset data)	Initializes the output format.
protected void	reset()	Resets the scheme.
void	setAlgorithm(com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS value)	Sets the algorithm to use.

Methods inherited from class adams.ml.preprocessing.AbstractColumnSubsetBatchFilter

filter, initFilter, postInitFilter, preInitFilter

Methods inherited from class adams.ml.preprocessing.AbstractColumnSubsetFilter

colRangeTipText, colRegExpTipText, columnSubsetTipText, dropOtherColumnsTipText, getColRange, getColRegExp, getColumnSubset, getDropOtherColumns, initColumns, setColRange, setColRegExp, setColumnSubset, setDropOtherColumns

Methods inherited from class adams.ml.preprocessing.AbstractFilter

appendData, appendHeader, getOutputFormat, isInitialized

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.ml.preprocessing.ColumnSubsetFilter

getOutputFormat, isInitialized

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Algorithm

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

the PLS algorithm to use.

m_ActualAlgorithm

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

the actual PLS algorithm to use.

m_Loadings

protected SpreadSheet m_Loadings

the loadings.

Constructor Detail

PLS

public PLS()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractColumnSubsetFilter

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractColumnSubsetFilter

setAlgorithm

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

Sets the algorithm to use.

Parameters:

value - the algorithm

getAlgorithm

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

Returns the algorithm to use.

Returns:

the algorithm

algorithmTipText

public String algorithmTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getCapabilities

public Capabilities getCapabilities()

Returns the capabilities.

Returns:

the capabilities

doInitFilter

protected void doInitFilter(Dataset data)
                     throws Exception

Filter-specific initialization.

Specified by:

doInitFilter in class AbstractColumnSubsetBatchFilter

Parameters:

data - the data to initialize with

Throws:

Exception - if initialization fails

initOutputFormat

protected Dataset initOutputFormat(Dataset data)
                            throws Exception

Initializes the output format.

Specified by:

initOutputFormat in class AbstractColumnSubsetBatchFilter

Parameters:

data - the output format

Throws:

Exception - if initialization fails

doFilter

protected Dataset doFilter(Dataset data)
                    throws Exception

Filters the dataset coming through.

Specified by:

doFilter in class AbstractColumnSubsetBatchFilter

Parameters:

data - the data to filter

Returns:

the filtered data

Throws:

Exception - if filtering fails