foundryts.functions.value_shift

foundryts.functions.value_shift(delta)

Returns a function that shifts all values of a single time series by the specified delta.

For a source time series with points (timestamp, value), upon shifting by delta, the resulting value-shifted time series will have points (timestamp, value + delta).

• Parameters: delta (int) – The amount by which to shift the value of each point.
• Returns: A function that accepts a single time series as input and returns the value-shifted time series.
• Return type: (FunctionNode) -> FunctionNode

Dataframe schema

Examples

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
>>> series = F.points(
...     (100, 0.0),
...     (200, float("inf")),
...     (300, 3.14159),
...     (2147483647, 1.0),
...     name="series"
... )
>>> series.to_pandas()
                      timestamp    value
0 1970-01-01 00:00:00.000000100  0.00000
1 1970-01-01 00:00:00.000000200      inf
2 1970-01-01 00:00:00.000000300  3.14159
3 1970-01-01 00:00:02.147483647  1.00000

Copied!
1
2
3
4
5
6
7
>>> value_shifted = F.value_shift(3.0)(series)
>>> value_shifted.to_pandas()
                      timestamp    value
0 1970-01-01 00:00:00.000000100  3.00000
1 1970-01-01 00:00:00.000000200      inf
2 1970-01-01 00:00:00.000000300  6.14159
3 1970-01-01 00:00:02.147483647  4.00000

Copied!
1
2
3
4
5
6
7
>>> negative_value_shifted = F.value_shift(-3.0)(series)
>>> negative_value_shifted.to_pandas()
                      timestamp    value
0 1970-01-01 00:00:00.000000100 -3.00000
1 1970-01-01 00:00:00.000000200      inf
2 1970-01-01 00:00:00.000000300  0.14159
3 1970-01-01 00:00:02.147483647 -2.00000