Wiki source code of Widget TimeSeries

Version 31.1 by rominabaila on 2023/05/15 10:50

version	line-number	content
22.1	1	Source code: [[https:~~/~~/github.com/the-virtual-brain/tvb-widgets>>url:https://github.com/the-virtual-brain/tvb-widgets]]
21.1	2
25.1	3	This is part of a Pypi release: [[https:~~/~~/pypi.org/project/tvb-widgets/>>url:https://pypi.org/project/tvb-widgets/]]
21.1	4
25.1	5	//tvb-widgets// is also already installed in the official image released for EBRAINS lab, where you can test it directly.
	6
23.1	7	== Purpose ==
1.1	8
22.1	9	It is a Jupyter Widget intended for the visualization of brain signals represented as time series.
5.1	10
	11	== Inputs ==
	12
17.1	13	Time series can be given as inputs in two forms:
6.1	14
	15	* TVB TimeSeries datatype
	16	* Numpy arrays
	17
17.1	18	This widget supports 2D, 3D, and 4D arrays. In all three cases, there is a fixed shape that the TimeSeries widget expects:
6.1	19
	20	* for 2D: (no_timepoints, no_channels)
	21	* for 3D: (no_timepoints, state_variable/mode, no_channels)
	22	* for 4D: (no_timepoints, state_variable, no_channels, mode)
	23
17.1	24	~* Note that the TVB TimeSeries datatype is always 4D and already has the expected shape.
7.1	25
	26	== Requirements and installation ==
	27
17.1	28	Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and Jupyter extensions should be installed:
7.1	29
	30	* Libraries:
20.1	31	** [[mne>>https://mne.tools/0.24/install/index.html]] version 0.24
	32	** [[ipympl>>https://github.com/matplotlib/ipympl#installation]]
7.1	33	* (((
11.1	34	Extensions:
7.1	35
	36	(% class="box" %)
	37	(((
8.1	38	jupyter labextension install @jupyter-widgets/jupyterlab-manager
7.1	39
8.1	40	jupyter labextension install jupyter-matplotlib
7.1	41	)))
	42	)))
	43
12.1	44	Then, to install the tvb-widgets library, just type:
7.1	45
	46	(% class="box" %)
	47	(((
	48	pip install tvb-widgets
	49	)))
13.1	50
	51	== API usage ==
	52
	53	First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
	54
	55	(% class="box" %)
	56	(((
	57	%matplotlib widget
	58	)))
	59
17.1	60	Then, the TimeSeriesWidget (from the tvb-widgets API) and the //display// function should be imported:
13.1	61
	62	(% class="box" %)
	63	(((
	64	from tvbwidgets.api import TimeSeriesWidget
	65	from IPython.core.display_functions import display
	66	)))
	67
	68	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):
	69
	70	(% class="box" %)
	71	(((
	72	tsw = TimeSeriesWidget()
	73	tsw.add_datatype(tsr)
	74	)))
	75
	76	Finally, to display and interact with the TimeSeries widget, the //get_widget//// //method is used inside the //display //function:
	77
	78	(% class="box" %)
	79	(((
19.1	80	display(tsw)
13.1	81	)))
15.1	82
	83	{{html}}
27.1	84	<iframe width="840" height="480" src="https://www.youtube.com/embed/VmueiXMxbVk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
15.1	85	{{/html}}

Wiki source code of Widget TimeSeries

TVB Widgets