Documentation: Update documentation on reconstruction algorithms#3157
Documentation: Update documentation on reconstruction algorithms#3157RasmiaKulan wants to merge 4 commits into
Conversation
|
There is naturally some crossover between Diátaxis categories in pages like this, especially for technical algorithm documentation where users benefit from both conceptual guidance and reference information together. The mix of explanation, parameter details, implementation notes, and usage guidance works reasonably well here, but it does make the page span multiple documentation categories. It may be worth having a team discussion about how strictly we want to apply the Diátaxis model for technical overview pages like this. |
|
|
||
| When to use FBP_CUDA | ||
| """""""""""""""""""" | ||
|
|
There was a problem hiding this comment.
This section explains when to use FBP_CUDA, but it does not yet explain why filtered back projection behaves differently from iterative methods.
|
|
||
| Have a look at our refine iterations tool on the Reconstruct tab of the Reconstruction window that | ||
| should assist you in finding the optimal number of rotations for your data. | ||
| Overview |
There was a problem hiding this comment.
This section would benefit from a short explanation of how iterative reconstruction works conceptually.
There was a problem hiding this comment.
SIRT progressively refines the reconstruction by repeatedly comparing simulated projections against measured projection data and correcting the reconstruction estimate over multiple iterations.
| gridrec | ||
| ^^^^^^^ | ||
| This filter is from the TomoPy package. | ||
|
|
There was a problem hiding this comment.
The gridrec section currently focuses mainly on implementation details and usage recommendations.
Consider briefly explaining how Fourier-based reconstruction differs from iterative methods, why gridrec performs well on CPUs, and what tradeoffs exist compared with GPU-based approaches.
This would help users understand how gridrec differs conceptually from the other reconstruction algorithms.
| * - Pixel size (microns) | ||
| - Defines the physical pixel spacing used to convert image distances into real-world units, ensuring correct scaling of attenuation coefficients (e.g. cm⁻¹). | ||
|
|
||
| References |
There was a problem hiding this comment.
This page may fit more naturally within the Reference section rather than Explanation.
|
|
||
| When to use PDHG-TV | ||
| """"""""""""""""""" | ||
|
|
There was a problem hiding this comment.
The new “When to use” sections are a strong improvement. Consider making the recommendations more comparative, such as explaining when to use SIRT_CUDA instead of FBP_CUDA or when PDHG-TV may outperform SIRT. This would help users understand the tradeoffs between algorithms more clearly
There was a problem hiding this comment.
Or a small comparison table would strengthen the Explanation focus of the page and help users choose an appropriate algorithm more confidently.
| :alt: PDHG-TV in reconstruction window | ||
| :width: 60% | ||
| :align: center | ||
| :class: only-light |
| ASTRA Toolbox | ||
| ---------------------- | ||
| These filters are used from the ASTRA Toolbox package. | ||
| ------------- |
There was a problem hiding this comment.
The geometry explanation is good, but this section could briefly explain why parallel beam vector geometry matters For example: how tilt correction improves reconstruction quality, or how automatic geometry generation simplifies workflows.
This would better connect implementation details to reconstruction behaviour.
Issue Closes #1839
Description
Restructured the current algorithm documentation to:
gridrec,FBP_CUDAandSIRT_CUDADeveloper Testing
python -m pytest -vsAcceptance Criteria and Reviewer Testing
python -m pytest -vsmake build-docscd docs/build/htmlpython -m http.server 8000Documentation and Additional Notes