com.rapidminer.operator.preprocessing.series.filter
Class DifferentiateSeries

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.preprocessing.series.AbstractSeriesProcessing
              com.rapidminer.operator.preprocessing.series.filter.DifferentiateSeries

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class DifferentiateSeries
extends AbstractSeriesProcessing

This operator extracts changes from a numerical time series by comparing actual series values with past (lagged) values. The lag can be specifed by setting the parameter lag. Depending on the mode set in the parameter change_mode the following properties can be extracted:

• a boolean flag indicating whether the series value has changed compared to the lagged value
• a nominal value indicating in what direction the value has changed compared to the lagged value
• the difference between the actual and lagged values
• the ratio of the actual and lagged values
• the natural logarithm of the ratio
• the percentaged change (i.e. the ratio of the actual and lagged values minus 1 expressed in per cent).

Author:

Tobias Malbrecht

Field Summary

static int	CHANGE_MODE_BOOLEAN
static int	CHANGE_MODE_DIFFERENCE
static int	CHANGE_MODE_DIRECTION
static int	CHANGE_MODE_LN_RATIO
static int	CHANGE_MODE_PERCENTAGE
static int	CHANGE_MODE_RATIO
static java.lang.String[]	CHANGE_MODES
static java.lang.String	PARAMETER_ATTRIBUTE_NAME
static java.lang.String	PARAMETER_CHANGE
static java.lang.String	PARAMETER_KEEP_ORIGINAL_ATTRIBUTE
static java.lang.String	PARAMETER_LAG

Constructor Summary

DifferentiateSeries(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_ATTRIBUTE_NAME

public static final java.lang.String PARAMETER_ATTRIBUTE_NAME

See Also:

Constant Field Values

PARAMETER_CHANGE

public static final java.lang.String PARAMETER_CHANGE

See Also:

Constant Field Values

CHANGE_MODES

public static final java.lang.String[] CHANGE_MODES

CHANGE_MODE_BOOLEAN

public static final int CHANGE_MODE_BOOLEAN

See Also:

Constant Field Values

CHANGE_MODE_DIRECTION

public static final int CHANGE_MODE_DIRECTION

See Also:

Constant Field Values

CHANGE_MODE_DIFFERENCE

public static final int CHANGE_MODE_DIFFERENCE

See Also:

Constant Field Values

CHANGE_MODE_RATIO

public static final int CHANGE_MODE_RATIO

See Also:

Constant Field Values

CHANGE_MODE_LN_RATIO

public static final int CHANGE_MODE_LN_RATIO

See Also:

Constant Field Values

CHANGE_MODE_PERCENTAGE

public static final int CHANGE_MODE_PERCENTAGE

See Also:

Constant Field Values

PARAMETER_LAG

public static final java.lang.String PARAMETER_LAG

See Also:

Constant Field Values

PARAMETER_KEEP_ORIGINAL_ATTRIBUTE

public static final java.lang.String PARAMETER_KEEP_ORIGINAL_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

DifferentiateSeries

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