Skip to content

Commit

Permalink
Update the docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
tskisner committed Oct 12, 2020
1 parent 351a3ac commit 9b9d52c
Showing 1 changed file with 15 additions and 17 deletions.
32 changes: 15 additions & 17 deletions src/toast/todmap/pointing.py
Original file line number Diff line number Diff line change
Expand Up @@ -284,14 +284,13 @@ def exec(self, data):


class OpMuellerPointingHpix(Operator):
"""
Operator which generates I/Q/U healpix pointing weights.
"""Operator which generates I/Q/U healpix pointing weights.
Given the individual detector pointing, this computes the pointing weights
assuming that the detector is a linear polarizer followed by a total
power measurement. An optional dictionary of calibration factors may
be specified. Additional options include specifying a constant cross-polar
response (eps) and a rotating, perfect half-wave plate. The timestream
response (eps) and a set of HWP Mueller matrix parameters. The timestream
model is then (see Jones, et al, 2006):
.. math::
Expand Down Expand Up @@ -323,22 +322,21 @@ class OpMuellerPointingHpix(Operator):
apply_flags (bool): whether to read the TOD common flags, bitwise OR
with the common_flag_mask, and then flag the pointing matrix.
single_precision (bool): Return the pixel numbers and pointing
weights in single precision. Default=False.
weights in single precision. Default=False.
nside_submap (int): Size of a submap is 12 * nside_submap ** 2
hwp_parameters_set (tuple) : tuple of parameters describing
the Mueller Matrix [T, c,rho,s ] as defined in Bryan et al. 2010 :
.. math::
M_{HWP}=
\begin{pmatrix}
T & \rho & 0 & 0 \\
\rho & T & 0 & 0 \\
0 & 0 & c & -s \\
0 & 0 & s & c \\
\end{pmatrix}
default assumes an ideal HWP i.e. T=1,c=-1,rho=0,s=0.
the Mueller Matrix [T, c,rho,s ] as defined in Bryan et al. 2010 :
.. math::
M_{HWP}=
\begin{pmatrix}
T & \rho & 0 & 0 \\
\rho & T & 0 & 0 \\
0 & 0 & c & -s \\
0 & 0 & s & c \\
\end{pmatrix}
default assumes an ideal HWP i.e. T=1,c=-1,rho=0,s=0.
"""

Expand Down

0 comments on commit 9b9d52c

Please sign in to comment.