Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation on Connectome Viewer #6232

Merged
merged 7 commits into from
May 24, 2022
Merged

Conversation

hotzenklotz
Copy link
Member

I added some documentation on the new connectome viewer featrure.

Changes:

  • added docs for the connectome viewer
  • referenced the docs from the empty connectome viewer tabs
  • expanded the terminology docs on segments and agglomerates since we use these terms quite often

URL of deployed dev instance (used for testing):

  • https://___.webknossos.xyz

Steps to test:

  • Read the docs

Issues:

  • None

(Please delete unneeded items, merge only when none are left open)

Copy link
Member

@philippotto philippotto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

## Segments
At its lowest-level a **segment** is the collection of several annotated voxels. At a larger level, segments can grow to be the size of a whole cell bodies or partial cells, e.g. a single axon.

Typically many segments make up a segmentation. Segments can be painted manually using the webKnossos volume annotation tools or created through third-party programs typically resulting in larger segmentations of a dataset.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Typically many segments make up a segmentation. Segments can be painted manually using the webKnossos volume annotation tools or created through third-party programs typically resulting in larger segmentations of a dataset.
Segments can be painted manually using the webKnossos volume annotation tools or created through third-party programs typically resulting in larger segmentations of a dataset.

I find the first sentence a bit redundant.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, yes and no. I want to explicitly make the connection between segments and segmentations, especially since we have Segmentation layers as first-order primitives in wK.

hotzenklotz and others added 3 commits May 24, 2022 10:58
@hotzenklotz hotzenklotz merged commit 38b9346 into master May 24, 2022
@hotzenklotz hotzenklotz deleted the connectome_viewer_docs branch May 24, 2022 10:46
hotzenklotz added a commit that referenced this pull request May 25, 2022
…e_of_conduct

* 'master' of github.com:scalableminds/webknossos:
  fix leowe slack notification (#6239)
  Volume annotation zarr streaming (#6203)
  Include segmentation layers in handling maximum number of renderable layers restricted by hardware (#6211)
  Allow restricting mags for new volume layer (#6229)
  Added documentation on Connectome Viewer (#6232)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants