lt_toolbox.TrajFrame.use_datetime#

TrajFrame.use_datetime(start_date: str, unit: str = 's', fmt: str = '%Y-%m-%d') → Self[source]#

Convert time column variable to Datetime format.

Parameters:

start_date (str) – Starting date to use when converting time column variable to Datetime.
unit (str, default: 's') – Unit time variable is stored as (e.g., ‘s’, ‘d’, ‘w’ etc.).
fmt (str, default: "%Y-%m-%d") – Datetime format of specified start data. Default format is YYYY-MM-DD.

Returns:

TrajFrame is returned with transformed time column variable containing datetimes.

Return type:

TrajFrame

Examples

Convert time in seconds in TrajFrame to datetime with start date ‘2000-01-01’ using default Datetime format.

>>> trajectories.use_datetime(start_date='2000-01-01')