Package adams.flow.transformer

Class WekaPrincipalComponents

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class WekaPrincipalComponents
extends AbstractTransformer
    Performs principal components analysis on the incoming data and outputs the loadings and the transformed data as spreadsheet array.
    Automatically filters out attributes that cannot be handled by PCA.

    Input/output:
    - accepts:
       weka.core.Instances
    - generates:
       adams.data.spreadsheet.SpreadSheet[]


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WekaPrincipalComponents
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -variance-covered <double> (property: varianceCovered)
    Retain enough PC attributes to account for this proportion of variance.
    default: 0.95
 
    -max-attributes <int> (property: maximumAttributes)
    The maximum number of PC attributes to retain.
    default: -1
    minimum: -1
 
    -max-attribute-names <int> (property: maximumAttributeNames)
    The maximum number of attribute names to use.
    default: 5
    minimum: -1
    Actor that takes in an instances object containing TGA-MS data and outputs the coefficients from a principal components analysis
    Version:
    $Revision$
    Author:
    michael.fowke, FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_CoverVariance

        protected double m_CoverVariance
        the variance to cover.

      • m_MaxAttributes

        protected int m_MaxAttributes
        the maximum number of attributes to keep.

      • m_MaxAttributeNames

        protected int m_MaxAttributeNames
        the maximum number of attribute names to use.

    • Constructor Detail

      • WekaPrincipalComponents

        public WekaPrincipalComponents()

    • Method Detail

      • setVarianceCovered

        public void setVarianceCovered​(double value)
        Sets the amount of variance to account for when retaining principal components.
        Parameters:
        value - the proportion of total variance to account for

      • getVarianceCovered

        public double getVarianceCovered()
        Gets the proportion of total variance to account for when retaining principal components.
        Returns:
        the proportion of variance to account for

      • varianceCoveredTipText

        public String varianceCoveredTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setMaximumAttributes

        public void setMaximumAttributes​(int value)
        Sets maximum number of PC attributes to retain.
        Parameters:
        value - the maximum number of attributes

      • getMaximumAttributes

        public int getMaximumAttributes()
        Gets maximum number of PC attributes to retain.
        Returns:
        the maximum number of attributes

      • maximumAttributesTipText

        public String maximumAttributesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setMaximumAttributeNames

        public void setMaximumAttributeNames​(int value)
        Sets maximum number of attribute names.
        Parameters:
        value - the maximum number of attribute names

      • getMaximumAttributeNames

        public int getMaximumAttributeNames()
        Gets maximum number of attribute names to use.
        Returns:
        the maximum number of attribute names

      • maximumAttributeNamesTipText

        public String maximumAttributeNamesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message