Skip to content

temporian.EventSet.calendar_year #

calendar_year(
    tz: Union[str, float, int] = 0
) -> EventSetOrNode

Obtains the year the timestamps in an EventSet's sampling are in.

Features in the input are ignored, only the timestamps are used and they must be unix timestamps (is_unix_timestamp=True).

By default, the timezone is UTC unless the tz argument is specified, as an offset in hours or a timezone name. See EventSet.calendar_hour() for an example using timezones.

Usage example 
>>> a = tp.event_set(
...    timestamps=["2021-02-04", "2022-02-20", "2023-03-01", "2023-05-07"],
...    name='random_moments'
... )
>>> b = a.calendar_year()
>>> b
indexes: ...
features: [('calendar_year', int32)]
events:
    (4 events):
        timestamps: [...]
        'calendar_year': [2021 2022 2023 2023]
...

Parameters:

Name Type Description Default
tz Union[str, float, int]

timezone name (see pytz.all_timezones) or UTC offset in hours.

 0

Returns:

Type Description
EventSetOrNode

EventSet with a single feature with the year each timestamp in sampling belongs to.