Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bwohlberg committed Oct 15, 2024
1 parent b6bded8 commit 62f0a50
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions scico/linop/xray/_xray.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ def __init__(
corresponds to summing along antidiagonals.
x0: (x, y) position of the corner of the pixel `im[0,0]`. By
default, `(-input_shape * dx[0] / 2, -input_shape * dx[1] / 2)`.
dx: Image pixel side length in x- and y-direction. Must be
set so that the width of a projected pixel is never
larger than 1.0. By default, [:math:`\sqrt{2}/2`,
:math:`\sqrt{2}/2`].
dx: Image pixel side length in x- and y-direction (axis 0 and
1 respectively). Must be set so that the width of a
projected pixel is never larger than 1.0. By default,
[:math:`\sqrt{2}/2`, :math:`\sqrt{2}/2`].
y0: Location of the edge of the first detector bin. By
default, `-det_count / 2`
det_count: Number of elements in detector. If ``None``,
Expand Down Expand Up @@ -150,7 +150,8 @@ def fbp(self, y: ArrayLike) -> snp.Array:
:cite:`kak-1988-principles` and then back projecting. The
projection angles are assumed to be evenly spaced in
:math:`[0, \pi)`; reconstruction quality may be poor if
this assumption is violated.
this assumption is violated. Poor quality reconstructions should
also be expected when `dx[0]` and `dx[1]` are not equal.
Args:
y: Input projection, (num_angles, N).
Expand Down

0 comments on commit 62f0a50

Please sign in to comment.