Skip to content

Commit 65daf40

Browse files
author
Laurent Guerard
committed
fix(docs): add missing dots at the end of docstrings.
1 parent 555c60c commit 65daf40

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

src/imcflibs/imagej/processing.py

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ def filter_options(filter_method, filter_radius, do_3d=False):
2222
- Minimum
2323
- Maximum
2424
filter_radius : int
25-
Radius of the filter to use
25+
Radius of the filter to use.
2626
do_3d : bool, optional
27-
If set to True, will do a 3D filtering, by default False
27+
If set to True, will do a 3D filtering, by default False.
2828
2929
Returns
3030
-------
@@ -51,10 +51,10 @@ def threshold_options(threshold_method, do_3d=True):
5151
Parameters
5252
----------
5353
threshold_method : str
54-
Name of the threshold method to use
54+
Name of the threshold method to use.
5555
do_3d : bool, optional
5656
If set to True, the automatic threshold will be done on a 3D stack,
57-
by default True
57+
by default True.
5858
5959
Returns
6060
-------
@@ -80,7 +80,7 @@ def apply_filter(imp, filter_method, filter_radius, do_3d=False):
8080
Parameters
8181
----------
8282
imp : ImagePlus
83-
Input ImagePlus to filter and threshold
83+
Input ImagePlus to filter and threshold.
8484
filter_method : str
8585
Name of the filter method to use. Must be one of:
8686
- Median
@@ -89,9 +89,9 @@ def apply_filter(imp, filter_method, filter_radius, do_3d=False):
8989
- Minimum
9090
- Maximum
9191
filter_radius : int
92-
Radius of the filter filter to use
92+
Radius of the filter filter to use.
9393
do_3d : bool, optional
94-
If set to True, will do a 3D filtering, by default False
94+
If set to True, will do a 3D filtering, by default False.
9595
9696
9797
Returns
@@ -135,17 +135,17 @@ def apply_rollingball_bg_subtraction(
135135
Parameters
136136
----------
137137
imp : ij.ImagePlus
138-
Input ImagePlus to filter and threshold
138+
Input ImagePlus to filter and threshold.
139139
rolling_ball_radius : int
140-
Radius of the rolling ball filter to use
140+
Radius of the rolling ball filter to use.
141141
light_background : bool, optional
142-
If set to True, will treat the background as light, by default False
142+
If set to True, will treat the background as light, by default False.
143143
sliding : bool, optional
144-
If set to True, will do a sliding window approach, by default False
144+
If set to True, will do a sliding window approach, by default False.
145145
disable_smoothing : bool, optional
146-
If set to True, will disable the smoothing, by default False
146+
If set to True, will disable the smoothing, by default False.
147147
do_3d : bool, optional
148-
If set to True, will do a 3D filtering, by default False
148+
If set to True, will do a 3D filtering, by default False.
149149
150150
Returns
151151
-------
@@ -182,15 +182,15 @@ def rolling_ball_options(
182182
Parameters
183183
----------
184184
rolling_ball_radius : int
185-
Radius of the rolling ball filter to use
185+
Radius of the rolling ball filter to use.
186186
light_background : bool, optional
187-
If set to True, will treat the background as light, by default False
187+
If set to True, will treat the background as light, by default False.
188188
sliding : bool, optional
189-
If set to True, will do a sliding window approach, by default False
189+
If set to True, will do a sliding window approach, by default False.
190190
disable_smoothing : bool, optional
191-
If set to True, will disable the smoothing, by default False
191+
If set to True, will disable the smoothing, by default False.
192192
do_3d : bool, optional
193-
If set to True, will do a 3D filtering, by default False
193+
If set to True, will do a 3D filtering, by default False.
194194
195195
Returns
196196
-------
@@ -216,12 +216,12 @@ def apply_threshold(imp, threshold_method, do_3d=True):
216216
Parameters
217217
----------
218218
imp : ij.ImagePlus
219-
Input ImagePlus to filter and threshold
219+
Input ImagePlus to filter and threshold.
220220
threshold_method : str
221-
Name of the threshold method to use
221+
Name of the threshold method to use.
222222
do_3d : bool, optional
223223
If set to True, the automatic threshold will be done on a 3D stack,
224-
by default True
224+
by default True.
225225
226226
Returns
227227
-------

0 commit comments

Comments
 (0)