com.rapidminer.operator.preprocessing.series
Class Series2WindowExamples

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

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

Direct Known Subclasses:

MultivariateSeries2WindowExamples, UnivariateSeries2WindowExamples

public abstract class Series2WindowExamples
extends AbstractSeriesProcessing

This is the superclass for all series to example transformation operators based on windowing.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_CREATE_SINGLE_ATTRIBUTES The parameter name for "Indicates if the result example set should use single attributes instead of series attributes.
static java.lang.String	PARAMETER_HORIZON The parameter name for "The prediction horizon, i.e. the distance between the last window value and the value to predict.
static java.lang.String	PARAMETER_SERIES_REPRESENTATION The parameter name for "This parameter defines how the series values will be represented.
static java.lang.String	PARAMETER_STEP_SIZE The parameter name for "The step size of the used windows, i.e. the distance between the first values"
static java.lang.String	PARAMETER_WINDOW_SIZE The parameter name for "The width of the used windows.
static int	SERIES_AS_ATTRIBUTES
static int	SERIES_AS_EXAMPLES
static java.lang.String[]	SERIES_REPRESENTATIONS

Constructor Summary

Series2WindowExamples(OperatorDescription description)

Method Summary

ExampleSet	apply(ExampleSet exampleSet) Delegate for the apply method.
abstract Attribute	createLabel(ExampleSet exampleSet, int representation) Subclasses have to override this method.
abstract void	fillSeriesExampleTable(MemoryExampleTable table, ExampleSet exampleSet, Attribute idAttribute, int representation, int width, int stepSize, int horizon) The given label attribute might be null.
abstract 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.
abstract int[]	getValueTypes(ExampleSet exampleSet, int representation, int windowWidth)
abstract void	performChecks(ExampleSet exampleSet, int representation, int width, int stepSize, int horizon)

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_SERIES_REPRESENTATION

public static final java.lang.String PARAMETER_SERIES_REPRESENTATION

The parameter name for "This parameter defines how the series values will be represented."

See Also:

Constant Field Values

PARAMETER_HORIZON

public static final java.lang.String PARAMETER_HORIZON

The parameter name for "The prediction horizon, i.e. the distance between the last window value and the value to predict."

See Also:

Constant Field Values

PARAMETER_WINDOW_SIZE

public static final java.lang.String PARAMETER_WINDOW_SIZE

The parameter name for "The width of the used windows."

See Also:

Constant Field Values

PARAMETER_STEP_SIZE

public static final java.lang.String PARAMETER_STEP_SIZE

The parameter name for "The step size of the used windows, i.e. the distance between the first values"

See Also:

Constant Field Values

PARAMETER_CREATE_SINGLE_ATTRIBUTES

public static final java.lang.String PARAMETER_CREATE_SINGLE_ATTRIBUTES

The parameter name for "Indicates if the result example set should use single attributes instead of series attributes."

See Also:

Constant Field Values

SERIES_REPRESENTATIONS

public static final java.lang.String[] SERIES_REPRESENTATIONS

SERIES_AS_EXAMPLES

public static final int SERIES_AS_EXAMPLES

See Also:

Constant Field Values

SERIES_AS_ATTRIBUTES

public static final int SERIES_AS_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

Series2WindowExamples

public Series2WindowExamples(OperatorDescription description)

Method Detail

performChecks

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

Throws:

OperatorException

fillSeriesExampleTable

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

The given label attribute might be null.

Throws:

OperatorException

getValueTypes

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

getNameForAttribute

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

createLabel

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

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

Throws:

OperatorException

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