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

Updates the Docs #4020

Merged
merged 8 commits into from
Apr 23, 2019
Merged

Updates the Docs #4020

merged 8 commits into from
Apr 23, 2019

Conversation

hotzenklotz
Copy link
Member

@hotzenklotz hotzenklotz commented Apr 16, 2019

I updated the docs very slightly:

  • move skeleton and volume annotations into their own seperate, first-order pages
  • refined description of merger mode
  • high-level overview of mapping support
  • slight renaming of some title (feedback appreciated)

TODO:

  • look into way of getting videos to work

URL of deployed dev instance (used for testing):

Steps to test:

  • Read the new docs

@hotzenklotz
Copy link
Member Author

@philippotto Can you please help here. I would like to include a short example of a mapping file / schema. See my TODO comment. I am also unsure on where the mapping files need to be in the file structure in order to be detected. Some refinement of my text is appreciated. :-)

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.

👍

### Mappings / On-Demand Agglomeration
With webKnossos it is possible to apply a precomputed agglomeration file to combine over-segmentated volume annotations on demand. This eleviates the demand to materialize agglomeration results prematurely and allows researchs to apply different agglomerations to the data for experimentation. We typically produce several agglomeration results based on diffent thresholds and methods and use webKnossos to quickly review theses results on subsets of a dataset in an interactive session.

Mapping files are automatically identified by webKnossos when being placed in the same directory as the data. All available mappings can be activated from a dropwdown in the "Segmentation" information pane, typically on the right-hand side of the screen. Due to their file size, mappings are fetched on demand before being applied. Users can easily switch between several mappings and webKnossos will update accordingly.
Copy link
Member

Choose a reason for hiding this comment

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

typo in "dropdown"

Mapping files are in JSON and need to follow this schema:
```
{
TODO
Copy link
Member

Choose a reason for hiding this comment

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

{
   "name": "astrocytes",
   "classes": [
		[
			69381,
			69445,
			138248
		], [
			138307,
			343831
		], [
			348348,
			132432,
			387433,
			338330
		]
    ]
}

### Mappings / On-Demand Agglomeration
With webKnossos it is possible to apply a precomputed agglomeration file to combine over-segmentated volume annotations on demand. This eleviates the demand to materialize agglomeration results prematurely and allows researchs to apply different agglomerations to the data for experimentation. We typically produce several agglomeration results based on diffent thresholds and methods and use webKnossos to quickly review theses results on subsets of a dataset in an interactive session.

Mapping files are automatically identified by webKnossos when being placed in the same directory as the data. All available mappings can be activated from a dropwdown in the "Segmentation" information pane, typically on the right-hand side of the screen. Due to their file size, mappings are fetched on demand before being applied. Users can easily switch between several mappings and webKnossos will update accordingly.
Copy link
Member

Choose a reason for hiding this comment

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

when being placed in a "mappings" folder within the segmentation folder

hotzenklotz and others added 5 commits April 18, 2019 16:12
… doc_update

* 'doc_update' of github.com:scalableminds/webknossos:
  Fix sitemap for publication detail view (#4024)
  Add sitemap.xml (#4006)
  Allow empty trees  (#4010)
@hotzenklotz hotzenklotz merged commit 828c5e0 into master Apr 23, 2019
@hotzenklotz hotzenklotz deleted the doc_update branch April 23, 2019 08:07
hotzenklotz added a commit that referenced this pull request Apr 25, 2019
* master: (43 commits)
  update screenshots (#4038)
  docker: don't set sbt/ivy cache (#4034)
  Slow down brush size change for small sizes (#4012)
  voulme tool bar now depends only on the active tool (#4029)
  Allow user to adapt GPU memory consumption to allow for better quality (#4015)
  Updates the Docs (#4020)
  hiding pricing and features in iframe (#4019)
  Fix sitemap for publication detail view (#4024)
  Add sitemap.xml (#4006)
  Allow empty trees  (#4010)
  Prefer annotation zoom over dataset zoom (#3992)
  Add details view for publications (#3994)
  remove enzyme test (#3997)
  Tensorflow segmentation (#3461)
  ensure that max zoom step is not exceeded when changing viewport area (#3996)
  allow isosurfaces for hybrid tracings when setting window.allowIsosurfaces (#3998)
  re-fetch buckets if fetching them failed (#3999)
  Only re-compute bounding sphere of skeletons if something changed (#3995)
  Fix dropdown login padding (#3988)
  Persist tree visibility (#3942)
  ...
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