Add caveat on 3D X-ray projector #554
Conversation
Michael-T-McCann
force-pushed
the
mike/caveat
branch
from
18e0be4
to
dae6367
Compare
Michael-T-McCann
force-pushed
the
mike/caveat
branch
from
dae6367
to
48dcba0
Compare
| @@ -235,6 +235,9 @@ def _calc_weights( | |||
| class XRayTransform3D(LinearOperator): | |||
| r"""General-purpose, 3D, parallel ray X-ray projector. | |||
|
|
|||
| Warning: This class is experimental and may be up to ten times slower | |||
| than :class:`scico.linop.xray.astra.XRayTransform3D`. | |||
There was a problem hiding this comment.
Perhaps add some positive aspects, e.g. "It is expected to be useful for small problems as, unlike :class:scico.linop.xray.astra.XRayTransform3D, it can be run on both CPU and GPU, and the forward and adjoint transforms are differentiable." [The differentiable claim should be confirmed before inclusion!]
There was a problem hiding this comment.
Differentiable wrt to x, definitely, but so is scico.linop.xray.astra.XRayTransform3D in the way we've wrapped it. I'm not sure about differentiable wrt to the angles. I'd like to call that out of scope for this PR.
How about
This projector approximates cubical voxels projecting onto rectangular pixels and provides a back projector that is the true adjoint of the forward projector. It is written purely in JAX, allowing it to run on either CPU or GPU and minimizing host copies.
Warning: This class is experimental and may be up to ten times slower than scico.linop.xray.astra.XRayTransform3D.
Add caveat on 3D X-ray projector.