foundryts.Interval¶

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

An interval defined by start and end time.

Intervals are useful for splitting time series in a NodeCollection to time ranges for each interval or for representing results of FoundryTS interval functions such as foundryts.functions.time_series_search().

Intervals can hold optional metadata.

Parameters:
start (int | datetime | str , optional) – The start timestamp (inclusive) of the interval (default is pandas..Timestamp.min).
end (int | datetime | str , optional) – The end timestamp (exclusive) of the interval (default is pandas..Timestamp.min).
name (int | datetime | str , optional) – Optional name for the interval (default is None).
metadata (Dict [str , Any ] , optional) – Optional metatadata dictionary for the interval (default is None).

Examples¶

>>> from foundryts import Interval
>>> interval = Interval(start='2018-01-01', end='2018-02-01', name='january', metadata={'days': 31})
>>> interval
Interval(start='2018-01-01 00:00:00', end='2018-02-01 00:00:00', name='january', metadata={'days': 31})
>>> interval.name
'january'
>>> interval.metadata['days']
31

property end¶

End time as codex_core.Timestamp.

property end_codex¶

Copy of Interval.end() which will be migrated to return Python native, non-codex Conjure types in the future.

property end_native¶

End time as int | datetime | str

property end_ns¶

End time in nanoseconds.

property metadata¶

Return metadata dictionary.

property name¶

Name of the interval.

property start¶

Start time as codex_core.Timestamp.

property start_codex¶

Copy of Interval.start() which will be migrated to return Python native, non-codex Conjure types in the future.

property start_native¶

Start time as int | datetime | str

property start_ns¶

Start time in nanoseconds.

中文翻译¶

foundryts.Interval¶

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

由开始时间和结束时间定义的时间区间(Interval)。

区间(Interval)可用于将NodeCollection中的时间序列拆分为每个区间对应的时间范围，或用于表示FoundryTS区间函数（如foundryts.functions.time_series_search()）的结果。

区间(Interval)可以包含可选的元数据(metadata)。

参数说明：
start (int | datetime | str , 可选) – 区间的开始时间戳（包含），默认值为 pandas..Timestamp.min。
end (int | datetime | str , 可选) – 区间的结束时间戳（不包含），默认值为 pandas..Timestamp.min。
name (int | datetime | str , 可选) – 区间的可选名称，默认值为 None。
metadata (Dict [str , Any ] , 可选) – 区间的可选元数据字典，默认值为 None。

示例¶

>>> from foundryts import Interval
>>> interval = Interval(start='2018-01-01', end='2018-02-01', name='january', metadata={'days': 31})
>>> interval
Interval(start='2018-01-01 00:00:00', end='2018-02-01 00:00:00', name='january', metadata={'days': 31})
>>> interval.name
'january'
>>> interval.metadata['days']
31

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¶

以纳秒为单位返回开始时间。