RF - Input to volume stats scripts

[gabknight]

Quick description

Add new input features to

• scil_volume_stats_in_labels.py

  • in_map was replaced by the argument group Metrics input options, allowing for a list of metric filenames or a metric folder;
  • if the scripts as multiple input metrics, the output json file has a new top level dict metric;
  • add add_json_args and corresponding formatting to the output json;
  • this PR changes the interface of the script, i.e. it will break other scripts using it.

• scil_volume_stats_in_ROI.py

  • change the positional argument in_mask to in_rois, allowing for multiple input mask.
  • if the scripts as multiple input ROIs, the output json file has a new top level dict roi_name;

...

Type of change

Check the relevant options.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Provide data, screenshots, command line to test (if relevant)

...

Checklist

• My code follows the style guidelines of this project (run autopep8)
• I added relevant citations to scripts, modules and functions docstrings and descriptions
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I moved all functions from the script file (except the argparser and main) to scilpy modules
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[pep8speaks]

Hello @gabknight, Thank you for updating !

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2024-12-19 20:50:56 UTC

[codecov]

Codecov Report

Attention: Patch coverage is 57.62712% with 25 lines in your changes missing coverage. Please review.

Project coverage is 69.42%. Comparing base (4d2715b) to head (7079040).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1068      +/-   ##
==========================================
+ Coverage   69.41%   69.42%   +0.01%     
==========================================
  Files         447      447              
  Lines       24046    24069      +23     
  Branches     3280     3286       +6     
==========================================
+ Hits        16691    16711      +20     
  Misses       5960     5960              
- Partials     1395     1398       +3     

Components	Coverage Δ
Scripts	70.27% <57.62%> (-0.01%)	⬇️
Library	68.30% <ø> (+0.04%)	⬆️