Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaning reconst scripts part2 #924

Merged
merged 16 commits into from
Mar 5, 2024

Conversation

EmmaRenauld
Copy link
Contributor

@EmmaRenauld EmmaRenauld commented Feb 26, 2024

Quick description

Part 2 in my meticulous verification of reconst scripts. Read the 9 next scripts in our excel list!

Almost all already correct! Changes a few small code style along the way. The only real changes:

  • In fodf_max_in_ventricles:
    - Removed the "useful for 2D data" in the help. We don't manage the 2D. We manage 3D data with one dimension set to 1, but we don't add the 3rd dimension ourselves.
    - Changed the method it calls so that we don't send args. Will be easier to create a script.
  • scil_freewater_priors: only calls noddi_priors, but had a coverage of 0%. Added a test.

That's it!
...

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
  • Verifications

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

Copy link
Contributor

@karanphil karanphil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few minor comments! Good job.

scripts/scil_fodf_max_in_ventricles.py Show resolved Hide resolved
scripts/scil_freewater_priors.py Show resolved Hide resolved
scripts/scil_frf_ssst.py Show resolved Hide resolved
Copy link

codecov bot commented Feb 27, 2024

Codecov Report

Attention: Patch coverage is 73.39450% with 29 lines in your changes are missing coverage. Please review.

Project coverage is 69.46%. Comparing base (d319ad2) to head (c32176a).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #924      +/-   ##
==========================================
+ Coverage   69.38%   69.46%   +0.07%     
==========================================
  Files         389      389              
  Lines       20997    20989       -8     
  Branches     3231     3225       -6     
==========================================
+ Hits        14568    14579      +11     
+ Misses       5114     5102      -12     
+ Partials     1315     1308       -7     
Components Coverage Δ
Scripts 71.99% <86.15%> (+0.18%) ⬆️
Library 65.19% <54.54%> (-0.07%) ⬇️

@EmmaRenauld EmmaRenauld force-pushed the cleaning_reconst_scripts_part2 branch from fa83075 to 93ce647 Compare February 28, 2024 16:16
@pep8speaks
Copy link

pep8speaks commented Feb 28, 2024

Hello @EmmaRenauld, Thank you for updating !

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

Comment last updated at 2024-02-29 21:31:15 UTC

@EmmaRenauld
Copy link
Contributor Author

EmmaRenauld commented Feb 28, 2024

Finally I added a bit more changes!

  • Combined common sections in fodf_memst, fodf_msmt.
  • Added small changes in bingham_metrics, which I just found was not in our excel sheet.
  • Encapsulated things in frf_set_diffusivities.

Overall, I thus have mainly small changes, and 4 new functions (created without changing any line of code!). I was not always sure where to put them though.

Copy link
Contributor

@arnaudbore arnaudbore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some quick comments. LGTM

scilpy/reconst/sh.py Show resolved Hide resolved
scilpy/reconst/fodf.py Show resolved Hide resolved
Copy link
Contributor

@arnaudbore arnaudbore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick fix and then GTG

scilpy/reconst/fodf.py Show resolved Hide resolved
@EmmaRenauld EmmaRenauld force-pushed the cleaning_reconst_scripts_part2 branch from 355cf70 to c32176a Compare March 1, 2024 17:59
Copy link
Contributor

@arnaudbore arnaudbore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems GTG !

@arnaudbore arnaudbore merged commit 02b2363 into scilus:master Mar 5, 2024
2 checks passed
@EmmaRenauld EmmaRenauld deleted the cleaning_reconst_scripts_part2 branch March 5, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants