foundryts.functions.scatter

foundryts.functions.scatter(start=None, end=None, before='NONE', internal='LINEAR', after='NONE', regression=None, regression_fit=None)

ちょうど2つの時系列について、時刻を揃えた (x,y) 点のリストを生成する関数を返します。

散布図は (x,y) 座標で構成されます。指定された2つの時系列について、(x,y) 座標は、タイムスタンプが一致するそれぞれの時系列の点で構成されます。元の時系列のタイムスタンプが一致しない点については、そのタイムスタンプに点がない時系列に対して、設定された補間方法が使用されます。

internal、before、after でサポートされる補間方法については、interpolate() を参照してください。

また、回帰関数を渡して、グラフ上の点に対する最良適合線を求めることもできます。

パラメーター：
- start (int | datetime | str , 任意) – 点の時刻を揃える範囲の開始タイムスタンプ（この値を含む）（デフォルトは pandas.Timestamp.min）
- end (int | datetime | str , 任意) – 点の時刻を揃える範囲の終了タイムスタンプ（この値を含まない）（デフォルトは pandas.Timestamp.max）
- before (str | List [str ] , 任意) – 最初の点の時刻を揃えるために使用する補間方法の名前です。 interpolate() で利用可能な補間方法を使用します（デフォルトは NONE）。
- internal (str | List [str ] , 任意) – 時系列内のすべての点の時刻を揃えるために使用する補間方法の名前です。 interpolate() で利用可能な補間方法を使用します（デフォルトは LINEAR）。
- after (str | List [str ] , 任意) – 最後の点の時刻を揃えるために使用する補間方法の名前です。 interpolate() で利用可能な補間方法を使用します（デフォルトは NONE）。
- regression (linear_regression() | polynomial_regression() | exponential_regression(), 任意) – いずれかの回帰関数の出力です。2つの入力時系列間の最良適合線の点（およびその他の関連メトリクス）が得られます（デフォルトでは回帰は行われません）。
戻り値： ちょうど2つの時系列を入力として受け取り、散布図用に時刻を揃えた点を返す関数を返します。結果のデータフレームの各行は、時刻を揃えた点を表します。
戻り値の型： (NodeCollection) -> SummarizerNode

データフレームのスキーマ

列名	データ型	説明
is_truncated	bool	このフィールドは非推奨であり、無視してください。大きな時系列に対して出力が切り詰められたかどうかを示します。
points.first_value	Float	1つ目の時系列の点の値。
points.second_value	Float	2つ目の時系列の点の値。
points.timestamp	datetime	点のタイムスタンプ。
regression.*	Float	回帰関数からの列（回帰が使用される場合）。

例

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
>>> series_1 = F.points((11, 21.0), (13, 23.0), (15, 25.0), (17, 27.0), name="series-1")
>>> series_2 = F.points((11, 21.0), (13, 23.0), (17, 37.0), (37, 47.0), name="series-2")
>>> series_1.to_pandas()
                      timestamp  value
0 1970-01-01 00:00:00.000000011   21.0
1 1970-01-01 00:00:00.000000013   23.0
2 1970-01-01 00:00:00.000000015   25.0
3 1970-01-01 00:00:00.000000017   27.0
>>> series_2.to_pandas()
                      timestamp  value
0 1970-01-01 00:00:00.000000011   21.0
1 1970-01-01 00:00:00.000000013   23.0
2 1970-01-01 00:00:00.000000017   37.0
3 1970-01-01 00:00:00.000000037   47.0
>>> nc = NodeCollection([series_1, series_2])

Copied!1
2
3
4
5
6
7
8
9
10
11
12
>>> scatter_plot = F.scatter( # 補間を使用した散布図
...     before="NEAREST",
...     internal="LINEAR",
...     after="NEAREST",
... )(nc)
>>> scatter_plot.to_pandas()
    is_truncated  points.first_value  points.second_value              points.timestamp
    0         False                21.0                 21.0 1970-01-01 00:00:00.000000011
    1         False                23.0                 23.0 1970-01-01 00:00:00.000000013
    2         False                25.0                 30.0 1970-01-01 00:00:00.000000015
    3         False                27.0                 37.0 1970-01-01 00:00:00.000000017
    4         False                27.0                 47.0 1970-01-01 00:00:00.000000037

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
>>> lin_regression_scatter_plot = F.scatter(
...     before="NEAREST",
...     internal="LINEAR",
...     after="NEAREST",
...     regression=F.linear_regression(),
... )(nc)
>>> lin_regression_scatter_plot.to_pandas()
   is_truncated  points.first_value  points.second_value              points.timestamp  regression.max_bounds.first_value  regression.max_bounds.second_value  regression.min_bounds.first_value  regression.min_bounds.second_value  regression.regression_fit_function.linear_regression_fit.intercept  regression.regression_fit_function.linear_regression_fit.slope  regression.regression_fit_function.linear_regression_fit.statistics.rsquared
0         False                21.0                 21.0 1970-01-01 00:00:00.000000011                               27.0                                47.0                               21.0                                21.0                                         -59.926471                                                            3.720588                                                        0.827161
1         False                23.0                 23.0 1970-01-01 00:00:00.000000013                               27.0                                47.0                               21.0                                21.0                                         -59.926471                                                            3.720588                                                        0.827161
2         False                25.0                 30.0 1970-01-01 00:00:00.000000015                               27.0                                47.0                               21.0                                21.0                                         -59.926471                                                            3.720588                                                        0.827161
3         False                27.0                 37.0 1970-01-01 00:00:00.000000017                               27.0                                47.0                               21.0                                21.0                                         -59.926471                                                            3.720588                                                        0.827161
4         False                27.0                 47.0 1970-01-01 00:00:00.000000037                               27.0                                47.0                               21.0                                21.0                                         -59.926471                                                            3.720588                                                        0.827161

←

PREVIOUSfunctions.scale

NEXTfunctions.series

→