Summary

• Page properties (2 modified, 0 added, 0 removed)
• Attachments (0 modified, 1 added, 0 removed)
  • head.png

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.paulapopa
	1	+XWiki.reginafilange

Content

...	...	@@ -1,20 +1,25 @@
1	1	Source code: [[https:~~/~~/github.com/the-virtual-brain/tvb-widgets>>https://github.com/the-virtual-brain/tvb-widgets]]
2	2
3		-Immediate testing: [[https:~~/~~/lab.ch.ebrains.eu/hub/user-redirect/lab/tree/shared/TVB%20Widgets/REPO/tvb-widgets/notebooks/HeadWidget.ipynb>>https://lab.ch.ebrains.eu/hub/user-redirect/lab/tree/shared/TVB%20Widgets/REPO/tvb-widgets/notebooks/HeadWidget.ipynb]]
	3	+This is part of a Pypi release: [[https:~~/~~/pypi.org/project/tvb-widgets/>>https://pypi.org/project/tvb-widgets/]]
4	4
	5	+//**tvb-widgets**// is also already installed in the official image released for EBRAINS lab, where you can test it directly.
	6	+
5	5	== Purpose ==
6	6
7	7	It is a Jupyter widget intended for visualization of the 3D Head data available for a patient:
8	8
9	9	* surfaces of different types (cortex, face, skull, etc)
10		-* connectivity region centers
	12	+* connectivity region centers and edges
11	11	* sensors locations (SEEG, MEG, EEG)
12	12
	15	+On cortical surfaces, it can also display region parcellation.
	16	+
13	13	== Inputs ==
14	14
15	15	It supports the above data in the form of their corresponding TVB datatypes:
16	16
17	17	* Surface (CorticalSurface, FaceSurface, etc)
	22	+* Parcellation (RegionMapping)
18	18	* Connectivity
19	19	* Sensors (SensorsInternal, SensorsMEG, SensorsEEG)
20	20
...	...	@@ -29,99 +29,61 @@
29	29
30	30	We need to first import the widget __API from tvbwidgets__// //package, together with the __TVB API __and the __display__ function:
31	31
32		-(% class="box" %)
33		-(((
	37	+{{code language="python" layout="LINENUMBERS"}}
34	34	import tvbwidgets.api as api
35		-
36	36	from tvb.simulator.lab import *
	40	+from IPython.core.display_functions import display
	41	+{{/code}}
37	37
38		-from IPython.core.display_functions import display
39		-)))
40		-
41	41	Then, there are 2 options to work with the widget:
42	42
43	43	1. Use a file browser to load the data and automatically display it
44	44	1. Use directly the API to load the data and display it
45	45
46		-
47	47	For the first option, you have to run the following 2 lines of code in a notebook cell and then just use the UI controls:
48	48
49		-(% class="box" %)
50		-(((
	50	+{{code language="python" layout="LINENUMBERS"}}
51	51	widget = api.HeadBrowser()
52	52	display(widget)
53		-)))
	53	+{{/code}}
54	54
55	55
56	56	For the second option, the API is described below:
57	57
58		-In a new cell, we instantiate the **HeadWidget** and a **FaceSurface** datatype that we want to visualize. Using the //**add_datatype**// method we add the surface to our widget and __display__ the widget:
	58	+In a cell, we load the data using the TVB API:
59	59
60		-(% class="box" %)
61		-(((
62		-widget = api.HeadWidget()
	60	+{{code language="python" layout="LINENUMBERS"}}
	61	+surface = surfaces.Surface.from_file()
	62	+surface.configure()
63	63
64		-face = surfaces.FaceSurface().from_file()
65		-
	64	+face = surfaces.Surface.from_file('face_8614.zip')
66	66	face.configure()
67	67
68		-widget.add_datatype(face)
69		-display(widget)
70		-)))
	67	+reg_map = region_mapping.RegionMapping.from_file()
71	71
72		-{{html}}
73		-<iframe src="https://drive.google.com/file/d/1Egp9Lk-HGMATc9em6Kw_jSHmybTD2vzM/preview" width="840" height="480" allow="autoplay"></iframe>
74		-{{/html}}
75		-
76		-Next, we can continue adding other datatypes to this widget, by calling //**add_datatype**// multiple times. A maximum of 10 datatypes are supported by this widget.
77		-
78		-The **Config** object can be used to tweak the display options for each datatype.
79		-
80		-In the code below, we add a **Connectivity** and SEEG **Sensors:**
81		-
82		-(% class="box" %)
83		-(((
84		-conn = connectivity.Connectivity().from_file()
85		-
	69	+conn = connectivity.Connectivity.from_file()
86	86	conn.configure()
87	87
88		-widget.add_datatype(conn)
89		-
90		-
91		-seeg = sensors.SensorsInternal().from_file()
92		-
	72	+seeg = sensors.SensorsInternal.from_file()
93	93	seeg.configure()
	74	+{{/code}}
94	94
95		-widget.add_datatype(seeg, api.HeadWidgetConfig(name='SEEG'))
96		-)))
	76	+Then we prepare the **HeadWidget** for display:
97	97
98		-{{html}}
99		-<iframe src="https://drive.google.com/file/d/1RLwts75Hh31LoPdWLK7QOM61KIsOabF1/preview" width="840" height="480" allow="autoplay"></iframe>
100		-{{/html}}
	78	+{{code language="python" layout="LINENUMBERS"}}
	79	+widget = api.HeadWidget([face, conn, seeg])
	80	+display(widget)
	81	+{{/code}}
101	101
102		-We can also provide a **RegionMapping** to be used as colormap for a surface:
103	103
104		-(% class="box" %)
105		-(((
106		-reg_map = region_mapping.RegionMapping.from_file()
	84	+Next, we can continue adding other datatypes to this widget, by calling //**add_datatype**// multiple times.
107	107
108		-config = api.HeadWidgetConfig(name='Cortex')
	86	+In the code below, we add the **CorticalSurface** with a **RegionMapping** as parcellation**:**
109	109
110		-config.add_region_mapping_as_cmap(reg_map)
	88	+{{code language="python" layout="LINENUMBERS"}}
	89	+widget.add_datatype(surface, reg_map)
	90	+{{/code}}
111	111
112		-
113		-cortex = surfaces.CorticalSurface().from_file()
114		-
115		-cortex.configure()
116		-
117		-
118		-widget = api.HeadWidget()
119		-
120		-widget.add_datatype(cortex, config)
121		-
122		-display(widget)
123		-)))
124		-
125	125	{{html}}
126		-<iframe src="https://drive.google.com/file/d/1zrbjdb8Y4V5rqg7Y7LDGlHHMS0RH8luz/preview" width="840" height="480" allow="autoplay"></iframe>
	93	+<iframe width="840" height="480" src="https://www.youtube.com/embed/aDC2TJm2NxM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
127	127	{{/html}}

head.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.reginafilange

Size

...	...	@@ -1,0 +1,1 @@
	1	+245.6 KB

Content