Package adams.data.instancesanalysis

Class PLS

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class PLS
extends AbstractInstancesAnalysis
    Performs partial least squares analysis and allows access to loadings and scores.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected AbstractPLS m_Algorithm
      the algorithm to use.
      protected WekaAttributeRange m_AttributeRange
      the range of attributes to work.
      protected adams.data.spreadsheet.SpreadSheet m_Loadings
      the loadings.
      protected adams.data.spreadsheet.SpreadSheet m_Scores
      the scores.

      • 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
      PLS()  

    • Field Detail

      • m_AttributeRange

        protected WekaAttributeRange m_AttributeRange
        the range of attributes to work.

      • m_Algorithm

        protected AbstractPLS m_Algorithm
        the algorithm to use.

      • m_Loadings

        protected adams.data.spreadsheet.SpreadSheet m_Loadings
        the loadings.

      • m_Scores

        protected adams.data.spreadsheet.SpreadSheet m_Scores
        the scores.

    • Constructor Detail

      • PLS

        public PLS()

    • 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

      • 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 adams.core.option.AbstractOptionHandler

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.core.option.AbstractOptionHandler

      • setAttributeRange

        public void setAttributeRange​(WekaAttributeRange value)
        Sets the attribute range parameter.
        Parameters:
        value - the range

      • getAttributeRange

        public WekaAttributeRange getAttributeRange()
        Returns the attribute range parameter.
        Returns:
        the range

      • attributeRangeTipText

        public String attributeRangeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAlgorithm

        public void setAlgorithm​(AbstractPLS value)
        Sets the algorithm to use.
        Parameters:
        value - the algorithm

      • getAlgorithm

        public AbstractPLS getAlgorithm()
        Returns the algorithm to use.
        Returns:
        the algorithm

      • algorithmTipText

        public String algorithmTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • check

        protected void check​(weka.core.Instances data)
        Hook method for checks.
        Overrides:
        check in class adams.data.analysis.AbstractAnalysis<weka.core.Instances>
        Parameters:
        data - the data to check

      • doAnalyze

        protected String doAnalyze​(weka.core.Instances data)
                    throws Exception
        Performs the actual analysis.
        Specified by:
        doAnalyze in class adams.data.analysis.AbstractAnalysis<weka.core.Instances>
        Parameters:
        data - the data to analyze
        Returns:
        null if successful, otherwise error message
        Throws:
        Exception - if analysis fails

      • getLoadings

        public adams.data.spreadsheet.SpreadSheet getLoadings()
        Returns the loadings.
        Returns:
        the loadings, null if not available

      • getScores

        public adams.data.spreadsheet.SpreadSheet getScores()
        Returns the scores.
        Returns:
        the scores, null if not available