Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,7 +1,9 @@
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:
...	...	@@ -38,10 +38,30 @@
38	38	from IPython.core.display_functions import display
39	39	)))
40	40
41		-Then, 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:
	43	+Then, there are 2 options to work with the widget:
42	42
	45	+1. Use a file browser to load the data and automatically display it
	46	+1. Use directly the API to load the data and display it
	47	+
	48	+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:
	49	+
43	43	(% class="box" %)
44	44	(((
	52	+widget = api.HeadBrowser()
	53	+display(widget)
	54	+)))
	55	+
	56	+{{html}}
	57	+<iframe width="840" height="480" src="https://www.youtube.com/embed/BCCh-wdcnVo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
	58	+{{/html}}
	59	+
	60	+
	61	+For the second option, the API is described below:
	62	+
	63	+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:
	64	+
	65	+(% class="box" %)
	66	+(((
45	45	widget = api.HeadWidget()
46	46
47	47	face = surfaces.FaceSurface().from_file()
...	...	@@ -53,7 +53,7 @@
53	53	)))
54	54
55	55	{{html}}
56		-<iframe src="https://drive.google.com/file/d/1Egp9Lk-HGMATc9em6Kw_jSHmybTD2vzM/preview" width="840" height="480" allow="autoplay"></iframe>
	78	+<iframe width="840" height="480" src="https://www.youtube.com/embed/8bmjKp3BYFA" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
57	57	{{/html}}
58	58
59	59	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.
...	...	@@ -79,7 +79,7 @@
79	79	)))
80	80
81	81	{{html}}
82		-<iframe src="https://drive.google.com/file/d/1RLwts75Hh31LoPdWLK7QOM61KIsOabF1/preview" width="840" height="480" allow="autoplay"></iframe>
	104	+<iframe width="840" height="480" src="https://www.youtube.com/embed/6UQhL9gd1HM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
83	83	{{/html}}
84	84
85	85	We can also provide a **RegionMapping** to be used as colormap for a surface:
...	...	@@ -106,5 +106,5 @@
106	106	)))
107	107
108	108	{{html}}
109		-<iframe src="https://drive.google.com/file/d/1zrbjdb8Y4V5rqg7Y7LDGlHHMS0RH8luz/preview" width="840" height="480" allow="autoplay"></iframe>
	131	+<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>
110	110	{{/html}}