foundryts.functions.time_shift

foundryts.functions.time_shift(duration)

単一の時系列のすべてのタイムスタンプを、指定した期間だけ未来または過去に移動する関数を返します。

点 (timestamp, value) を持つソース時系列を duration だけ移動すると、 移動後の時系列の点は (timestamp + duration, value) になります。 duration の値が正の場合はタイムスタンプが未来に移動し、duration の値が負の場合は タイムスタンプが過去に移動します。

• パラメーター： duration (int , datetime.timedelta , str) – タイムスタンプを未来または過去に移動する時間の長さです。整数、 datetime.timedelta オブジェクト、または文字列で指定します。整数はナノ秒数として解釈されます。より 読みやすい形式で期間を指定するには、datetime.timedelta オブジェクト、または pandas.Timedelta としてパースされる文字列を指定できます。文字列の入力は、「1 day」、 「1 hour」、「10 minutes」、「42s」など、pandas.to_timedelta が認識する形式に従う必要があります。
• 戻り値： 単一の時系列を入力として受け取り、タイムスタンプを移動した時系列を返す関数です。
• 戻り値の型： (FunctionNode) -> FunctionNode

Dataframe スキーマ

例

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