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

Document M0 scaling #292

Merged
merged 10 commits into from
May 16, 2023
Merged

Document M0 scaling #292

merged 10 commits into from
May 16, 2023

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented May 15, 2023

Closes #293.

Changes proposed in this pull request

  • Consistently refer to the M0 scale as m0_scale.
  • Use appropriate scale values in tests, because most of them (if not all) don't seem to be scaled already.
    • For the GE tests, use a scale value of 96 (32 base scalar * 3 repetitions).
    • For the Siemens tests, use a value of 10.
    • I don't know the appropriate value for the Philips data.
  • Remove reference to aslbids in usage page, since the package appears unmaintained and out-of-date.
  • Note in usage page that BIDS expects ASL data to already be scaled.

Documentation that should be reviewed

Usage page.

@tsalo tsalo added the testing Improving testing in the project. label May 15, 2023
@codecov-commenter
Copy link

codecov-commenter commented May 15, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.01 🎉

Comparison is base (a7ca3cc) 49.32% compared to head (7c29817) 49.34%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #292      +/-   ##
==========================================
+ Coverage   49.32%   49.34%   +0.01%     
==========================================
  Files         135      135              
  Lines       12265    12265              
==========================================
+ Hits         6050     6052       +2     
+ Misses       6215     6213       -2     
Impacted Files Coverage Δ
aslprep/cli/parser.py 86.74% <ø> (ø)
aslprep/tests/test_cli.py 100.00% <ø> (ø)
aslprep/tests/test_interfaces_cbf_computation.py 100.00% <ø> (ø)
aslprep/interfaces/cbf_computation.py 80.96% <100.00%> (ø)
aslprep/workflows/asl/base.py 85.95% <100.00%> (ø)
aslprep/workflows/asl/cbf.py 81.45% <100.00%> (+0.50%) ⬆️
aslprep/workflows/asl/gecbf.py 97.24% <100.00%> (ø)
aslprep/workflows/base.py 92.68% <100.00%> (+1.98%) ⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@tsalo tsalo changed the title Add M0 scale to tests Document M0 scaling May 16, 2023
@tsalo tsalo added the documentation Improvements or additions to documentation label May 16, 2023
@tsalo tsalo merged commit 38962f2 into PennLINC:main May 16, 2023
@tsalo tsalo deleted the scale-tests branch May 16, 2023 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation testing Improving testing in the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make it clear that BIDS datasets should already be scaled
2 participants