Skip to content

Commit

Permalink
Merge pull request #328 from litebird/fixdoc
Browse files Browse the repository at this point in the history
fixing docs in hwp_sys
  • Loading branch information
sgiardie authored Oct 23, 2024
2 parents 0cea672 + 9cd60aa commit 0c00784
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions litebird_sim/hwp_sys/hwp_sys.py
Original file line number Diff line number Diff line change
Expand Up @@ -1130,7 +1130,7 @@ def fill_tod(
save_tod: bool = False,
dtype_pointings=np.float32,
):
r"""Fill the TOD and/or :math:`A^T A` and :math:`A^T d` for
r"""It fills tod and/or :math:`A^T A` and :math:`A^T d` for the
"on the fly" map production
Args:
Expand All @@ -1142,29 +1142,29 @@ def fill_tod(
pointings (optional): if not passed, it is either computed on the fly
(generated by :func:`lbs.get_pointings` per detector),
or read from ``observations.pointing_matrix`` (if present).
if ``observations`` is not a list, ``pointings`` must be a np.array
of dimensions (N_det, N_samples, 3)
if ``observations`` is a list, ``pointings`` must be a list of same length
When generating pointing information, set the variable
``hwp`` to None since the hwp rotation angle is added to
the orientation angle within the ``fill_tod`` function.
If ``observations`` is not a list, ``pointings`` must be a np.array
of dimensions (N_det, N_samples, 3).
If ``observations`` is a list, ``pointings`` must be a list of same length.
hwp_angle (optional): `2ωt`, hwp rotation angles (radians). If ``pointings`` is passed,
``hwp_angle`` must be passed as well, otherwise both must be ``None``.
If not passed, it is computed on the fly (generated by :func:`lbs.get_pointings`
per detector).
If ``observations`` is not a list, ``hwp_angle`` must be a np.array
of dimensions (N_samples).
of dimensions (N_samples).
If ``observations`` is a list, ``hwp_angle`` must be a list of same length.
input_map_in_galactic (bool): if True, the input map is in galactic coordinates, pointings
are rotated from ecliptic to galactic and output map will also be in galactic.
save_tod (bool): if True, ``tod`` is saved in ``observations.tod``; if False,
``tod`` gets deleted
``tod`` gets deleted.
dtype_pointings: if ``pointings`` is None and is computed within ``fill_tod``, this
is the dtype for pointings and tod (default: np.float32)
is the dtype for pointings and tod (default: np.float32).
"""

if pointings is None:
Expand Down

0 comments on commit 0c00784

Please sign in to comment.