ktk.TimeSeries.sort_events

ktk.TimeSeries.sort_events#

TimeSeries.sort_events(*, unique=False, in_place=False)[source]#

Deprecated. Sorts the TimeSeries’ events from the earliest to the

Warning

The function sort_events is deprecated since 0.15 and is scheduled to be removed in 2027. Events are now always sorted in the events attribute. There is no need to run the sort_events method anymore. latest.

Parameters:
  • unique (bool) – Optional. True to make events unique so that no two events can have both the same name and the same time.

  • in_place (bool) – Optional. True to modify and return the original TimeSeries. False to return a modified copy of the TimeSeries while leaving the original TimeSeries intact. Default is False.

Returns:

The TimeSeries with the sorted events.

Return type:

TimeSeries