com.rapidminer.operator.features.construction
Class FeatureGenerationOperator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.features.AbstractFeatureProcessing
              com.rapidminer.operator.features.construction.AbstractFeatureConstruction
                  com.rapidminer.operator.features.construction.FeatureGenerationOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class FeatureGenerationOperator
extends AbstractFeatureConstruction

This operator generates new user specified features. The new features are specified by their function names (prefix notation) and their arguments using the names of existing features.
Legal function names include +, -, etc. and the functions norm, sin, cos, tan, atan, exp, log, min, max, floor, ceil, round, sqrt, abs, and pow. Constant values can be defined by "const[value]()" where value is the desired value. Do not forget the empty round brackets. Example: +(a1, -(a2, a3)) will calculate the sum of the attribute a1 and the difference of the attributes a2 and a3.
Features are generated in the following order:

1. Features specified by the file referenced by the parameter "filename" are generated
2. Features specified by the parameter list "functions" are generated
3. If "keep_all" is false, all of the old attributes are removed now

The list of supported functions include +, -, etc. and the functions sin, cos, tan, atan, exp, log, min, max, floor, ceil, round, sqrt, abs, sgn, pow.

Author:

Simon Fischer, Ingo Mierswa

See Also:

FeatureGenerator

Field Summary

static java.lang.String	PARAMETER_FILENAME The parameter name for "Create the attributes listed in this file (written by an AttributeConstructionsWriter).
static java.lang.String	PARAMETER_FUNCTIONS The parameter name for "List of functions to generate.
static java.lang.String	PARAMETER_KEEP_ALL The parameter name for "If set to true, all the original attributes are kept, otherwise they are removed from the example set.

Constructor Summary

FeatureGenerationOperator(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_FILENAME

public static final java.lang.String PARAMETER_FILENAME

The parameter name for "Create the attributes listed in this file (written by an AttributeConstructionsWriter)."

See Also:

Constant Field Values

PARAMETER_FUNCTIONS

public static final java.lang.String PARAMETER_FUNCTIONS

The parameter name for "List of functions to generate."

See Also:

Constant Field Values

PARAMETER_KEEP_ALL

public static final java.lang.String PARAMETER_KEEP_ALL

The parameter name for "If set to true, all the original attributes are kept, otherwise they are removed from the example set."

See Also:

Constant Field Values

Constructor Detail

FeatureGenerationOperator

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