foundryts.functions.time_range

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

指定された時間範囲で単一の time series をフィルター処理する関数を返します。

各時間範囲は個別のシリーズとして機能します。クエリに時間範囲を設定することで、クエリは time series のすべてのポイントではなく、時間範囲内のポイントのみを読み取るため、効率が向上します。これは time series の間隔に対して操作を行う際にも有用です。

• パラメーター:
  • start (int , str , datetime.datetime , optional) – 時間範囲の開始点（含む）。整数はナノ秒数として解釈されます。より人間が読みやすい期間として、datetime.timedelta オブジェクトや pandas.Timedelta として解析される文字列を提供できます。文字列入力は pandas.to_timedelta に認識される形式に従うべきで、たとえば '1 day'、'1 hour'、'10 minutes'、'42s' などです。（デフォルトは time series の最初のポイント）
  • end (int , str , datetime.datetime , optional) – 時間範囲の終了点（排他的）。整数はナノ秒数として解釈されます。より人間が読みやすい期間として、datetime.timedelta オブジェクトや pandas.Timedelta として解析される文字列を提供できます。文字列入力は pandas.to_timedelta に認識される形式に従うべきで、たとえば '1 day'、'1 hour'、'10 minutes'、'42s' などです。（デフォルトは time series の最後のポイント）
• 戻り値: 単一の time series を入力として受け取り、フィルター処理された時間範囲を返す関数。
• 戻り値の型: (FunctionNode) -> FunctionNode

データフレームスキーマ

例

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
>>> series = F.points((1, 1.0), (101, 2.0), (200, 4.0), (201, 8.0), name="series")
# F.points関数を用いて時系列データを作成しています。各タプルは(timestamp, value)の形式です。
# 名前付き引数name="series"で、このデータシリーズに名前を付けています。

>>> series.to_pandas()
# seriesオブジェクトをpandasのDataFrameに変換しています。
# 出力はtimestamp（タイムスタンプ）とvalue（値）の2列から成るDataFrameです。
                    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
# タイムスタンプはナノ秒単位で1970年1月1日からの経過時間を示しています。

Copied!
1
2
3
4
5
6
7
8
9
>>> 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

# `F.time_range(start=200, end=202)` は、タイムスタンプの範囲を指定してデータを抽出する関数です。
# この例では、1970年1月1日のナノ秒単位の200から201までのタイムスタンプのデータを取得しています。
# `to_pandas()` メソッドを用いて、抽出されたデータをPandas DataFrame形式に変換しています。

Copied!
1
2
3
4
>>> smaller_time_range = F.time_range(start=200, end=201)(series)  # 時間範囲を絞り込む。開始時間は200、終了時間は201。
>>> smaller_time_range.to_pandas()  # 絞り込んだ時間範囲をPandasデータフレームに変換する。
                    timestamp  value
0 1970-01-01 00:00:00.000000200    4.0

Copied!
1
2
3
4
5
6
7
8
9
10
11
>>> unbounded_start_range = F.time_range(end=201)(series)
# `F.time_range(end=201)` は、開始時刻が無制限で、終了時刻が201ナノ秒の範囲を表す時間範囲を作成します。
# この時間範囲が `series` に適用されます。

>>> unbounded_start_range.to_pandas()
# `to_pandas()` メソッドは、時間範囲を 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

このコードは、F.time_range 関数を使用して、特定の開始時刻からの時系列データを取得しています。start=101 は、ナノ秒単位で指定された開始時刻を表しています。この例では、unbounded_end_range という変数に取得した時系列データを格納し、そのデータを to_pandas() メソッドを使用して Pandas データフレーム形式に変換しています。結果として、timestamp 列と value 列を持つデータフレームが得られています。