com.rapidminer.operator.preprocessing
Class NoiseOperator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.preprocessing.AbstractDataProcessing
              com.rapidminer.operator.preprocessing.NoiseOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class NoiseOperator
extends AbstractDataProcessing

This operator adds random attributes and white noise to the data. New random attributes are simply filled with random data which is not correlated to the label at all. Additionally, this operator might add noise to the label attribute or to the regular attributes. In case of a numerical label the given label_noise is the percentage of the label range which defines the standard deviation of normal distributed noise which is added to the label attribute. For nominal labels the parameter label_noise defines the probability to randomly change the nominal label value. In case of adding noise to regular attributes the parameter default_attribute_noise simply defines the standard deviation of normal distributed noise without using the attribute value range. Using the parameter list it is possible to set different noise levels for different attributes. However, it is not possible to add noise to nominal attributes.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_DEFAULT_ATTRIBUTE_NOISE The parameter name for "The standard deviation of the default attribute noise.
static java.lang.String	PARAMETER_LABEL_NOISE The parameter name for "Add this percentage of a numerical label range as a normal distributed noise or probability for a nominal label change.
static java.lang.String	PARAMETER_LINEAR_FACTOR The parameter name for "Linear factor multiplicated with the values of each random attribute"
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_NOISE The parameter name for "List of noises for each attributes.
static java.lang.String	PARAMETER_OFFSET The parameter name for "Offset added to the values of each random attribute"
static java.lang.String	PARAMETER_RANDOM_ATTRIBUTES The parameter name for "Adds this number of random attributes.

Constructor Summary

NoiseOperator(OperatorDescription description)

Method Summary

ExampleSet	apply(ExampleSet exampleSet) Delegate for the apply method.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.AbstractExampleSetProcessing

apply, getInputClasses, getOutputClasses

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_RANDOM_ATTRIBUTES

public static final java.lang.String PARAMETER_RANDOM_ATTRIBUTES

The parameter name for "Adds this number of random attributes."

See Also:

Constant Field Values

PARAMETER_LABEL_NOISE

public static final java.lang.String PARAMETER_LABEL_NOISE

The parameter name for "Add this percentage of a numerical label range as a normal distributed noise or probability for a nominal label change."

See Also:

Constant Field Values

PARAMETER_DEFAULT_ATTRIBUTE_NOISE

public static final java.lang.String PARAMETER_DEFAULT_ATTRIBUTE_NOISE

The parameter name for "The standard deviation of the default attribute noise."

See Also:

Constant Field Values

PARAMETER_NOISE

public static final java.lang.String PARAMETER_NOISE

The parameter name for "List of noises for each attributes."

See Also:

Constant Field Values

PARAMETER_OFFSET

public static final java.lang.String PARAMETER_OFFSET

The parameter name for "Offset added to the values of each random attribute"

See Also:

Constant Field Values

PARAMETER_LINEAR_FACTOR

public static final java.lang.String PARAMETER_LINEAR_FACTOR

The parameter name for "Linear factor multiplicated with the values of each random attribute"

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

NoiseOperator

public NoiseOperator(OperatorDescription description)

Method Detail

apply

public ExampleSet apply(ExampleSet exampleSet)
                 throws OperatorException

Description copied from class: AbstractExampleSetProcessing

Delegate for the apply method. In most cases, the returned example set will be the same as the example set or a modified clone.

Specified by:

apply in class AbstractExampleSetProcessing

Throws:

OperatorException

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