com.rapidminer.operator.preprocessing.series
Class MultivariateSeries2WindowExamples

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.preprocessing.series.AbstractSeriesProcessing
              com.rapidminer.operator.preprocessing.series.Series2WindowExamples
                  com.rapidminer.operator.preprocessing.series.MultivariateSeries2WindowExamples

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class MultivariateSeries2WindowExamples
extends Series2WindowExamples

This operator transforms a given example set containing series data into a new example set containing single valued examples. For this purpose, windows with a specified window and step size are moved across the series and the attribute value lying horizon values after the window end is used as label which should be predicted. In contrast to the Series2WindowExamples operator, this operator can also handle multivariate series data. In order to specify the dimension which should be predicted, one must use the parameter "label_dimension" (counting starts at 0). If you want to predict all dimensions of your multivariate series you must setup several process definitions with different label dimensions, one for each dimension.

The series data must be given as ExampleSet. The parameter "series_representation" defines how the series data is represented by the ExampleSet:

• encode_series_by_examples
: the series index variable (e.g. time) is encoded by the examples, i.e. there is a set of attributes (one for each dimension of the multivariate series) and a set of examples. Each example encodes the value vector for a new time point, each attribute value represents another dimension of the multivariate series.
• encode_series_by_attributes
: the series index variable (e.g. time) is encoded by the attributes, i.e. there is a set of examples (one for each dimension of the multivariate series) and a set of attributes. The set of attribute values for all examples encodes the value vector for a new time point, each example represents another dimension of the multivariate series.

Please note that the encoding as examples is usually more efficient with respect to the memory usage.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_ADD_INCOMPLETE_WINDOWS
static java.lang.String	PARAMETER_LABEL_ATTRIBUTE
static java.lang.String	PARAMETER_LABEL_DIMENSION

Fields inherited from class com.rapidminer.operator.preprocessing.series.Series2WindowExamples

PARAMETER_CREATE_SINGLE_ATTRIBUTES, PARAMETER_HORIZON, PARAMETER_SERIES_REPRESENTATION, PARAMETER_STEP_SIZE, PARAMETER_WINDOW_SIZE, SERIES_AS_ATTRIBUTES, SERIES_AS_EXAMPLES, SERIES_REPRESENTATIONS

Constructor Summary

MultivariateSeries2WindowExamples(OperatorDescription description)

Method Summary

Attribute	createLabel(ExampleSet exampleSet, int representation) Subclasses have to override this method.
void	fillSeriesExampleTable(MemoryExampleTable table, ExampleSet exampleSet, Attribute idAttribute, int representation, int windowWidth, int stepSize, int horizon) The given label attribute might be null.
java.lang.String	getNameForAttribute(Attribute[] originalAttributeArray, int representation, int windowWidth, int horizon, int totalCounter)
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
int[]	getValueTypes(ExampleSet exampleSet, int representation, int windowWidth)
void	performChecks(ExampleSet exampleSet, int representation, int windowWidth, int stepSize, int horizon)

Methods inherited from class com.rapidminer.operator.preprocessing.series.Series2WindowExamples

apply

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_LABEL_ATTRIBUTE

public static final java.lang.String PARAMETER_LABEL_ATTRIBUTE

See Also:

Constant Field Values

PARAMETER_LABEL_DIMENSION

public static final java.lang.String PARAMETER_LABEL_DIMENSION

See Also:

Constant Field Values

PARAMETER_ADD_INCOMPLETE_WINDOWS

public static final java.lang.String PARAMETER_ADD_INCOMPLETE_WINDOWS

See Also:

Constant Field Values

Constructor Detail

MultivariateSeries2WindowExamples

public MultivariateSeries2WindowExamples(OperatorDescription description)

Method Detail

createLabel

public Attribute createLabel(ExampleSet exampleSet,
                             int representation)
                      throws OperatorException

Description copied from class: Series2WindowExamples

Subclasses have to override this method. Might also return null in which case no label is created.

Specified by:

createLabel in class Series2WindowExamples

Throws:

OperatorException

getValueTypes

public int[] getValueTypes(ExampleSet exampleSet,
                           int representation,
                           int windowWidth)

Specified by:

getValueTypes in class Series2WindowExamples

getNameForAttribute

public java.lang.String getNameForAttribute(Attribute[] originalAttributeArray,
                                            int representation,
                                            int windowWidth,
                                            int horizon,
                                            int totalCounter)

Specified by:

getNameForAttribute in class Series2WindowExamples

performChecks

public void performChecks(ExampleSet exampleSet,
                          int representation,
                          int windowWidth,
                          int stepSize,
                          int horizon)
                   throws OperatorException

Specified by:

performChecks in class Series2WindowExamples

Throws:

OperatorException

fillSeriesExampleTable

public void fillSeriesExampleTable(MemoryExampleTable table,
                                   ExampleSet exampleSet,
                                   Attribute idAttribute,
                                   int representation,
                                   int windowWidth,
                                   int stepSize,
                                   int horizon)
                            throws OperatorException

Description copied from class: Series2WindowExamples

The given label attribute might be null.

Specified by:

fillSeriesExampleTable in class Series2WindowExamples

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 Series2WindowExamples