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

Improve docs for 3D astra X-ray transform #544

Merged
merged 16 commits into from
Jul 22, 2024
Merged

Conversation

bwohlberg
Copy link
Collaborator

@bwohlberg bwohlberg commented Jul 19, 2024

Improve docs for 3D astra X-ray transform. Also move existing matplotlib figures from the submodule to the main repo.

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Jul 19, 2024
Copy link

codecov bot commented Jul 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.23%. Comparing base (d9026d3) to head (0e97c58).
Report is 22 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #544      +/-   ##
==========================================
- Coverage   94.67%   92.23%   -2.44%     
==========================================
  Files          91       91              
  Lines        5707     5910     +203     
==========================================
+ Hits         5403     5451      +48     
- Misses        304      459     +155     
Flag Coverage Δ
unittests 92.23% <ø> (-2.44%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

The voxels sides have unit length (in arbitrary units), which defines
the scale for all other dimensions in the source-volume-detector
configuration. Geometry axes `x`, `y`, and `z` correspond to volume
array axes 0, 1, and 2 respectively. The projected array axes 0, 1,
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider remarking that this is different from astra's default interface, were I think x y z corresponds to 2 1 0.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good catch - fixed.

detector (i.e. in the direction of :math:`\mb{d}` in the figure.) In
practice, since the volume-detector distance does not have a
geometric effect for a parallel-beam configuration, :math:`\mb{d}`
may be set to the zero vector. Note that the view images must be
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that d is useful for handling offsets in the center of rotation, i.e., situations where the center column of a projection view doesn't match up with the rotation axis. Put another way, because it's parallel ray, the component of d perpendicular to the detector doesn't matter, but the other components do matter.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Phrasing modified to avoid over-simplification.

@bwohlberg bwohlberg merged commit 3d3d849 into main Jul 22, 2024
18 checks passed
@bwohlberg bwohlberg deleted the brendt/3dxray_docs branch July 22, 2024 20:33
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants