Changes for page Widget 3D Head

Last modified by paulapopa on 2025/05/30 15:03

From version 17.1
edited by paulapopa
on 2023/03/01 13:58
Change comment: There is no comment for this version
To version 22.1
edited by ldomide
on 2023/03/08 17:28
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.paulapopa
1 +XWiki.ldomide
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 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 +(((
45 45  widget = api.HeadWidget()
46 46  
47 47  face = surfaces.FaceSurface().from_file()
Public

TVB Widgets