Skip to content

Commit a3448ff

Browse files
Correct docstring to conform to convention
Add period to docstring, change from double to float and remove redundant "the".
1 parent 51928d0 commit a3448ff

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/imcflibs/imagej/shading.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,19 +184,19 @@ def process_files(files, outpath, model_file, fmt):
184184

185185
def simple_flatfield_correction(imp, sigma=20.0):
186186
"""
187-
Performs a simple flatfield correction to a given ImagePlus stack
187+
Performs a simple flatfield correction to a given ImagePlus stack.
188188
189189
The function returns a 32-bit corrected flatfield image.
190190
Parameters
191191
----------
192192
imp : ij.ImagePlus
193193
The input stack to be projected.
194-
sigma: double, default 20.0
195-
The sigma value for the Gaussian blur, default = 20.0
194+
sigma: float, optional
195+
The sigma value for the Gaussian blur, default=20.0
196196
Returns
197197
-------
198198
ij.ImagePlus
199-
The 32-bit image result of the flatfield correction
199+
The 32-bit image result of flatfield correction
200200
201201
"""
202202
flatfield = imp.duplicate()

0 commit comments

Comments
 (0)