ktk.TimeSeries.ui_get_ts_between_clicks#

TimeSeries.ui_get_ts_between_clicks(data_keys=[], *, inclusive=False)[source]#

Get a TimeSeries between two mouse clicks.

Warning

The function ui_get_ts_between_clicks is deprecated since 0.10.0 and is scheduled to be removed in 2024. Please use ts.ui_edit_events() and add ‘begin’ and ‘end’ events interactively instead. Then, you can use ts.get_ts_between_events() programmatically to keep only the interesting portion of the TimeSeries.

Parameters
  • data_keys (str | list[str]) – Optional. String or list of strings corresponding to the signals to plot. See TimeSeries.plot() for more information.

  • inclusive (bool) – Optional. True to include the given time in the comparison.

Returns

A new TimeSeries that fulfils the specified conditions.

Return type

TimeSeries

Note

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