Skip to content

Commit e8aa40b

Browse files
committed
Improve docstring
1 parent f2a8299 commit e8aa40b

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

src/imcflibs/imagej/objects3d.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,20 +61,22 @@ def segment_3d_image(imp, title=None, min_thresh=1, min_vol=None, max_vol=None):
6161
6262
Parameters
6363
----------
64-
imp : ImagePlus
64+
imp : ij.ImagePlus
6565
Binary 3D stack.
6666
title : str, optional
6767
Title of the new image.
6868
min_thresh : int, optional
6969
Threshold to do segmentation, also allows for label filtering, by default 1.
70+
Since the segmentation is happening on a binary stack, values are either 0 or 255
71+
so using 0 allows to discard only the background.
7072
min_vol : int, optional
7173
Volume (voxels) under which to filter objects, by default None.
7274
max_vol : int, optional
7375
Volume above which to filter objects, by default None.
7476
7577
Returns
7678
-------
77-
ImagePlus
79+
ij.ImagePlus
7880
Segmented 3D labelled ImagePlus.
7981
"""
8082
cal = imp.getCalibration()

0 commit comments

Comments
 (0)