Skip to content

Omissions in xray.astra docs #576

@bwohlberg

Description

@bwohlberg

There are some minor omissions in the xray.astra docs:

Missing Returns: sections for _project_coords:

def _project_coords(
x_volume: np.ndarray, vol_geom: VolumeGeometry, proj_geom: ProjectionGeometry
) -> np.ndarray:
"""
Transform volume (logical) coordinates into world coordinates based
on ASTRA geometry objects.
Args:
x_volume: (..., 3) vector(s) of volume (AKA logical) coordinates
vol_geom: ASTRA volume geometry object.
proj_geom: ASTRA projection geometry object.
"""
det_shape = (proj_geom["DetectorRowCount"], proj_geom["DetectorColCount"])

and for XRayTransform2D.fbp:
def fbp(self, sino: jax.Array, filter_type: str = "Ram-Lak") -> jax.Array:
"""Filtered back projection (FBP) reconstruction.
Perform tomographic reconstruction using the filtered back
projection (FBP) algorithm.
Args:
sino: Sinogram to reconstruct.
filter_type: Select the filter to use. For a list of options
see `cfg.FilterType` in the `ASTRA documentation
<https://www.astra-toolbox.com/docs/algs/FBP_CUDA.html>`__.
"""

Clarification needed on presence of angles and vectors at

angles: Array of projection angles in radians.
vectors: Array of geometry specification vectors.

and similar clarification could be provided in docs for XRayTransform3D.__init__.

Typo in line

"""Convert ASTRA geometry specificiation to a SCICO projection matrix.

Use of "parallel3d_vec" format appears to be incompatible with angles option referred to above:

projection matrix, assuming "parallel3d_vec" format.

It would also be worth adding some discussion of the meaning of "world coordinates" referred to in functions such as project_world_coordinates.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions