ktk.TimeSeries.ui_edit_events#

TimeSeries.ui_edit_events(name=[], data_keys=[])[source]#

Edit events interactively.

Parameters

  • name (str | list[str]) – Optional. The name of the event(s) to add. May be a string or a list of strings. These events appear on their own buttons “add name”. Event names can also be defined interactively.

  • data_keys (str | list[str]) – Optional. A signal name of list of signal name to be plotted, similar to the data_keys argument of ktk.TimeSeries.plot.

Returns

The original TimeSeries with the modified events. If the operation was cancelled by the user, this is a pure copy of the original TimeSeries.

Return type

TimeSeries

Warning

This function, which has been introduced in 0.6, is still experimental and may change signature or behaviour in the future.

See also

ktk.TimeSeries.add_event, ktk.TimeSeries.rename_event, ktk.TimeSeries.remove_event, ktk.TimeSeries.sort_events, ktk.TimeSeries.trim_events

Note

Matplotlib must be in interactive mode for this function to work.