Skip to content

Commit

Permalink
Update Neuroglancer docs and references (#1321)
Browse files Browse the repository at this point in the history
- Increasing image size and adding link to additional documentation in
the quick start guide
- Updating the FAQ to reference our documentation
  • Loading branch information
dgmccart authored Nov 6, 2024
1 parent 788c178 commit 7032211
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
6 changes: 4 additions & 2 deletions docs/cryoet_data_portal_docsite_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ In the above example, the download happened very quickly because the file was on
:class: czi-faq
:name: visualize-neuroglancer
:collapsible:
All tomograms in the Data Portal are viewable in Neuroglancer along with their annotations. You can open a tomogram in Neuroglancer by clicking the blue `View Tomogram` button on any run page in the Portal. This will open an instance of Neuroglancer in a separate tab of your browser with the selected data along with their annotations already loaded. For more information about visualizing data with Neuroglancer, check out the documentation from Connectomics, the team that develops Neuroglancer, [here](https://connectomics.readthedocs.io/en/latest/external/neuroglancer.html#basic-usage).
All tomograms in the Data Portal are viewable in Neuroglancer along with their annotations. You can open a tomogram in Neuroglancer by clicking the blue `View Tomogram` button on any run page in the Portal. This will open an instance of Neuroglancer in a separate tab of your browser with the selected data along with their annotations already loaded. For more information about visualizing data with Neuroglancer, check out our [Quick Start guide](neuroglancer_quickstart) or the [documentation from Connectomics](https://connectomics.readthedocs.io/en/latest/external/neuroglancer.html#basic-usage), the team that develops Neuroglancer.
:::

:::{admonition} How do I use napari to visualize tomograms with their annotations?
Expand Down Expand Up @@ -163,7 +163,9 @@ Descriptions of all terminology and metadata used in the Portal is provided [her
:class: czi-faq
:name: default-annotations
:collapsible:
There is no definitive rule for which annotations are displayed with a tomogram in Neuroglancer by default. The annotations are manually chosen to display as many annotations as possible without overlap or occlusion. For example, when the cytoplasm is annotated as a whole, it would occlude other annotations included within, such as protein picks. When there is a ground truth and predicted annotation, the ground truth annotation is displayed by default. Authors contributing data can specify the desired default annotations during the submission process.
Tomograms along with all annotations from the Portal come preloaded in Neuroglancer. Some annotations may not be displayed in the canvas by default, but those annotations can be viewed by clicking any layer name with strikethrough text. Check out this [Quick Start guide](neuroglancer_quickstart) for more information on using Neuroglancer.

There is no definitive rule for which annotations are displayed in the Neuroglancer canvas by default. The annotations are manually chosen to display as many annotations as possible without overlap or occlusion. For example, when the cytoplasm is annotated as a whole, it would occlude other annotations included within, such as protein picks. When there is a ground truth and predicted annotation, the ground truth annotation is displayed by default. Authors contributing data can specify the desired default annotations during the submission process.

The CryoET Data Portal napari plugin can be used to visualize tomograms, annotations, and metadata. Refer to [this documentation](https://github.com/chanzuckerberg/napari-cryoet-data-portal#usage) to learn about how to use the plugin and to [this page](cryoet_data_portal_docsite_napari) to learn more about napari and CryoET Data Portal.
:::
Expand Down
9 changes: 5 additions & 4 deletions docs/neuroglancer_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ All of the data loaded is displayed in the upper bar with layers that are not cu
<figure>
<img src="_static/img/neuroglancer_4.png"
alt="Layer panel"
width="25%"
width="40%"
>
</figure>
Expand All @@ -64,7 +64,7 @@ For 3D volumes, volume rendering can be turned on using the Volume rendering (ex
<figure>
<img src="_static/img/neuroglancer_5.png"
alt="Tomogram rendering control panel"
width="25%"
width="40%"
>
</figure>
Expand All @@ -73,7 +73,7 @@ For point annotations, the size of the point markers, opacity, and color of the
<figure>
<img src="_static/img/neuroglancer_6.png"
alt="Point annotation rendering controls"
width="25%"
width="40%"
>
</figure>
Expand All @@ -82,7 +82,7 @@ For segmentation masks, the opacity of the labels and other display settings can
<figure>
<img src="_static/img/neuroglancer_7.png"
alt="Segmentation mask rendering controls"
width="25%"
width="40%"
>
</figure>
Expand All @@ -93,3 +93,4 @@ For segmentation masks, the opacity of the labels and other display settings can
* Tomograms and annotations are pre-loaded into Neuroglancer but some annotations may not be visible by default. Click on a layer with strikethrough text to make the layer visible in the canvas.
* The Annotations tab in Neuroglancer is for adding additional annotations and not related to the annotations provided on the CryoET Data Portal. Use the Rendering tab to adjust annotations pre-loaded in Neuroglancer.
* Layers highlighted in magenta can be hidden in the 3D mesh by double clicking the segmentation in the 2D view. Double clicking the 2D segmentation will make it re-appear in the 3D viewer.
* For more information on Neuroglancer, [check out the documentation from Connectomics here](https://connectomics.readthedocs.io/en/latest/external/neuroglancer.html#neuroglancer).

0 comments on commit 7032211

Please sign in to comment.