Skip to content

Commit c959aca

Browse files
committed
Minor docstring improvements
1 parent a076497 commit c959aca

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

src/imcflibs/imagej/roimanager.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ def scale_all_rois(rm, scaling_factor):
210210

211211

212212
def select_rois_above_min_intensity(imp, channel, rm, min_intensity):
213-
"""Select ROIs based on their intensity in given channel of the image.
213+
"""Select ROIs based on their intensity in a given channel of the image.
214214
215215
See https://imagej.nih.gov/ij/developer/api/ij/process/ImageStatistics.html
216216
@@ -228,7 +228,7 @@ def select_rois_above_min_intensity(imp, channel, rm, min_intensity):
228228
Returns
229229
-------
230230
list(int)
231-
A list of ROIs index numbers that fulfill the selection criterion
231+
A list of ROI index numbers fulfilling the selection criterion
232232
(intensity is above the threshold).
233233
"""
234234
imp.setC(channel)
@@ -322,14 +322,15 @@ def put_rois_to_roimanager(
322322
def shift_roi_by_bounding_box(roi, bbox, z_slice=None):
323323
"""Move a ROI based on a bounding box.
324324
325-
Use to translate a ROI based on another one's bounding box.
325+
Translate one ROI based on another ROI's bounding box.
326326
327327
Parameters
328328
----------
329329
roi : ij.gui.Roi
330330
The ROI to be moved.
331331
bbox : java.awt.Rectangle
332-
Use this bounding box to shift the ROI.
332+
The bounding box by which the ROI should be shifted, e.g. retrieved by
333+
calling `OtherRoi.getBounds()` on a ROI object.
333334
z_slice : int, optional
334335
Shift the ROI also in Z, by default None (=no shifting).
335336
"""

0 commit comments

Comments
 (0)