foundryts.functions.time_shift

foundryts.functions.time_shift(duration)

Returns a function that shifts all timestamps of a single time series forward or backward in time by the specified duration.

For a source time series with points (timestamp, value), upon shifting by duration, the resulting time-shifted time series will have points (timestamp + duration, value). Positive duration shift values will move the timestamps forward into the future and negative duration values will move the timestamps backwards into the past.

• Parameters: duration (int , datetime.timedelta , str) – The amount of time to shift the timestamps forward or backward, specified as an integer, a datetime.timedelta object, or a string. Integers are interpreted as the number of nanoseconds. For more human-readable durations, you can provide a datetime.timedelta object or a string that will be parsed as a pandas.Timedelta. String inputs should follow the format recognized by pandas.to_timedelta, such as ‘1 day’, ‘1 hour’, ‘10 minutes’, or ’42s’.
• Returns: A function that accepts a single time series as input and returns the time-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
>>> time_shifted = F.time_shift(1000)(series)
>>> time_shifted.to_pandas()
                      timestamp    value
0 1970-01-01 00:00:00.000001100  0.00000
1 1970-01-01 00:00:00.000001200      inf
2 1970-01-01 00:00:00.000001300  3.14159
3 1970-01-01 00:00:02.147484647  1.00000