Changes for page Widget TimeSeries
Last modified by ldomide on 2023/05/23 14:34
From version 16.1
edited by rominabaila
on 2022/04/12 13:13
on 2022/04/12 13:13
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. rominabaila1 +XWiki.ldomide - Content
-
... ... @@ -2,28 +2,27 @@ 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 inputsoftwotypes: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 -Th ewidget supports 2-, 3-, and 4-dimensionalarrays. 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 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 21 == Requirements and installation == 22 22 23 -Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and 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: 24 24 25 25 * **Libraries:** 26 -** [[ipympl>>https://github.com/matplotlib/ipympl#installation]] 25 +** mne, [[ipympl>>https://github.com/matplotlib/ipympl#installation]] 27 27 * ((( 28 28 **Extensions:** 29 29 ... ... @@ -42,7 +42,6 @@ 42 42 pip install tvb-widgets 43 43 ))) 44 44 45 - 46 46 == API usage == 47 47 48 48 First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command: ... ... @@ -52,7 +52,7 @@ 52 52 %matplotlib widget 53 53 ))) 54 54 55 - Then, the TimeSeries widget (from the tvb-widgets API) and the display function should be imported:53 + Then, the **TimeSeriesWidget** (from the tvb-widgets API) and the **//display//** function should be imported: 56 56 57 57 (% class="box" %) 58 58 (((