foundryts.Interval

class foundryts.Interval(start=None, end=None, name=None, metadata=None)

開始時間と終了時間で定義されるインターバル。

インターバルは、NodeCollection 内の time series をそれぞれのインターバルの時間範囲に分割したり、FoundryTS のインターバル関数の結果を表現したりするのに役立ちます。たとえば、foundryts.functions.time_series_search() などです。

インターバルにはオプションでメタデータを保持できます。

• パラメーター:
  • start (int | datetime | str , optional) – インターバルの開始タイムスタンプ（含む）(デフォルトは pandas..Timestamp.min)。
  • end (int | datetime | str , optional) – インターバルの終了タイムスタンプ（除く）(デフォルトは pandas..Timestamp.min)。
  • name (int | datetime | str , optional) – インターバルのオプションの名前 (デフォルトは None)。
  • metadata (Dict [str , Any ] , optional) – インターバルのオプションのメタデータ辞書 (デフォルトは None)。

例

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
>>> from foundryts import Interval
>>> interval = Interval(start='2018-01-01', end='2018-02-01', name='january', metadata={'days': 31})
# Intervalオブジェクトを作成します。開始日が2018年1月1日、終了日が2018年2月1日で、
# 名前は'january'、メタデータとして{'days': 31}が含まれています。
>>> interval
Interval(start='2018-01-01 00:00:00', end='2018-02-01 00:00:00', name='january', metadata={'days': 31})
# Intervalオブジェクトの内容を出力します。
>>> interval.name
'january'
# intervalオブジェクトの名前属性を取得します。
>>> interval.metadata['days']
31
# intervalオブジェクトのメタデータから'days'の値を取得します。

property end

終了時刻を codex_core.Timestamp として表します。

property end_codex

Interval.end() のコピー。将来的に Python ネイティブの非 codex Conjure 型を返すように移行されます。

property end_native

終了時刻を int | datetime | str として表します。

property end_ns

終了時刻をナノ秒で表します。

property metadata

メタデータ辞書を返します。

property name

インターバルの名前。

property start

開始時刻を codex_core.Timestamp として表します。

property start_codex

Interval.start() のコピー。将来的に Python ネイティブの非 codex Conjure 型を返すように移行されます。

property start_native

開始時刻を int | datetime | str として表します。

property start_ns

開始時刻をナノ秒で表します。