foundryts.functions.integral

foundryts.functions.integral(method='LINEAR')

単一の時系列に対して、秒単位の積分を計算する関数を返します。

時系列内の各点 (t_i, v_i) について、その点まで（その点を含む）のすべての点の積分値を値とするティックを出力します。

積分値は、↗ リーマン和を用いて推定します。積分には引数の method を使用します。サポートされている選択肢は次のとおりです。

メソッド	説明
LHS	左端和（LHS）は、各区間の開始時点の値を合計して積分値を近似します。増加傾向では過小評価し、減少傾向では過大評価する傾向があります。初期値が区間全体を代表すると仮定しており、過去の値が合計に強く影響する場合に有用です。
RHS	右端和（RHS）は、各区間の終了時点の値を合計して積分値を近似します。増加傾向では過大評価し、減少傾向では過小評価する傾向があります。最終値が傾向を示すと仮定しており、直近の値が累積的な傾向をよりよく反映する場合に有用です。
> LINEAR （デフォルト）	台形則は、各区間の開始時点と終了時点の値を平均します。バランスのとれた近似により、過大評価や過小評価を抑えます。初期の値と直近の値の両方を考慮するため、変動する傾向に有用です。

パラメーター： method (str , 任意) – 指定された点の積分値を推定するために使用するメソッドです。有効な選択肢は上のテーブルに示されています（デフォルトは LINEAR）。
戻り値： 単一の時系列を入力として受け取り、秒単位の積分値を持つ時系列を返す関数です。
戻り値の型： (FunctionNode) -> FunctionNode

Dataframe スキーマ

列名	データ型	説明
timestamp	pandas.Timestamp	点のタイムスタンプ
value	Float	点の値

注

この関数は数値の系列にのみ適用できます。

例

Copied!1
2
3
4
5
6
7
8
9
10
11
>>> series = F.points(
...     (1000, 1.0), (3000, 3.0), (5000, 0.0), (6000, 5.0), (8000, -7.0),
...     name="series"
... )
>>> series.to_pandas()
                   timestamp  value
0 1970-01-01 00:00:00.000001    1.0
1 1970-01-01 00:00:00.000003    3.0
2 1970-01-01 00:00:00.000005    0.0
3 1970-01-01 00:00:00.000006    5.0
4 1970-01-01 00:00:00.000008   -7.0

Copied!1
2
3
4
5
6
7
8
>>> linear_integral = F.integral(method="LINEAR")(series)
>>> linear_integral.to_pandas()
                   timestamp     value
0 1970-01-01 00:00:00.000001  0.000000
1 1970-01-01 00:00:00.000003  0.000004
2 1970-01-01 00:00:00.000005  0.000007
3 1970-01-01 00:00:00.000006  0.000009
4 1970-01-01 00:00:00.000008  0.000007

Copied!1
2
3
4
5
6
7
8
>>> lhs_integral = F.integral(method="LHS")(series)
>>> lhs_integral.to_pandas()
                   timestamp     value
0 1970-01-01 00:00:00.000001  0.000000
1 1970-01-01 00:00:00.000003  0.000002
2 1970-01-01 00:00:00.000005  0.000008
3 1970-01-01 00:00:00.000006  0.000008
4 1970-01-01 00:00:00.000008  0.000018

Copied!1
2
3
4
5
6
7
8
>>> rhs_integral = F.integral(method="RHS")(series)
>>> rhs_integral.to_pandas()
                   timestamp     value
0 1970-01-01 00:00:00.000001  0.000000
1 1970-01-01 00:00:00.000003  0.000006
2 1970-01-01 00:00:00.000005  0.000006
3 1970-01-01 00:00:00.000006  0.000011
4 1970-01-01 00:00:00.000008 -0.000003

←

PREVIOUSfunctions.first_point

NEXTfunctions.interpolate

→