Package adams.data.instancesanalysis.pls

Class DIPLS

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.DIPLS

All Implemented Interfaces:

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

public class DIPLS
extends AbstractSingleClassPLS

Domain Invariant Partial Least Squares (DIPLS).

For more information see:
Ramin Nikzad-Langerodi, Werner Zellinger, Edwin Lughofer,, Susanne Saminger-Platz. Domain-Invariant Partial-Least-Squares Regression. Analytical Chemistry. 90(11):6693-6701. URL https://pubs.acs.org/doi/10.1021/acs.analchem.8b00498

 @article{missing_id,
    author = {Ramin Nikzad-Langerodi, Werner Zellinger, Edwin Lughofer, and Susanne Saminger-Platz},
    journal = {Analytical Chemistry},
    number = {11},
    pages = {6693-6701},
    title = {Domain-Invariant Partial-Least-Squares Regression},
    volume = {90},
    URL = {https://pubs.acs.org/doi/10.1021/acs.analchem.8b00498}
 }
 

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 

-preprocessing-type <NONE|CENTER|STANDARDIZE> (property: preprocessingType)
    The type of preprocessing to perform.
    default: CENTER
 

-replace-missing <boolean> (property: replaceMissing)
    Whether to replace missing values.
    default: false
 

-num-components <int> (property: numComponents)
    The number of components to compute.
    default: 20
    minimum: 1
 

-prediction-type <NONE|ALL|EXCEPT_CLASS> (property: predictionType)
    The type of prediction to perform.
    default: NONE
 

-lambda <double> (property: lambda)
    The lambda (> 0).
    default: 1.0
    minimum: 1.0E-8
 

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.DIPLS	m_DIPLS	the actual algorithm.
protected double	m_Lambda	lambda

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

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.
double	getLambda()	Returns the lambda.
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.
String	lambdaTipText()	Returns the tip text for this property
void	setLambda(double value)	Sets the lambda.

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

determineOutputFormat, 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_DIPLS

protected com.github.waikatodatamining.matrix.algorithm.pls.DIPLS m_DIPLS

the actual algorithm.

m_Lambda

protected double m_Lambda

lambda

Constructor Detail

DIPLS

public DIPLS()

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

setLambda

public void setLambda(double value)

Sets the lambda.

Parameters:

value - the lambda

getLambda

public double getLambda()

Returns the lambda.

Returns:

the lambda

lambdaTipText

public String lambdaTipText()

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