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

Add image segmentation docs #1821

Merged
merged 14 commits into from
Mar 12, 2020
Merged

Add image segmentation docs #1821

merged 14 commits into from
Mar 12, 2020

Conversation

mattcai
Copy link
Contributor

@mattcai mattcai commented Feb 26, 2020

Added tutorials for watershed, manual, and ilastik segmentation in starfish. Also made minor edits to from_fiji_roi_sets docstring and changed IlastikPretrainedProbability to clarify how to use in Windows and accept variable dataset names that are exported from ilastik.

link to readthedocs

Copy link
Collaborator

@shanaxel42 shanaxel42 left a comment

Choose a reason for hiding this comment

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

these docs are amazing

a few methods that are implemented or integrated with starfish to output a
:py:class:`.BinaryMaskCollection`, which represents a collection of labeled objects. If you do not
know which segmentation method to use, a safe bet is to start with thresholding and watershed. On
the other hand, if you can afford to manually define ROI masks there is no better way to
Copy link
Collaborator

Choose a reason for hiding this comment

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

is ROI common enough parlance that it's not necessary to define it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, I will add an entry for ROI in the glossary and link to it.


The most accurate but time-consuming approach is to manually segment images using a tool such as
`ROI manager <https://imagej.net/docs/guide/146-30.html#fig:The-ROI-Manager>`_ in FIJI (ImageJ). It
is a straightforward process that starfish supports by allowing ROI set binaries to be imported as a
Copy link
Collaborator

Choose a reason for hiding this comment

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

"ROI set binaries" is confusing to me. Do you mean ROI sets saved as binary files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes that's what I meant... I got the language from some ROI manager documentation I can't find now but I agree it's confusing. How about "that starfish supports by importing ROI sets stored in ZIP archives".

Copy link
Collaborator

Choose a reason for hiding this comment

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

sounds good.

examples/ilastik_segmentation.py Show resolved Hide resolved
examples/manual_segmentation.py Outdated Show resolved Hide resolved
@codecov-io
Copy link

codecov-io commented Feb 28, 2020

Codecov Report

Merging #1821 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1821   +/-   ##
=======================================
  Coverage   90.04%   90.04%           
=======================================
  Files         254      254           
  Lines        9451     9451           
=======================================
  Hits         8510     8510           
  Misses        941      941

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ec8aae...f7e4622. Read the comment docs.

@mattcai mattcai merged commit 1a47383 into master Mar 12, 2020
@neuromusic neuromusic mentioned this pull request Mar 19, 2020
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants