Skip to content

Conversation

@jhlegarreta
Copy link
Contributor

Generalize iterators to accept bvals or uptake as keyword arguments. The previous implementation of the linear, random and centralsym iterators was only accepting bvals. This patch set allows these iterators to work with PET data through the uptake argument.

Document the functions by explicitly assigning the docstring to the __doc__ property of each function so that the SIZE_KEYS_DOC can be reused and to allow the examples be run by the doctring tests.

@jhlegarreta jhlegarreta force-pushed the enh/generalize-iterators branch from 08c29dc to 80de628 Compare September 27, 2025 21:06
@jhlegarreta
Copy link
Contributor Author

jhlegarreta commented Sep 27, 2025

Partially addresses #230. It remains the question about the bvalue and uptake iterators: #230 (comment).

@codecov
Copy link

codecov bot commented Sep 27, 2025

Codecov Report

❌ Patch coverage is 40.90909% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.38%. Comparing base (a2bae01) to head (87ca171).

Files with missing lines Patch % Lines
src/nifreeze/utils/iterators.py 40.90% 10 Missing and 3 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #238      +/-   ##
==========================================
- Coverage   78.65%   78.38%   -0.28%     
==========================================
  Files          24       24              
  Lines        1443     1457      +14     
  Branches      166      168       +2     
==========================================
+ Hits         1135     1142       +7     
- Misses        237      244       +7     
  Partials       71       71              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Generalize iterators to accept `bvals` or `uptake` as keyword arguments.
The previous implementation of the linear, random and centralsym
iterators was only accepting `bvals`. This patch set allows these
iterators to work with PET data through the `uptake` argument.

Document the functions by explicitly assigning the docstring to the
`__doc__` property of each function so that the `SIZE_KEYS_DOC` can be
reused and to allow the examples be run by the doctring tests.
@jhlegarreta jhlegarreta force-pushed the enh/generalize-iterators branch from 80de628 to 87ca171 Compare October 9, 2025 20:33
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.

1 participant