foundryts.functions.time_range

foundryts.functions.time_range(start=None, end=None)

単一の時系列を指定した時間範囲に絞り込む関数を返します。

各時間範囲は個別の時系列として扱われます。クエリに時間範囲を設定すると、 時系列のすべてのポイントではなく、その時間範囲内のポイントのみを読み取るため、クエリの効率が向上します。 これは、時系列の区間に対して操作を行う場合にも便利です。

• パラメーター：
  • start (int , str , datetime.datetime , 任意) – 時間範囲の開始ポイント（この値を含む）。整数はナノ秒数として解釈されます。より 人が読みやすい期間を指定するには、datetime.timedelta オブジェクト、または pandas.Timedelta としてパースされる文字列を指定できます。文字列の入力は、「1 day」、 「1 hour」、「10 minutes」、「42s」など、pandas.to_timedelta が認識する形式に従う必要があります。（デフォルトは時系列の最初のポイントです）
  • end (int , str , datetime.datetime , 任意) – 時間範囲の終了ポイント（この値を含まない）。整数はナノ秒数として解釈されます。より 人が読みやすい期間を指定するには、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
>>> series = F.points((1, 1.0), (101, 2.0), (200, 4.0), (201, 8.0), name="series")
>>> series.to_pandas()
                    timestamp  value
0 1970-01-01 00:00:00.000000001    1.0
1 1970-01-01 00:00:00.000000101    2.0
2 1970-01-01 00:00:00.000000200    4.0
3 1970-01-01 00:00:00.000000201    8.0

Copied!
1
2
3
4
5
>>> time_range = F.time_range(start=200, end=202)(series)
>>> time_range.to_pandas()
                      timestamp  value
0 1970-01-01 00:00:00.000000200    4.0
1 1970-01-01 00:00:00.000000201    8.0

Copied!
1
2
3
4
>>> smaller_time_range = F.time_range(start=200, end=201)(series)
>>> smaller_time_range.to_pandas()
                    timestamp  value
0 1970-01-01 00:00:00.000000200    4.0

Copied!
1
2
3
4
5
6
>>> unbounded_start_range = F.time_range(end=201)(series)
>>> unbounded_start_range.to_pandas()
                      timestamp  value
0 1970-01-01 00:00:00.000000001    1.0
1 1970-01-01 00:00:00.000000101    2.0
2 1970-01-01 00:00:00.000000200    4.0

Copied!
1
2
3
4
5
6
>>> unbounded_end_range = F.time_range(start=101)(series)
>>> unbounded_end_range.to_pandas()
                      timestamp  value
0 1970-01-01 00:00:00.000000101    2.0
1 1970-01-01 00:00:00.000000200    4.0
2 1970-01-01 00:00:00.000000201    8.0