foundryts.functions.value_shift

foundryts.functions.value_shift(delta)

指定されたデルタで単一の time series のすべての値をシフトする関数を返します。

ポイント (timestamp, value) を持つ元の time series を delta でシフトすると、結果として得られる値シフトされた time series はポイント (timestamp, value + delta) を持ちます。

パラメーター: delta (int) – 各ポイントの値をシフトする量。
戻り値: 単一の time series を入力として受け取り、値シフトされた time series を返す関数。
戻り値の型: (FunctionNode) -> FunctionNode

Dataframe スキーマ

列名	タイプ	説明
timestamp	pandas.Timestamp	ポイントのタイムスタンプ
value	float	ポイントのシフトされた値

参照してください

timestamp_scale(), time_shift()

注意

この関数は数値の series にのみ適用可能です。

例

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
>>> series = F.points(
...     (100, 0.0),  # タイムスタンプ100ナノ秒時点の値は0.0
...     (200, float("inf")),  # タイムスタンプ200ナノ秒時点の値は無限大 (inf)
...     (300, 3.14159),  # タイムスタンプ300ナノ秒時点の値は円周率に近い3.14159
...     (2147483647, 1.0),  # タイムスタンプ約2.147秒時点の値は1.0
...     name="series"  # シリーズの名前を"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

このコードは、特定の時間点での数値データを持つポイント系列を作成し、それをPandasデータフレームに変換しています。タイムスタンプはナノ秒単位で表現されており、Unixエポック（1970年1月1日00:00:00 UTC）からの経過時間を示しています。

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

このコードは、F.value_shift(3.0)関数を使用して、seriesの各要素に3.0を加算した新しいシリーズを生成しています。value_shifted.to_pandas()を呼び出すことで、シフトされた値が含まれるPandasデータフレーム形式で出力されます。ここで、timestampはデータのタイムスタンプを示し、value列にはシフトされた数値が表示されています。infは無限大を示しているため、元のデータ中に特異な値が含まれている可能性があります。

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

このコードは、series に含まれる値を -3.0 だけシフトさせる操作を行っています。その結果を Pandas データフレーム形式で表示しています。