From 24edb1b404604bdad674617786877d8ae07afa3f Mon Sep 17 00:00:00 2001 From: sgiardie Date: Fri, 9 Aug 2024 16:49:38 +0200 Subject: [PATCH] fixing docs in hwp_sys --- litebird_sim/hwp_sys/hwp_sys.py | 78 +++++++++++++-------------------- 1 file changed, 31 insertions(+), 47 deletions(-) diff --git a/litebird_sim/hwp_sys/hwp_sys.py b/litebird_sim/hwp_sys/hwp_sys.py index 09c343de..45edbb2c 100644 --- a/litebird_sim/hwp_sys/hwp_sys.py +++ b/litebird_sim/hwp_sys/hwp_sys.py @@ -1129,53 +1129,37 @@ def fill_tod( dtype_pointings=np.float32, ): r"""It fills tod and/or :math:`A^T A` and :math:`A^T d` for the - "on the fly" map production - - Args: - - observations (:class:`Observation`): container for tod. If the tod is - not required, you can avoid allocating ``observations.tod`` - i.e. in ``lbs.Observation`` use ``allocate_tod=False``. - - 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). - <<<<<<< HEAD - 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. - >>>>>>> 87b0eaa34357e6dc6870500f85a2d3a894bce45e - - 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). - 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, - <<<<<<< HEAD - ``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) - ======= - ``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). - >>>>>>> 87b0eaa34357e6dc6870500f85a2d3a894bce45e + "on the fly" map production + + Args: + + observations (:class:`Observation`): container for tod. If the tod is + not required, you can avoid allocating ``observations.tod`` + i.e. in ``lbs.Observation`` use ``allocate_tod=False``. + + 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. + + 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). + 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. + + dtype_pointings: if ``pointings`` is None and is computed within ``fill_tod``, this + is the dtype for pointings and tod (default: np.float32). """ if pointings is None: