Summary

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

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Widget 3D
	1	+Widget 3D Head

Author

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

Content

...	...	@@ -1,8 +1,12 @@
1		-TODO - Not yet released!
	1	+Source code: [[https:~~/~~/github.com/the-virtual-brain/tvb-widgets>>https://github.com/the-virtual-brain/tvb-widgets]]
2	2
	3	+This is part of a Pypi release: [[https:~~/~~/pypi.org/project/tvb-widgets/>>https://pypi.org/project/tvb-widgets/]]
	4	+
	5	+//**tvb-widgets**// is also already installed in the official image released for EBRAINS lab, where you can test it directly.
	6	+
3	3	== Purpose ==
4	4
5		-It is a Jupyter widget intended for visualization of the 3D data available for a patient:
	9	+It is a Jupyter widget intended for visualization of the 3D Head data available for a patient:
6	6
7	7	* surfaces of different types (cortex, face, skull, etc)
8	8	* connectivity region centers
...	...	@@ -36,12 +36,32 @@
36	36	from IPython.core.display_functions import display
37	37	)))
38	38
39		-Then, we instantiate the **SurfaceWidget** 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:
40	40
	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	+
41	41	(% class="box" %)
42	42	(((
43		-widget = api.SurfaceWidget()
	52	+widget = api.HeadBrowser()
	53	+display(widget)
	54	+)))
44	44
	56	+{{html}}
	57	+<iframe src="https://drive.google.com/file/d/1lY3X5eqJfOLmkmHuBa2iq_Aas8mDPa1e/preview" width="840" height="480" allow="autoplay"></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	+(((
	67	+widget = api.HeadWidget()
	68	+
45	45	face = surfaces.FaceSurface().from_file()
46	46
47	47	face.configure()
...	...	@@ -73,11 +73,11 @@
73	73
74	74	seeg.configure()
75	75
76		-widget.add_datatype(seeg, api.SurfaceWidgetConfig(name='SEEG'))
	100	+widget.add_datatype(seeg, api.HeadWidgetConfig(name='SEEG'))
77	77	)))
78	78
79	79	{{html}}
80		-<iframe src="https://drive.google.com/file/d/1vFqqzXle8VGcHaLB-OdE-6BdetK9aJ1T/preview" width="840" height="480" allow="autoplay"></iframe>
	104	+<iframe src="https://drive.google.com/file/d/1RLwts75Hh31LoPdWLK7QOM61KIsOabF1/preview" width="840" height="480" allow="autoplay"></iframe>
81	81	{{/html}}
82	82
83	83	We can also provide a **RegionMapping** to be used as colormap for a surface:
...	...	@@ -86,7 +86,7 @@
86	86	(((
87	87	reg_map = region_mapping.RegionMapping.from_file()
88	88
89		-config = api.SurfaceWidgetConfig(name='Cortex')
	113	+config = api.HeadWidgetConfig(name='Cortex')
90	90
91	91	config.add_region_mapping_as_cmap(reg_map)
92	92
...	...	@@ -95,9 +95,14 @@
95	95
96	96	cortex.configure()
97	97
	122	+
	123	+widget = api.HeadWidget()
	124	+
98	98	widget.add_datatype(cortex, config)
	126	+
	127	+display(widget)
99	99	)))
100	100
101	101	{{html}}
102		-<iframe src="https://drive.google.com/file/d/1z2yEuQWUT2Poxh63adYbBdhKPcWGskex/preview" width="840" height="480" allow="autoplay"></iframe>
	131	+<iframe src="https://drive.google.com/file/d/1zrbjdb8Y4V5rqg7Y7LDGlHHMS0RH8luz/preview" width="840" height="480" allow="autoplay"></iframe>
103	103	{{/html}}