diff --git a/docs/source/tutorials/images/brainrender-napari/add-region-brainrender-napari.png b/docs/source/tutorials/images/brainrender-napari/add-region-brainrender-napari.png index c3c20605..3f93a5be 100644 Binary files a/docs/source/tutorials/images/brainrender-napari/add-region-brainrender-napari.png and b/docs/source/tutorials/images/brainrender-napari/add-region-brainrender-napari.png differ diff --git a/docs/source/tutorials/images/brainrender-napari/added-brainrender-napari.png b/docs/source/tutorials/images/brainrender-napari/added-brainrender-napari.png index 01c5f4fa..1fb26b6c 100644 Binary files a/docs/source/tutorials/images/brainrender-napari/added-brainrender-napari.png and b/docs/source/tutorials/images/brainrender-napari/added-brainrender-napari.png differ diff --git a/docs/source/tutorials/images/brainrender-napari/additional-reference-brainrender-napari.png b/docs/source/tutorials/images/brainrender-napari/additional-reference-brainrender-napari.png index 469adc89..57b61be9 100644 Binary files a/docs/source/tutorials/images/brainrender-napari/additional-reference-brainrender-napari.png and b/docs/source/tutorials/images/brainrender-napari/additional-reference-brainrender-napari.png differ diff --git a/docs/source/tutorials/images/brainrender-napari/plugin-menu-brainrender-napari.png b/docs/source/tutorials/images/brainrender-napari/plugin-menu-brainrender-napari.png index fe007c93..c270d2d0 100644 Binary files a/docs/source/tutorials/images/brainrender-napari/plugin-menu-brainrender-napari.png and b/docs/source/tutorials/images/brainrender-napari/plugin-menu-brainrender-napari.png differ diff --git a/docs/source/tutorials/images/brainrender-napari/toggle-ndisplay-brainrender-napari.png b/docs/source/tutorials/images/brainrender-napari/toggle-ndisplay-brainrender-napari.png index cb4d7429..4cf28f6e 100644 Binary files a/docs/source/tutorials/images/brainrender-napari/toggle-ndisplay-brainrender-napari.png and b/docs/source/tutorials/images/brainrender-napari/toggle-ndisplay-brainrender-napari.png differ diff --git a/docs/source/tutorials/visualise-atlas-napari.md b/docs/source/tutorials/visualise-atlas-napari.md index 210cee42..32730267 100644 --- a/docs/source/tutorials/visualise-atlas-napari.md +++ b/docs/source/tutorials/visualise-atlas-napari.md @@ -1,6 +1,6 @@ ## Visualise an atlas in napari -BrainGlobe atlases are made of different components. These include the annotations image, the (default) reference image, 3D brain region meshes and, optionally, additional reference images. In this tutorial, you will use `brainrender-napari` to visualise each of these components in the 3D viewer napari through a series of simple clicks. The [`mpin_zfish_1um` zebrafish brain atlas](https://doi.org/10.1016/j.neuron.2019.04.034) will serve as an example. +BrainGlobe atlases are made of different components. These include the annotations image, the (default) reference image, 3D atlas region meshes and, optionally, additional reference images. In this tutorial, you will use `brainrender-napari` to visualise each of these components in the 3D viewer napari through a series of simple clicks. The [`mpin_zfish_1um` zebrafish brain atlas](https://doi.org/10.1016/j.neuron.2019.04.034) will serve as an example. :::{note} You will need `napari` installed on your computer - please follow [`napari`'s installation instructions to do so](https://napari.org/stable/tutorials/fundamentals/installation.html). @@ -10,29 +10,34 @@ You will need `napari` installed on your computer - please follow [`napari`'s in 2. Install `brainrender-napari` by selecting `Plugins > Install/Uninstall plugins` and searching for `brainrender-napari` in the searchbox. Then click on the `Install` button. 3. Open the `brainrender` widget by selecting `Plugins > Brainrender (brainrender-napari)` in the napari menu bar near the top left of the window. ![brainrender widget](./images/brainrender-napari/plugin-menu-brainrender-napari.png) + **The brainrender widget appears on the right hand side of the window.** -4. In the `brainrender` widget's `Atlas table view` section, double-click the row which contains the `mpin_zfish_1um` atlas. +4. In the `brainrender` widget's `Atlas table view` section, double-click the row which contains the `mpin_zfish_1um` atlas (you may have to scroll down slightly). ![brainrender widget with added annotations](./images/brainrender-napari/added-brainrender-napari.png) -**You have now added the annotations image and the default reference image to napari: They appear as layers in the napari layers list on the lower left of the window. A `3D Brain region meshes` section appears below the `Atlas table view` section.** + +**You have now added the annotations image and the default reference image to napari: They appear as layers in the napari layers list on the lower left of the window. A `3D Atlas region meshes` section appears below the `Atlas table view` section.** :::{note} If you haven't downloaded the atlas before, the plugin will prompt you to download it (click yes). It may take a long time -(depending on your internet speed) so please be patient. Once downloaded, double click again to view the atlas. +(depending on your internet speed) so please be patient. Once downloaded, double-click again to view the atlas. ::: 5. Toggle the napari display from 2D to 3D by pressing the button with the square icon on the lower left of the window. ![brainrender widget with 3d display](./images/brainrender-napari/toggle-ndisplay-brainrender-napari.png) + **The annotations image should now be displayed in 3D.** -6. Navigate the brain region tree in the `3D Brain region meshes` section by opening "forebrain". Double-click on `telencephalon`. +6. Navigate the brain region tree in the `3D Atlas region meshes` section by opening "forebrain". Double-click on `telencephalon`. ![brainrender widget with region mesh](./images/brainrender-napari/add-region-brainrender-napari.png) - **You have now added a 3D brain region mesh layer, which appears as a mesh in the viewer and as a new layer in the layers list.** + + **You have now added a 3D atlas region mesh layer, which appears as a mesh in the viewer and as a new layer in the layers list.** 7. Back in the "Atlas table view" section, right-click on the `mpin_zfish_1um` row. In the menu that appears, select `GAD1b`. ![brainrender widget with additional reference](./images/brainrender-napari/additional-reference-brainrender-napari.png) + **You have now added an additional reference image, which appears as a grey scale image in the viewer and as a new layer in the layers list.** -You have now added all possible kinds of BrainGlobe atlas components (annotations image, reference image, 3D brain region mesh, additional reference) to napari - well done! You can now add any of the other atlases listed in the `Atlas table view` if you like (note that not all atlases have additional references!). +You have now added all possible kinds of BrainGlobe atlas components (annotations image, reference image, 3D atlas region mesh, additional reference) to napari - well done! You can now add any of the other atlases listed in the `Atlas table view` if you like (note that not all atlases have additional references!). :::{note} Hover over any of the elements in the `brainrender` widget to get additional hints about how to use them! -::: \ No newline at end of file +:::