Additional options for rolling ball background subtraction#143
Additional options for rolling ball background subtraction#143lguerard wants to merge 13 commits into
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## devel #143 +/- ##
====================================
+ Coverage 30% 33% +3%
====================================
Files 25 25
Lines 1763 1806 +43
====================================
+ Hits 527 591 +64
+ Misses 1236 1215 -21 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
lguerard
force-pushed
the
rollingball_options
branch
from
d33a0a6 to
cd48fac
Compare
ehrenfeu
changed the title
ehrenfeu
added
enhancement
|
Please add test 🧪 coverage 🕵🏼 - I've started a basic one in 373a05c but since this is just about generating strings and calling macro commands, we should be able to reach full 🚀 coverage. |
| def filter_options(filter_method, filter_radius, do_3d=False): | ||
| """Build the ImageJ filter command and options strings.""" | ||
|
|
There was a problem hiding this comment.
Docstring is missing parameters description (simply copy the relevant parts from the apply_filter() function).
Actually the ruff linter should complain about this but we need to wait until ruff-pr-21076 has been merged (cf. #148) ... ⏳
There was a problem hiding this comment.
Yep, almost. Now just finish the sentences with a full stop ".".
There was a problem hiding this comment.
One more . in the Returns section missing.
|
|
||
| def threshold_options(threshold_method, do_3d=True): | ||
| """Build the ImageJ threshold option strings.""" | ||
|
|
There was a problem hiding this comment.
Docstring is missing parameters description (simply copy the relevant parts from the apply_filter() function).
Actually the ruff linter should complain about this but we need to wait until ruff-pr-21076 has been merged (cf. #148) ... ⏳
There was a problem hiding this comment.
Two things in one:
- One more . in the Returns section missing.
- While at this, please also remove the empty line between the
Returnssection and the closing"""of the docstring.
Update parameter names for clarity
| def filter_options(filter_method, filter_radius, do_3d=False): | ||
| """Build the ImageJ filter command and options strings.""" | ||
|
|
There was a problem hiding this comment.
Yep, almost. Now just finish the sentences with a full stop ".".
|
|
||
| def threshold_options(threshold_method, do_3d=True): | ||
| """Build the ImageJ threshold option strings.""" | ||
|
|
| rolling_ball_radius : int | ||
| Radius of the rolling ball filter to use | ||
| light_background : bool, optional | ||
| If set to True, will treat the background as light, by default False | ||
| sliding : bool, optional | ||
| If set to True, will do a sliding window approach, by default False | ||
| disable_smoothing : bool, optional | ||
| If set to True, will disable the smoothing, by default False | ||
| do_3d : bool, optional | ||
| If set to True, will do a 3D filtering, by default False | ||
|
|
||
| Returns | ||
| ------- | ||
| str | ||
| The options string for the "Subtract Background..." macro command |
| def filter_options(filter_method, filter_radius, do_3d=False): | ||
| """Build the ImageJ filter command and options strings.""" | ||
|
|
There was a problem hiding this comment.
One more . in the Returns section missing.
|
|
||
| def threshold_options(threshold_method, do_3d=True): | ||
| """Build the ImageJ threshold option strings.""" | ||
|
|
There was a problem hiding this comment.
Two things in one:
- One more . in the Returns section missing.
- While at this, please also remove the empty line between the
Returnssection and the closing"""of the docstring.
| rolling_ball_radius : int | ||
| Radius of the rolling ball filter to use | ||
| light_background : bool, optional | ||
| If set to True, will treat the background as light, by default False | ||
| sliding : bool, optional | ||
| If set to True, will do a sliding window approach, by default False | ||
| disable_smoothing : bool, optional | ||
| If set to True, will disable the smoothing, by default False | ||
| do_3d : bool, optional | ||
| If set to True, will do a 3D filtering, by default False | ||
|
|
||
| Returns | ||
| ------- | ||
| str | ||
| The options string for the "Subtract Background..." macro command |
2 participants
feat: Enhance rolling ball background subtraction with additional opt…
…ions