ktk.TimeSeries.ui_edit_events

ktk.TimeSeries.ui_edit_events#

TimeSeries.ui_edit_events(name=[], data_keys=[], legend=True, max_lines=40)[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.

  • legend (bool) – Optional. True to plot a legend, False otherwise. Default is True.

  • max_lines (int) – Optional. The maximal number of lines to plot. Default is 40. A warning is issued if plotting all the data would require more lines.

Returns:

The TimeSeries with the modified events. If the operation was cancelled by the user, this is 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.trim_events

Note

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

Contents