Skip to content

Commit

Permalink
adjust docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
mreineck committed Nov 13, 2024
1 parent 660d234 commit 729c3cb
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions litebird_sim/beam_convolution.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,17 +119,21 @@ def add_convolved_sky_to_observations(
Arguments
---------
obs_list: list[Observation],
observations: Union[Observation, List[Observation]],
List of Observation objects, containing detector names, pointings,
and TOD data, to which the computed TOD are added.
slm_dictionary: dict[str, any]
sky_alms: Dict[str, np.ndarray]
sky a_lm. Typically only one set of sky a_lm is needed per detector frequency
blm_dictionary: dict[str, any]
beam_alms: Dict[str, np.ndarray]
beam a_lm. Usually one set of a_lm is needed for every detector.
det2slm: dict[str, str]
converts detector name to a key for `slm_dictionary`
det2slm: dict[str, str]
converts detector name to a key for `blm_dictionary`
pointings: Union[np.ndarray, List[np.ndarray], None] = None
detector pointing information
hwp: Optional[HWP] = None
the HWP information. If `None`, we assume traditional 4pi convolution.
input_sky_alms_in_galactic: bool = True
whether the input sky alms are in galactic coordinates.
convolution_params: Optional[Dict]
collection of parameters for the convolution
component: str
name of the TOD component to which the computed data shall be added
"""
Expand Down

0 comments on commit 729c3cb

Please sign in to comment.