BaseItem#

class osekit.core_api.base_item.BaseItem(file: TFile | None = None, begin: Timestamp | None = None, end: Timestamp | None = None)#

Base class for the Item objects.

An Item correspond to a portion of a File object.

Initialize an BaseItem from a File and begin/end timestamps.

Parameters#

file: TFile

The File in which this Item belongs.

begin: pandas.Timestamp (optional)

The timestamp at which this item begins. It is defaulted or maxed to the File begin.

end: pandas.Timestamp (optional)

The timestamp at which this item ends. It is defaulted or mined to the File end.

get_value() ndarray#

Get the values from the File between the begin and stop timestamps.

If the Item is empty, return a single 0.

property is_empty: bool#

Return True if no File is attached to this Item.