com.rapidminer.operator.features.transformation
Class SOMDimensionalityReduction

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

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class SOMDimensionalityReduction
extends Operator

This operator performs a dimensionality reduction based on a SOM (Self Organizing Map, aka Kohonen net).

Author:

Sebastian Land, Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_ADAPTION_RADIUS_END The parameter name for "Defines the radius of the sphere around an stimulus, within an adaption occoures.
static java.lang.String	PARAMETER_ADAPTION_RADIUS_START The parameter name for "Defines the radius of the sphere around an stimulus, within an adaption occoures.
static java.lang.String	PARAMETER_LEARNING_RATE_END The parameter name for "Defines the strength of an adaption in the last round.
static java.lang.String	PARAMETER_LEARNING_RATE_START The parameter name for "Defines the strength of an adaption in the first round.
static java.lang.String	PARAMETER_NET_SIZE The parameter name for "Defines the size of the SOM net, by setting the length of every edge of the net.
static java.lang.String	PARAMETER_NUMBER_OF_DIMENSIONS The parameter name for "Defines the number of dimensions, the data shall be reduced.
static java.lang.String	PARAMETER_TRAINING_ROUNDS The parameter name for "Defines the number of trainnig rounds"

Constructor Summary

SOMDimensionalityReduction(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
static double[]	getDoubleArrayFromExample(Example example)
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_DIMENSIONS

public static final java.lang.String PARAMETER_NUMBER_OF_DIMENSIONS

The parameter name for "Defines the number of dimensions, the data shall be reduced."

See Also:

Constant Field Values

PARAMETER_NET_SIZE

public static final java.lang.String PARAMETER_NET_SIZE

The parameter name for "Defines the size of the SOM net, by setting the length of every edge of the net."

See Also:

Constant Field Values

PARAMETER_TRAINING_ROUNDS

public static final java.lang.String PARAMETER_TRAINING_ROUNDS

The parameter name for "Defines the number of trainnig rounds"

See Also:

Constant Field Values

PARAMETER_LEARNING_RATE_START

public static final java.lang.String PARAMETER_LEARNING_RATE_START

The parameter name for "Defines the strength of an adaption in the first round. The strength will decrease every round until it reaches the learning_rate_end in the last round."

See Also:

Constant Field Values

PARAMETER_LEARNING_RATE_END

public static final java.lang.String PARAMETER_LEARNING_RATE_END

The parameter name for "Defines the strength of an adaption in the last round. The strength will decrease to this value in last round, beginning with learning_rate_start in the first round."

See Also:

Constant Field Values

PARAMETER_ADAPTION_RADIUS_START

public static final java.lang.String PARAMETER_ADAPTION_RADIUS_START

The parameter name for "Defines the radius of the sphere around an stimulus, within an adaption occoures. This radius decreases every round, starting by adaption_radius_start in first round, to adaption_radius_end in last round."

See Also:

Constant Field Values

PARAMETER_ADAPTION_RADIUS_END

public static final java.lang.String PARAMETER_ADAPTION_RADIUS_END

The parameter name for "Defines the radius of the sphere around an stimulus, within an adaption occoures. This radius decreases every round, starting by adaption_radius_start in first round, to adaption_radius_end in last round."

See Also:

Constant Field Values

Constructor Detail

SOMDimensionalityReduction

public SOMDimensionalityReduction(OperatorDescription description)

Method Detail

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

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

getDoubleArrayFromExample

public static double[] getDoubleArrayFromExample(Example example)

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