com.rapidminer.operator.features.transformation
Class PCA

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.features.transformation.PCA

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class PCA
extends Operator

This operator performs a principal components analysis (PCA) using the covariance matrix. The user can specify the amount of variance to cover in the original data when retaining the best number of principal components. The user can also specify manually the number of principal components. The operator outputs a PCAModel. With the ModelApplier you can transform the features.

Author:

Ingo Mierswa

See Also:

PCAModel

Field Summary

static java.lang.String	PARAMETER_NUMBER_OF_COMPONENTS The parameter name for "Keep this number of components.
static java.lang.String	PARAMETER_REDUCTION_TYPE
static java.lang.String	PARAMETER_VARIANCE_THRESHOLD The parameter name for "Keep the all components with a cumulative variance smaller than the given threshold.
static int	REDUCTION_FIXED
static java.lang.String[]	REDUCTION_METHODS
static int	REDUCTION_NONE
static int	REDUCTION_VARIANCE

Constructor Summary

PCA(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
java.lang.Class<?>[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARAMETER_VARIANCE_THRESHOLD

public static final java.lang.String PARAMETER_VARIANCE_THRESHOLD

The parameter name for "Keep the all components with a cumulative variance smaller than the given threshold."

See Also:

Constant Field Values

PARAMETER_NUMBER_OF_COMPONENTS

public static final java.lang.String PARAMETER_NUMBER_OF_COMPONENTS

The parameter name for "Keep this number of components. If '-1' then keep all components.'"

See Also:

Constant Field Values

PARAMETER_REDUCTION_TYPE

public static final java.lang.String PARAMETER_REDUCTION_TYPE

See Also:

Constant Field Values

REDUCTION_METHODS

public static final java.lang.String[] REDUCTION_METHODS

REDUCTION_NONE

public static final int REDUCTION_NONE

See Also:

Constant Field Values

REDUCTION_VARIANCE

public static final int REDUCTION_VARIANCE

See Also:

Constant Field Values

REDUCTION_FIXED

public static final int REDUCTION_FIXED

See Also:

Constant Field Values

Constructor Detail

PCA

public PCA(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

getInputClasses

public java.lang.Class<?>[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class<?>[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input objects which should not be consumed must also be defined by this method (e.g. an example set which is changed but not consumed in the case of a preprocessing operator must be defined in both, the methods Operator.getInputClasses() and Operator.getOutputClasses()). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed (defined by changing the implementation in Operator.getInputDescription(Class)) must not be defined as additional output in this method.

May deliver null or an empy array (no additional output is produced or guaranteed). Must return the class array of delivered output objects otherwise.

Specified by:

getOutputClasses in class Operator

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator