Attention: The Collaboratory IAM will down for up to 1 hour on Monday, the 7th of July 2025 starting from 5pm CEST (my timezone) for up to 1 hour. Any and all services, which require a user login with an EBRAINS account, will be un-available during that time


Changes for page Widget TimeSeries

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

From version 9.1
edited by rominabaila
on 2022/04/12 09:30
Change comment: Uploaded new attachment "image-20220412103041-1.png", version {1}
To version 17.1
edited by paulapopa
on 2022/04/12 13:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.rominabaila
1 +XWiki.paulapopa
Content
... ... @@ -2,46 +2,77 @@
2 2  
3 3  It is a Jupyter widget intended for the visualization of brain signals represented as time series.
4 4  
5 -
6 6  == Inputs ==
7 7  
8 -It supports time series inputs of two types:
7 +Time series can be given as inputs in two forms:
9 9  
10 10  * TVB TimeSeries datatype
11 11  * Numpy arrays
12 12  
13 -The widget supports 2-, 3-, and 4-dimensional arrays. In all three cases, there is a fixed shape that the TimeSeries widget expects:
12 +This widget supports 2D, 3D, and 4D arrays. In all three cases, there is a fixed shape that the TimeSeries widget expects:
14 14  
15 15  * for **2D**: (no_timepoints, no_channels)
16 16  * for **3D**: (no_timepoints, state_variable/mode, no_channels)
17 17  * for **4D**: (no_timepoints, state_variable, no_channels, mode)
18 18  
19 -~* Note that the TVB TimeSeries datatype is always is always 4D and already has the expected shape.
18 +~* Note that the TVB TimeSeries datatype is always 4D and already has the expected shape.
20 20  
21 -
22 22  == Requirements and installation ==
23 23  
24 -Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and  Jupyter Notebook extensions should be installed:
22 +Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and Jupyter extensions should be installed:
25 25  
26 26  * **Libraries:**
27 27  ** [[ipympl>>https://github.com/matplotlib/ipympl#installation]]
28 28  * (((
29 -**Extensions:***
27 +**Extensions:**
30 30  
31 31  (% class="box" %)
32 32  (((
33 33  jupyter labextension install @jupyter-widgets/jupyterlab-manager
34 -)))
35 35  
36 -* (% class="box" %)
37 -(((
38 38  jupyter labextension install jupyter-matplotlib
39 39  )))
40 40  )))
41 41  
42 -Then, to install the tvb-widgets library just type:
37 +Then, to install the tvb-widgets library, just type:
43 43  
44 44  (% class="box" %)
45 45  (((
46 46  pip install tvb-widgets
47 47  )))
43 +
44 +== API usage ==
45 +
46 +First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
47 +
48 +(% class="box" %)
49 +(((
50 +%matplotlib widget
51 +)))
52 +
53 + Then, the **TimeSeriesWidget** (from the tvb-widgets API) and the **//display//** function should be imported:
54 +
55 +(% class="box" %)
56 +(((
57 +from tvbwidgets.api import TimeSeriesWidget
58 +from IPython.core.display_functions import display
59 +)))
60 +
61 +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):
62 +
63 +(% class="box" %)
64 +(((
65 +tsw = TimeSeriesWidget()
66 +tsw.add_datatype(tsr)
67 +)))
68 +
69 +Finally, to display and interact with the TimeSeries widget, the **//get_widget//**// //method is used inside the //**display **//function:
70 +
71 +(% class="box" %)
72 +(((
73 +display(tsw.get_widget())
74 +)))
75 +
76 +{{html}}
77 +<iframe src="https://drive.google.com/file/d/1g4ryY1VIFMUD14Mb6Dq_KVb0b2_XU4VX/preview" width="840" height="480" allow="autoplay"></iframe>
78 +{{/html}}
image-20220412103045-2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.rominabaila
Size
... ... @@ -1,0 +1,1 @@
1 +680.1 KB
Content
Public

TVB Widgets