com.rapidminer.operator.features.transformation
Class FastICA

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

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class FastICA
extends Operator

This operator performs the independent componente analysis (ICA). Implementation of the FastICA-algorithm of Hyvaerinen und Oja. The operator outputs a FastICAModel. With the ModelApplier you can transform the features.

Author:

Daniel Hakenjos, Ingo Mierswa

See Also:

FastICAModel

Field Summary

static java.lang.String	PARAMETER_ALGORITHM_TYPE The parameter name for "If 'parallel' the components are extracted simultaneously, 'deflation' the components are extracted one at a time"
static java.lang.String	PARAMETER_ALPHA The parameter name for "constant in range [1, 2] used in approximation to neg-entropy when fun="logcosh""
static java.lang.String	PARAMETER_FUNCTION The parameter name for "The functional form of the G function used in the approximation to neg-entropy"
static java.lang.String	PARAMETER_LOCAL_RANDOM_SEED The parameter name for "Use the given random seed instead of global random numbers (-1: use global)"
static java.lang.String	PARAMETER_MAX_ITERATION The parameter name for "maximum number of iterations to perform"
static java.lang.String	PARAMETER_NUMBER_OF_COMPONENTS The parameter name for "Number components to be extracted (-1 number of attributes is used).
static java.lang.String	PARAMETER_ROW_NORM The parameter name for "Indicates whether rows of the data matrix "
static java.lang.String	PARAMETER_TOLERANCE The parameter name for "A positive scalar giving the tolerance at which "

Constructor Summary

FastICA(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_NUMBER_OF_COMPONENTS

public static final java.lang.String PARAMETER_NUMBER_OF_COMPONENTS

The parameter name for "Number components to be extracted (-1 number of attributes is used)."

See Also:

Constant Field Values

PARAMETER_ALGORITHM_TYPE

public static final java.lang.String PARAMETER_ALGORITHM_TYPE

The parameter name for "If 'parallel' the components are extracted simultaneously, 'deflation' the components are extracted one at a time"

See Also:

Constant Field Values

PARAMETER_FUNCTION

public static final java.lang.String PARAMETER_FUNCTION

The parameter name for "The functional form of the G function used in the approximation to neg-entropy"

See Also:

Constant Field Values

PARAMETER_ALPHA

public static final java.lang.String PARAMETER_ALPHA

The parameter name for "constant in range [1, 2] used in approximation to neg-entropy when fun="logcosh""

See Also:

Constant Field Values

PARAMETER_ROW_NORM

public static final java.lang.String PARAMETER_ROW_NORM

The parameter name for "Indicates whether rows of the data matrix "

See Also:

Constant Field Values

PARAMETER_MAX_ITERATION

public static final java.lang.String PARAMETER_MAX_ITERATION

The parameter name for "maximum number of iterations to perform"

See Also:

Constant Field Values

PARAMETER_TOLERANCE

public static final java.lang.String PARAMETER_TOLERANCE

The parameter name for "A positive scalar giving the tolerance at which "

See Also:

Constant Field Values

PARAMETER_LOCAL_RANDOM_SEED

public static final java.lang.String PARAMETER_LOCAL_RANDOM_SEED

The parameter name for "Use the given random seed instead of global random numbers (-1: use global)"

See Also:

Constant Field Values

Constructor Detail

FastICA

public FastICA(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