Skip to content

Commit

Permalink
adding documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
carsen-stringer committed Sep 13, 2023
1 parent 3bcdd36 commit cd0680d
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/gui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,32 @@ Main GUI mouse controls (works in all views):
- Start draw mask = right-click
- End draw mask = right-click, or return to circle at beginning

Drawing masks
~~~~~~~~~~~~~~~~~~~~~~

Masks are started with right-click, then hover your mouse (do not hold it down),
and return it to the red circle to complete the mask. The mask should now be completed.

Overlaps in masks are NOT allowed. If you draw a mask on top of another
mask, it is cropped so that it doesn't overlap with the old mask. Masks
in 2D should be single strokes (if *single_stroke* is checked).

If you want to draw masks in 3D, then you can turn *single_stroke*
option off and draw a stroke on each plane with the cell and then press
ENTER.
ENTER. You can also draw multiple strokes on the same plane for
complex cell shapes, but do not do this in 2D if you plan to train a cellpose model
(the cell flows will not work correctly).

.. note::
3D labelling will fill in unlabelled z-planes so that you do not
have to densely label, for example you can skip some planes.
have to densely label, for example you can skip some planes, and the
cell will be interpolated between planes.

After each mask is drawn in 2D, it is saved to the ``_seg.npy``. If this is slow (for
large images), this "autosave" option can be turned off in the "File" menu
("Disable autosave _seg.npy file"). In 3D,
the mask is never auto-saved, instead save masks by clicking CTRL+S, or "Save" in the
"File" menu.


Segmentation options
Expand Down

0 comments on commit cd0680d

Please sign in to comment.