Skip to content
Snippets Groups Projects
Commit 08e92009 authored by Timo Dickscheid's avatar Timo Dickscheid
Browse files

form "getting started" section

parent 368e7498
No related branches found
No related tags found
No related merge requests found
......@@ -11,5 +11,5 @@
| Multiple region select | `<ctrl>` + `[click]` on region | - |
| Context menu | `[right click]` | - |
You can enable touch interface by `[Portrait]` > `Settings` > `Enable Mobile UI`
You can enable the touch interface, which is selected per default on mobile devices, by selectingthe user menu from the top right (👤), then choosing `Settings` and `Enable Mobile UI`.
# Key concepts of an atlas in siibra
# Essential elements of an atlas in siibra
A typical brain atlas consists of
......
# Getting Started
# Launch & quick start
!!! tip "Launch siibra-explorer on EBRAINS"
To launch siibra-explorer, **<https://atlases.ebrains.eu/viewer>** in your web browser.
To launch siibra-explorer on EBRAINS, go to **<https://atlases.ebrains.eu/viewer>** using your web browser.
Recommended browsers are up-to-date versions of [Firefox](https://www.mozilla.org/firefox) and [Google chrome](https://www.google.com/chrome). Newer versions of [Apple Safari](https://www.apple.com/safari/) also work fairly well. Note that your hardware needs to support the WebGL2 standard, which should be the case for recent devices. If in doubt, check compatibility at <https://get.webgl.org/webgl2/>.
!!! tip "siibra-explorer runs on mobile devices!"
Using the browser on your table or mobile phone should work in many cases as well. Try it out!
An overview and the basic functionalities of `siibra-explorer` is presented in the quick tour, which is automatically launched on first use. You can always revisit the quick tour via the help menu, which can be found under the `?` icon at the top right of the UI, or using the `?` / `h` keyboard shortcut.
You might also watch the following video tutorial, which covers basic functionalities of `siibra-explorer`. Note that since we are continuously adding new features to `siibra-explorer` however, the user interface shown in the video might not exactly reflect the latest version of the viewer.
......@@ -13,6 +14,3 @@ You might also watch the following video tutorial, which covers basic functional
!!! tip "siibra-explorer runs on mobile devices!"
Using the browser on your table or mobile phone should work in many cases as well. Try it out!
![](https://data-proxy.ebrains.eu/api/v1/buckets/reference-atlas-data/static/siibra_explorer_in_mobile.png){: style="width:500px" }
......@@ -3,22 +3,22 @@
## 3D view
At its core, the viewer presents a 3D view of a brain.
The precise layout of the 3D view depends on the select reference space.
For volumetric reference spaces, it presents 2D views of three orthogonal planes in the reference template, combined with a rotatable 3D overview of the brain surface indicating the location of these planes.
The planes default to the coronal, sagittal and axial plane, and can be freely adjusted in position and orientation to select arbitrary oblique views.
![](https://data-proxy.ebrains.eu/api/v1/buckets/reference-atlas-data/static/siibra-explorer-waxholm.png){ style="width:500px"}
For volumetric reference spaces, it presents 2D views of three orthogonal planes in the reference template, combined with a rotatable 3D overview of the brain surface indicating the location of these planes. The planes default to the coronal, sagittal and axial plane, and can be freely adjusted in position and orientation to select arbitrary oblique views.
![](https://data-proxy.ebrains.eu/api/v1/buckets/reference-atlas-data/static/siibra-explorer-waxholm.png){: style="width:250px" }
The volumetric views support ultrahigh-resolution data, and can be zoomed in if the underlying image data allows. Each of the 3 planar views can be maximized using the "[ ]" icon in each view.
![](https://data-proxy.ebrains.eu/api/v1/buckets/reference-atlas-data/static/siibra-explorer-v1border.png){ style="width:500px"}
![](https://data-proxy.ebrains.eu/api/v1/buckets/reference-atlas-data/static/siibra-explorer-v1border.png){: style="width:250px" }
For pure surface spaces, such as the fsaverage space, the viewer shows only a 3D view.
![](https://data-proxy.ebrains.eu/api/v1/buckets/reference-atlas-data/static/siibra-explorer-surfaceview.png){ style="width:500px"}
![](https://data-proxy.ebrains.eu/api/v1/buckets/reference-atlas-data/static/siibra-explorer-surfaceview.png){: style="width:250px" }
## Navigation panel
At the top left of the user interface, `siibra-explorer` displays the 3D coordinate of the currently selected center of view. When you click it with the mouse pointer, a navigation panel opens, which allows to enter a different coordinates, and create a shareable link to the current view (see ["Storing and sharing 3D views"](../basics/storing_and_sharing_3d_views.md)).
## Navigation panel 🧭
At the top left of the user interface, `siibra-explorer` displays the 3D coordinate of the currently selected center of view together with the navigation icon 🧭. When you click it with the mouse pointer, a navigation panel opens, which allows to enter a different coordinates, and create a shareable link to the current view (see ["Storing and sharing 3D views"](../basics/storing_and_sharing_3d_views.md)).
![](https://data-proxy.ebrains.eu/api/v1/buckets/reference-atlas-data/static/siibra-explorer-navigation.png){ style="width:600px"}
......@@ -50,3 +50,19 @@ The login button (👤) allows you to sign in with an EBRAINS account to access
!!! tip "Get an EBRAINS account!"
You can sign up for a free EBRAINS account at <https://ebrains.eu/register>
| Action | Desktop | Touch devices |
| --- | --- | --- |
| Translate / Pan | `[drag]` any of the slice views | `[drag]` any of the slice views |
| Oblique rotation | `<shift>` + `[drag]` any of the slice views | `[rotate]` any of the slice views |
| Zoom | `[mousewheel]` | `[pinch zoom]` |
| Zoom | `[hover]` on any slice views > `[click]` magnifier | `[tap]` on magnifier |
| Next slice | `<ctrl>` + `[mousewheel]` / `[p]`revious / `[n]`ext | - |
| Next 10 slice | `<shift>` + `[mousewheel]` | - |
| Toggle delineation | `[q]` | - |
| Toggle cross hair | `[a]` | - |
| Multiple region select | `<ctrl>` + `[click]` on region | - |
| Context menu | `[right click]` | - |
You can enable touch interface by `[Portrait]` > `Settings` > `Enable Mobile UI`
# siibra-explorer - web-based viewer for exploring multi-resolution 3D brain atlases
!!! tip "siibra-explorer runs on EBRAINS"
!!! tip "Quick links to siibra-explorer on EBRAINS"
- Launch `siibra-explorer` on EBRAINS: <https://atlases.ebrains.eu/viewer/>
- Get EBRAINS user support: [support@ebrains.eu](mailto:support@ebrains.eu?subject=[interactive%20atlas%20viewer]%20queries)
- Learn about EBRAINS atlases: <https://ebrains.eu/brain-atlases/reference-atlases>.
......
......@@ -21,10 +21,10 @@ plugins:
nav:
- Home: 'index.md'
- Getting Started: 'getting_started.md'
- Key concepts: 'concepts.md'
- User interface:
- Main elements: 'ui/main_elements.md'
- Getting Started:
- Launch & quick tour: 'getstarted/launch.md'
- Elements of an atlas: 'getstarted/atlas_elements.md'
- User interface structure: 'getstarted/ui.md'
- Keyboard shortcuts: 'basics/helperOnePager.md'
- Basic Functionalities:
- Exploring parcellation maps: 'basics/exploring_3d_parcellation_maps.md'
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment