Package adams.data.instancesanalysis.pls

Class AbstractSingleClassPLS

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

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

Direct Known Subclasses:

DIPLS, NIPALS, OPLS, PLS1, PRM, SIMPLS, SparsePLS, VCPLS

public abstract class AbstractSingleClassPLS
extends AbstractPLS

Ancestor for schemes that predict a single class.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_ClassMean	the class mean.
protected double	m_ClassStdDev	the class stddev.
protected weka.filters.Filter	m_Filter	for centering the data
protected weka.filters.Filter	m_Missing	for replacing missing values
static String	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
AbstractSingleClassPLS()

Method Summary

Modifier and Type	Method	Description
weka.core.Instances	determineOutputFormat(weka.core.Instances input)	Determines the output format based on the input format and returns this.
protected weka.core.Instances	postTransform(weka.core.Instances instances, Map<String,Object> params)	Postprocesses the data.
protected weka.core.Instances	preTransform(weka.core.Instances instances, Map<String,Object> params)	Preprocesses the data.
void	reset()	Resets the scheme.

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

defineOptions, doTransform, getCapabilities, getDefaultPreprocessingType, getLoadings, getMatrix, getMatrixNames, getNumComponents, getOutputFormat, getPredictionType, getPreprocessingType, getReplaceMissing, getTechnicalInformation, hasLoadings, isInitialized, numComponentsTipText, predictionTypeTipText, preprocessingTypeTipText, replaceMissingTipText, setNumComponents, setPredictionType, setPreprocessingType, setReplaceMissing, transform

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

PARAM_CLASSVALUES

public static final String PARAM_CLASSVALUES

See Also:

Constant Field Values

m_Missing

protected weka.filters.Filter m_Missing

for replacing missing values

m_Filter

protected weka.filters.Filter m_Filter

for centering the data

m_ClassMean

protected double m_ClassMean

the class mean.

m_ClassStdDev

protected double m_ClassStdDev

the class stddev.

Constructor Detail

AbstractSingleClassPLS

public AbstractSingleClassPLS()

Method Detail

reset

public void reset()

Resets the scheme.

Overrides:

reset in class AbstractPLS

determineOutputFormat

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

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

Specified by:

determineOutputFormat in class AbstractPLS

Parameters:

input - the input format to base the output format on

Returns:

the output format

Throws:

Exception - in case the determination goes wrong

preTransform

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

Preprocesses the data.

Specified by:

preTransform in class AbstractPLS

Parameters:

instances - the data to process

params - additional parameters

Returns:

the preprocessed data

Throws:

Exception

postTransform

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

Postprocesses the data.

Specified by:

postTransform in class AbstractPLS

Parameters:

instances - the data to process

params - additional parameters

Returns:

the postprocessed data

Throws:

Exception