Warning: The EBRAINS Drive and EBRAINS Lab will down on Tuesday, the 8th of July 2025 starting from 5pm CEST (my timezone) for up to 1 hour.


Changes for page Widget TimeSeries

Last modified by ldomide on 2023/05/23 14:34

From version 29.1
edited by rominabaila
on 2023/05/15 10:46
Change comment: Uploaded new attachment "plotly.png", version {1}
To version 16.1
edited by rominabaila
on 2022/04/12 13:13
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,34 +7,28 @@
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.
6 -
7 7  == Purpose ==
8 8  
9 -It is a Jupyter Widget intended for the visualization of brain signals represented as time series.
3 +It is a Jupyter widget intended for the visualization of brain signals represented as time series.
10 10  
5 +
11 11  == Inputs ==
12 12  
13 -Time series can be given as inputs in two forms:
8 +It supports time series inputs of two types:
14 14  
15 15  * TVB TimeSeries datatype
16 16  * Numpy arrays
17 17  
18 -This widget supports 2D, 3D, and 4D arrays. In all three cases, there is a fixed shape that the TimeSeries widget expects:
13 +The widget supports 2-, 3-, and 4-dimensional arrays. In all three cases, there is a fixed shape that the TimeSeries widget expects:
19 19  
20 20  * for **2D**: (no_timepoints, no_channels)
21 21  * for **3D**: (no_timepoints, state_variable/mode, no_channels)
22 22  * for **4D**: (no_timepoints, state_variable, no_channels, mode)
23 23  
24 -~* Note that the TVB TimeSeries datatype is always 4D and already has the expected shape.
19 +~* Note that the TVB TimeSeries datatype is always 4D and already has the expected shape.
25 25  
26 26  == Requirements and installation ==
27 27  
28 -Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and Jupyter extensions should be installed:
23 +Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and  Jupyter Notebook extensions should be installed:
29 29  
30 30  * **Libraries:**
31 -** [[mne>>https://mne.tools/0.24/install/index.html]] version 0.24
32 32  ** [[ipympl>>https://github.com/matplotlib/ipympl#installation]]
33 33  * (((
34 34  **Extensions:**
... ... @@ -48,6 +48,7 @@
48 48  pip install tvb-widgets
49 49  )))
50 50  
45 +
51 51  == API usage ==
52 52  
53 53  First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
... ... @@ -57,7 +57,7 @@
57 57  %matplotlib widget
58 58  )))
59 59  
60 - Then, the **TimeSeriesWidget** (from the tvb-widgets API) and the **//display//** function should be imported:
55 + Then, the TimeSeries widget (from the tvb-widgets API) and the display function should be imported:
61 61  
62 62  (% class="box" %)
63 63  (((
... ... @@ -77,9 +77,9 @@
77 77  
78 78  (% class="box" %)
79 79  (((
80 -display(tsw)
75 +display(tsw.get_widget())
81 81  )))
82 82  
83 83  {{html}}
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>
79 +<iframe src="https://drive.google.com/file/d/1g4ryY1VIFMUD14Mb6Dq_KVb0b2_XU4VX/preview" width="840" height="480" allow="autoplay"></iframe>
85 85  {{/html}}
matplotlib.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rominabaila
Size
... ... @@ -1,1 +1,0 @@
1 -184.9 KB
Content
plotly.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rominabaila
Size
... ... @@ -1,1 +1,0 @@
1 -351.7 KB
Content
Public

TVB Widgets