Package adams.data.instancesanalysis.pls
Class OPLS
- 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.OPLS
-
- 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 OPLS extends AbstractSingleClassPLS
- 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_Base
the base PLS algorithm.protected com.github.waikatodatamining.matrix.algorithm.pls.OPLS
m_OPLS
the actual algorithm.-
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
-
-
Constructor Summary
Constructors Constructor Description OPLS()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
baseTipText()
Returns the tip text for this propertyvoid
defineOptions()
Adds options to the internal list of options.weka.core.Instances
determineOutputFormat(weka.core.Instances input)
Determines the output format based on the input format and returns this.protected weka.core.Instances
doTransform(weka.core.Instances data, Map<String,Object> params)
Transforms the data, initializes if necessary.com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS
getBase()
Sets the base PLS algorithm 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.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.String
globalInfo()
Returns a string describing the object.boolean
hasLoadings()
Whether the algorithm supports return of loadings.void
setBase(com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS value)
Sets the base PLS algorithm to use.-
Methods inherited from class adams.data.instancesanalysis.pls.AbstractSingleClassPLS
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
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceadams.core.GlobalInfoSupporter
- Specified by:
globalInfo
in classadams.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 interfaceadams.core.TechnicalInformationHandler
- Specified by:
getTechnicalInformation
in classAbstractPLS
- Returns:
- the technical information about this class
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceadams.core.option.OptionHandler
- Overrides:
defineOptions
in classAbstractPLS
-
setBase
public void setBase(com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS value)
Sets the base PLS algorithm to use.- Parameters:
value
- the base algorithm
-
getBase
public com.github.waikatodatamining.matrix.algorithm.pls.AbstractPLS getBase()
Sets the base PLS algorithm to use.- Returns:
- the base algorithm
-
baseTipText
public String baseTipText()
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 interfaceGenericPLSMatrixAccess
- Specified by:
getMatrixNames
in classAbstractPLS
- 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 interfaceGenericPLSMatrixAccess
- Specified by:
getMatrix
in classAbstractPLS
- 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 interfaceGenericPLSMatrixAccess
- Specified by:
hasLoadings
in classAbstractPLS
- Returns:
- true if supported
- See Also:
getLoadings()
-
getLoadings
public weka.core.matrix.Matrix getLoadings()
Returns the loadings, if available.- Specified by:
getLoadings
in interfaceGenericPLSMatrixAccess
- Specified by:
getLoadings
in classAbstractPLS
- Returns:
- the loadings, null if not available
-
determineOutputFormat
public weka.core.Instances determineOutputFormat(weka.core.Instances input) throws Exception
Determines the output format based on the input format and returns this.- Overrides:
determineOutputFormat
in classAbstractSingleClassPLS
- Parameters:
input
- the input format to base the output format on- Returns:
- the output format
- Throws:
Exception
- in case the determination goes wrong
-
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 classAbstractPLS
- Parameters:
data
- the data to useparams
- additional parameters- Returns:
- the transformed data
- Throws:
Exception
-
-