com.rapidminer.operator.preprocessing.series
Class UnivariateSeries2WindowExamples

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.UnivariateSeries2WindowExamples

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class UnivariateSeries2WindowExamples
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 series value lying horizon values after the window end is used as label which should be predicted. This operator can only be used for univariate series prediction. For the multivariate case, please use the operator MultivariateSeries2WindowExamples.

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 single attribute and a set of examples. Each example encodes the value for a new time point.
• encode_series_by_attributes
: the series index variable (e.g. time) is encoded by the attributes, i.e. there is a (set of) examples and a set of attributes. Each attribute value encodes the value for a new time point. If there is more than one example, the windowing is performed for each example independently and all resulting window examples are merged into a complete example set.

Please note that the encoding as examples is usually more efficient with respect to the memory usage. To ensure backward compatibility, the default representation is, however, set to time_as_attributes.

Author:

Ingo Mierswa

Field Summary

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

UnivariateSeries2WindowExamples(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)
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, getParameterTypes

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

Constructor Detail

UnivariateSeries2WindowExamples

public UnivariateSeries2WindowExamples(OperatorDescription description)

Method Detail

getValueTypes

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

Specified by:

getValueTypes in class Series2WindowExamples

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

performChecks

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

Specified by:

performChecks in class Series2WindowExamples

Throws:

OperatorException

getNameForAttribute

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

Specified by:

getNameForAttribute in class Series2WindowExamples

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