Widget TimeSeries

1

Source code: [[https:~~/~~/github.com/the-virtual-brain/tvb-widgets>>url:https://github.com/the-virtual-brain/tvb-widgets]]

2

3

This is part of a Pypi release: [[https:~~/~~/pypi.org/project/tvb-widgets/>>url:https://pypi.org/project/tvb-widgets/]]

4

5

//**tvb-widgets**// is also already installed in the official image released for EBRAINS lab, where you can test it directly.

== Purpose ==

It is a Jupyter Widget intended for the visualization of brain signals represented as time series.

== Backends ==

Starting with //**tvb-widgets 1.5.0**, //the TS widget comes in 2 forms, corresponding to the 2 different libraries (we called them backends) used for plotting: **matplotlib **and **plotly**. The matplotlib backend, build on top of the **mne** library, offers more advanced scientifical features, while the plotly backend has a more appealing look and moves faster when talking about the basic interactions.

14

15

Below you can see the TS widget with each backend option (first one using the matplotlib backend, the second one using the plotly backend).

16

17

(% style="text-align:center" %)

18

[[image:matplotlib.png]]

19

20

(% style="text-align:center" %)

[[image:plotly.png]]

== Inputs ==

Time series can be given as inputs in two forms:

26

27

* TVB TimeSeries datatype

28

* Numpy arrays

29

30

This widget supports 2D, 3D, and 4D arrays. In all three cases, there is a fixed shape that the TimeSeries widget expects:

31

32

* for **2D**: (no_timepoints, no_channels)

33

* for **3D**: (no_timepoints, state_variable/mode, no_channels)

34

* for **4D**: (no_timepoints, state_variable, no_channels, mode)

35

36

~* Note that the TVB TimeSeries datatype is always 4D and already has the expected shape.

37

38

== Requirements and installation ==

39

40

41

Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and Jupyter extensions should be installed:

42

43

* **Libraries:**

44

** [[mne>>https://mne.tools/stable/index.html]] >= 1.0

45

** [[matplotlib>>https://matplotlib.org/3.5.0/index.html]]

46

** [[plotly>>https://plotly.com/python/]] == 5.14.0

47

** [[ipywidgets>>https://ipywidgets.readthedocs.io/en/7.x/]] == 7.7.2

48

** [[ipympl>>https://github.com/matplotlib/ipympl#installation]] >= 0.8.5

* (((

**Extensions:**

(% class="box" %)

(((

jupyter labextension install @jupyter-widgets/jupyterlab-manager

55

56

jupyter labextension install jupyter-matplotlib

57

58

jupyter labextension install jupyterlab-plotly

)))

)))

Then, to install the tvb-widgets library, just type:

(% class="box" %)

(((

pip install tvb-widgets

)))

== API usage ==

First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:

(% class="box" %)

(((

%matplotlib widget

)))

Then, the **TimeSeriesWidget** (from the tvb-widgets API) and the **//display//** function should be imported:

(% class="box" %)

(((

from tvbwidgets.api import TimeSeriesWidget

83

from IPython.core.display_functions import display

84

)))

85

86

Assuming that the user has already created or imported a valid input, this is how the widget can be initialized and how an input can be assigned to it, using the //**add_datatype** //method (example below assumes that **//tsr// **is a TVB TimeSeries datatype):

(% class="box" %)

(((

tsw = TimeSeriesWidget()

91

tsw.add_datatype(tsr)

92

)))

93