Package adams.data.instancesanalysis.pls

Class DIPLS

  • 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 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 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 adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.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 interface adams.core.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 adams.core.option.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

      • 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

      • 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