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 18.1
edited by ldomide
on 2022/04/13 10:08
Change comment: There is no comment for this version
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
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ldomide
1 +XWiki.rominabaila
Content
... ... @@ -2,27 +2,28 @@
2 2  
3 3  It is a Jupyter widget intended for the visualization of brain signals represented as time series.
4 4  
5 +
5 5  == Inputs ==
6 6  
7 -Time series can be given as inputs in two forms:
8 +It supports time series inputs of two types:
8 8  
9 9  * TVB TimeSeries datatype
10 10  * Numpy arrays
11 11  
12 -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:
13 13  
14 14  * for **2D**: (no_timepoints, no_channels)
15 15  * for **3D**: (no_timepoints, state_variable/mode, no_channels)
16 16  * for **4D**: (no_timepoints, state_variable, no_channels, mode)
17 17  
18 -~* 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.
19 19  
20 20  == Requirements and installation ==
21 21  
22 -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:
23 23  
24 24  * **Libraries:**
25 -** mne, [[ipympl>>https://github.com/matplotlib/ipympl#installation]]
26 +** [[ipympl>>https://github.com/matplotlib/ipympl#installation]]
26 26  * (((
27 27  **Extensions:**
28 28  
... ... @@ -41,6 +41,7 @@
41 41  pip install tvb-widgets
42 42  )))
43 43  
45 +
44 44  == API usage ==
45 45  
46 46  First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
... ... @@ -50,7 +50,7 @@
50 50  %matplotlib widget
51 51  )))
52 52  
53 - 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:
54 54  
55 55  (% class="box" %)
56 56  (((
Public

TVB Widgets