Skip to content

Commit 8e314e7

Browse files
committed
Improve docstring for find_focus()
1 parent 55f37f3 commit 8e314e7

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/imcflibs/imagej/misc.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,9 @@ def calculate_mean_and_stdv(float_values):
9191

9292

9393
def find_focus(imp):
94-
"""Function to get the focused stack. Works on single-channel images only.
94+
"""Find the slice of a stack that seems to bet the best focused one.
95+
96+
NOTE: currently only single-channel stacks are supported.
9597
9698
Parameters
9799
----------
@@ -101,7 +103,6 @@ def find_focus(imp):
101103
Returns
102104
-------
103105
int
104-
Slice number which seems to be the best focused one.
105106
"""
106107

107108
imp_dimensions = imp.getDimensions()

0 commit comments

Comments
 (0)