Package adams.core.discovery.genetic

Class SIMPLSWeightsMatrix

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.discovery.AbstractDiscoveryHandler

adams.core.discovery.genetic.AbstractGeneticDiscoveryHandler

adams.core.discovery.genetic.AbstractGeneticDoubleMatrixDiscoveryHandler

adams.core.discovery.genetic.SIMPLSWeightsMatrix

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractDiscoveryHandler>, SizeOfHandler, Serializable

public class SIMPLSWeightsMatrix
extends AbstractGeneticDoubleMatrixDiscoveryHandler

SIMPLS pls internal weights handler.

Version:

$Revision$

Author:

Dale (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.discovery.genetic.AbstractGeneticDoubleMatrixDiscoveryHandler

m_Columns, m_Maximum, m_Minimum, m_Rows, m_Splits

Fields inherited from class adams.core.discovery.AbstractDiscoveryHandler

m_Containers, m_InvertMatching, m_RegExp

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

Method Summary

Modifier and Type	Method	Description
protected int	getDefaultColumns()	The number of PLS components
protected double	getDefaultMaximum()	Returns the default maximum.
protected double	getDefaultMinimum()	Returns the default minimum.
protected int	getDefaultRows()	This is the number of attributes
protected int	getDefaultSplits()	Returns the default splits.
protected weka.core.matrix.Matrix	getValue(PropertyPath.PropertyContainer cont)	Returns the matrix value from the property container.
String	globalInfo()	Returns a string describing the object.
protected boolean	handles(Object obj)	Checks whether this object is handled by this discovery handler.
void	performInitialization(AbstractGeneticAlgorithm owner, PropertyPath.PropertyContainer cont)	Gets called for performing the initialization.
boolean	requiresInitialization()	Returns whether the handler requires an initialization.
protected void	setValue(PropertyPath.PropertyContainer cont, weka.core.matrix.Matrix value)	Sets the integer value in the property container.

Methods inherited from class adams.core.discovery.genetic.AbstractGeneticDoubleMatrixDiscoveryHandler

calcNumBits, columnsTipText, defineOptions, doPack, doUnpack, getColumns, getMaximum, getMinimum, getNumBits, getRows, getSplits, maximumTipText, minimumTipText, rowsTipText, setColumns, setMaximum, setMinimum, setRows, setSplits, splitsTipText

Methods inherited from class adams.core.discovery.genetic.AbstractGeneticDiscoveryHandler

pack, unpack

Methods inherited from class adams.core.discovery.AbstractDiscoveryHandler

addContainer, getContainers, getInvertMatching, getRegExp, handles, invertMatchingTipText, regExpTipText, reset, setInvertMatching, setRegExp, shallowCopy, shallowCopy, toString

Methods inherited from class adams.core.option.AbstractOptionHandler

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

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

Constructor Detail

SIMPLSWeightsMatrix

public SIMPLSWeightsMatrix()

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

getDefaultSplits

protected int getDefaultSplits()

Description copied from class: AbstractGeneticDoubleMatrixDiscoveryHandler

Returns the default splits.

Specified by:

getDefaultSplits in class AbstractGeneticDoubleMatrixDiscoveryHandler

Returns:

the default

getDefaultRows

protected int getDefaultRows()

This is the number of attributes

Specified by:

getDefaultRows in class AbstractGeneticDoubleMatrixDiscoveryHandler

Returns:

getDefaultColumns

protected int getDefaultColumns()

The number of PLS components

Specified by:

getDefaultColumns in class AbstractGeneticDoubleMatrixDiscoveryHandler

Returns:

getDefaultMinimum

protected double getDefaultMinimum()

Returns the default minimum.

Specified by:

getDefaultMinimum in class AbstractGeneticDoubleMatrixDiscoveryHandler

Returns:

the default

getDefaultMaximum

protected double getDefaultMaximum()

Returns the default maximum.

Specified by:

getDefaultMaximum in class AbstractGeneticDoubleMatrixDiscoveryHandler

Returns:

the default

getValue

protected weka.core.matrix.Matrix getValue(PropertyPath.PropertyContainer cont)

Returns the matrix value from the property container.

Specified by:

getValue in class AbstractGeneticDoubleMatrixDiscoveryHandler

Parameters:

cont - the container

Returns:

the value

setValue

protected void setValue(PropertyPath.PropertyContainer cont,
                        weka.core.matrix.Matrix value)

Sets the integer value in the property container.

Specified by:

setValue in class AbstractGeneticDoubleMatrixDiscoveryHandler

Parameters:

cont - the container

value - the value to set

requiresInitialization

public boolean requiresInitialization()

Returns whether the handler requires an initialization.
Default implementation returns false.

Overrides:

requiresInitialization in class AbstractGeneticDiscoveryHandler

Returns:

true if necessary

performInitialization

public void performInitialization(AbstractGeneticAlgorithm owner,
                                  PropertyPath.PropertyContainer cont)

Gets called for performing the initialization.
Apply simpls PLS filter and extract

Overrides:

performInitialization in class AbstractGeneticDiscoveryHandler

Parameters:

owner - the owning algorithm

cont - the property container to update

handles

protected boolean handles(Object obj)

Checks whether this object is handled by this discovery handler.

Specified by:

handles in class AbstractDiscoveryHandler

Parameters:

obj - the object to check

Returns:

true if handled