Add BVV documentation page

mobie · Dec 18, 2024 · fb32bb2 · fb32bb2
1 parent 112c0a7
commit fb32bb2
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 0 deletions.
diff --git a/index.md b/index.md
@@ -22,6 +22,7 @@ views, images and tables for your colleagues to explore
 - [Getting Started](./tutorials/explore_a_project.md)
 - [Exploring segmentations and tables](./tutorials/exploring_segmentations.md)
 - [Locations and views](./tutorials/views_and_locations.md)
+- [Using BigVolumeViewer](./tutorials/bigvolumeviewer.md)
 - [Importing and exporting tables](./tutorials/importing_and_exporting_tables.md)
 - [Creating your own views](./tutorials/creating_your_own_views.md)
 - [Volume Registration tutorial](./tutorials/volume_registration.md)

diff --git a/tutorials/bigvolumeviewer.md b/tutorials/bigvolumeviewer.md
@@ -0,0 +1,22 @@
+## Using BigVolumeViewer
+
+By selecting a **B** checkbox in the Sources panel, you can view the 3D dataset in the BigVolumeViewer (BVV) window.  
+<img width="400" alt="image" src="./tutorial_images/sources_buttons.png">  
+
+BVV navigation controls (rotation, zoom, etc) are [the same as in BigDataViewer](./explore_a_project.html#browsing).  
+
+It supports two rendering modes: Maximum Intensity projection and Volumetric (transclucent/alpha blending), see an example below.  
+You can toggle between them using keyboard shortcut **`O`** (letter, not a number).  
+
+<img width="800" alt="image" src="./tutorial_images/bvv/bvv_render_style.png">
+
+You can synchronize the dataset view (and timepoint) with the BigDataViewer window view using shortcut **`D`**.  
+
+Compared with 3DViewer volume rendering using a fixed resolution, BVV works directly with the raw data. It loads corresponding multi-resolution data levels depending on the current view.  
+
+For the 3D volume rendering substantially more data is required to be loaded and processed, therefore for a smoother experience in displaying remote dataset it is recommended to use high-speed network connections.   
+As with all 3D applications, a better GPU card with large amount of GPU memory is recommended. You can adjust the amount of dedicated GPU memory and tweak quality/performance using BVV setting command explained below. 
+
+### Adjusting brightness, contrast and opacity
+
+#### BigVolumeViewer settings
diff --git a/tutorials/tutorial_images/bvv/bvv_render_style.png b/tutorials/tutorial_images/bvv/bvv_render_style.png
diff --git a/tutorials/tutorial_images/contextMenu.png b/tutorials/tutorial_images/contextMenu.png
diff --git a/tutorials/tutorial_images/focus.png b/tutorials/tutorial_images/focus.png
diff --git a/tutorials/tutorial_images/sources_buttons.png b/tutorials/tutorial_images/sources_buttons.png