Skip to content

docs: rewrite reconstruction wording for end users #2

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.

Sign up for GitHub

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

Merged
samdporter merged 1 commit into from
Mar 5, 2026
Merged

docs: rewrite reconstruction wording for end users #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ install a licensed SIMIND installation.
## Key Features
- **Connector-first API** - `SimindPythonConnector` for direct SIMIND execution from Python
- **Package Adaptors** - STIR/SIRF/PyTomography adaptors for reconstruction workflows
- **No reconstruction reimplementation** - Reconstruction stays inside target packages
- **Native reconstruction workflows** - Use STIR/SIRF/PyTomography reconstruction tools with generated SIMIND data
- **Dual scoring support** - SCATTWIN and PENETRATE
- **DICOM builders** - DICOM-driven setup utilities for scanner/input preparation
- **Advanced Schneider2000 density conversion** - 44-segment HU-to-density mapping
Expand Down
5 changes: 2 additions & 3 deletions docs/backends.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Backend and Adaptor Dependencies
================================

The package uses connector-first execution: SIMIND execution is handled by
``SimindPythonConnector`` and adaptor classes layer package-specific object
conversion on top.
Use ``SimindPythonConnector`` for direct SIMIND execution from Python. Use an
adaptor when you want outputs returned as native STIR/SIRF/PyTomography types.

Dependency Matrix
-----------------
Expand Down
4 changes: 2 additions & 2 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ Changed
through ``SimindPythonConnector`` and return native backend projection types.
- ``PyTomographySimindAdaptor`` remains focused on SIMIND I/O adaptation and
tensor conversion only.
- README and docs pages were rewritten to user-facing, connector-first
guidance.
- README and docs pages were rewritten with user-facing guidance for connector
and adaptor workflows.

Fixed
~~~~~
Expand Down
5 changes: 2 additions & 3 deletions docs/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ In practice this means:
- ``SirfSimindAdaptor`` bridges SIMIND outputs into SIRF-native objects.
- ``PyTomographySimindAdaptor`` bridges SIMIND outputs into torch/PyTomography workflows.

Reconstruction algorithms are intentionally left to the target packages
(STIR, SIRF, PyTomography). The adaptor layer handles data conversion and
I/O boundaries, not reconstruction-method wrappers.
After generating projections with this package, run reconstruction directly in
STIR, SIRF, or PyTomography using each package's native reconstruction tools.

For axis and geometry conventions across these ecosystems, see :doc:`geometry`.
4 changes: 2 additions & 2 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Usage Guide
===========

Connector-First Quick Start
---------------------------
Quick Start
-----------

Use ``SimindPythonConnector`` when you want direct Python control of SIMIND
inputs/outputs without any reconstruction-package dependency.
Expand Down