io.warp10.script.functions

Class STL

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.GTSStackFunction

io.warp10.script.functions.STL

All Implemented Interfaces:

WarpScriptStackFunction

public class STL
extends GTSStackFunction

Apply Seasonal Trend decomposition based on Loess procedure

See Also:

http://www.wessa.net/download/stl.pdf

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BANDWIDTH_L_PARAM
static java.lang.String	BANDWIDTH_P_PARAM
static java.lang.String	BANDWIDTH_S_PARAM
static java.lang.String	BANDWIDTH_T_PARAM
static java.lang.String	DEGREE_L_PARAM
static java.lang.String	DEGREE_P_PARAM
static java.lang.String	DEGREE_S_PARAM
static java.lang.String	DEGREE_T_PARAM
static java.lang.String	PERIOD_PARAM
static java.lang.String	PRECISION_PARAM
static java.lang.String	ROBUST_PARAM
static java.lang.String	ROBUSTNESS_PARAM
static java.lang.String	SPEED_L_PARAM
static java.lang.String	SPEED_P_PARAM
static java.lang.String	SPEED_S_PARAM
static java.lang.String	SPEED_T_PARAM

Constructor Summary

Constructors

Constructor and Description
STL(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	doGtsOp(java.util.Map<java.lang.String,java.lang.Object> params, GeoTimeSerie gts)
protected java.lang.Object	gtsOp(java.util.Map<java.lang.String,java.lang.Object> params, GeoTimeSerie gts) Method to apply to individual GTS instances
protected java.util.Map<java.lang.String,java.lang.Object>	retrieveParameters(WarpScriptStack stack) The function STL expects on top of the stack: - a gts or list of gts - followed by a map with the set {key:value} as {PARAM:VALUE} At least PERIOD must be set For each pair "key":value in the map where "key" is a word, every parameter starting with "key" will be set to value.

Methods inherited from class io.warp10.script.GTSStackFunction

apply

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PERIOD_PARAM

public static final java.lang.String PERIOD_PARAM

See Also:

Constant Field Values

PRECISION_PARAM

public static final java.lang.String PRECISION_PARAM

See Also:

Constant Field Values

ROBUSTNESS_PARAM

public static final java.lang.String ROBUSTNESS_PARAM

See Also:

Constant Field Values

ROBUST_PARAM

public static final java.lang.String ROBUST_PARAM

See Also:

Constant Field Values

BANDWIDTH_S_PARAM

public static final java.lang.String BANDWIDTH_S_PARAM

See Also:

Constant Field Values

DEGREE_S_PARAM

public static final java.lang.String DEGREE_S_PARAM

See Also:

Constant Field Values

SPEED_S_PARAM

public static final java.lang.String SPEED_S_PARAM

See Also:

Constant Field Values

BANDWIDTH_L_PARAM

public static final java.lang.String BANDWIDTH_L_PARAM

See Also:

Constant Field Values

DEGREE_L_PARAM

public static final java.lang.String DEGREE_L_PARAM

See Also:

Constant Field Values

SPEED_L_PARAM

public static final java.lang.String SPEED_L_PARAM

See Also:

Constant Field Values

BANDWIDTH_T_PARAM

public static final java.lang.String BANDWIDTH_T_PARAM

See Also:

Constant Field Values

DEGREE_T_PARAM

public static final java.lang.String DEGREE_T_PARAM

See Also:

Constant Field Values

SPEED_T_PARAM

public static final java.lang.String SPEED_T_PARAM

See Also:

Constant Field Values

BANDWIDTH_P_PARAM

public static final java.lang.String BANDWIDTH_P_PARAM

See Also:

Constant Field Values

DEGREE_P_PARAM

public static final java.lang.String DEGREE_P_PARAM

See Also:

Constant Field Values

SPEED_P_PARAM

public static final java.lang.String SPEED_P_PARAM

See Also:

Constant Field Values

Constructor Detail

STL

public STL(java.lang.String name)

Method Detail

retrieveParameters

protected java.util.Map<java.lang.String,java.lang.Object> retrieveParameters(WarpScriptStack stack)
                                                                       throws WarpScriptException

The function STL expects on top of the stack: - a gts or list of gts - followed by a map with the set {key:value} as {PARAM:VALUE} At least PERIOD must be set For each pair "key":value in the map where "key" is a word, every parameter starting with "key" will be set to value. All unspecified parameters will be set to their default.

Specified by:

retrieveParameters in class GTSStackFunction

Throws:

WarpScriptException

gtsOp

protected java.lang.Object gtsOp(java.util.Map<java.lang.String,java.lang.Object> params,
                                 GeoTimeSerie gts)
                          throws WarpScriptException

Description copied from class: GTSStackFunction

Method to apply to individual GTS instances

Specified by:

gtsOp in class GTSStackFunction

Throws:

WarpScriptException

doGtsOp

public java.lang.Object doGtsOp(java.util.Map<java.lang.String,java.lang.Object> params,
                                GeoTimeSerie gts)
                         throws WarpScriptException

Throws:

WarpScriptException