Skip to content

Commit

Permalink
Improve docstring so it mentions polarization shorthand
Browse files Browse the repository at this point in the history
  • Loading branch information
philbull committed Apr 16, 2019
1 parent 752afe2 commit 8ba0838
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions hera_pspec/pspecdata.py
Original file line number Diff line number Diff line change
Expand Up @@ -1852,11 +1852,12 @@ def pspec(self, bls1, bls2, dsets, pols, n_dlys=None,
where the first index is for the Left-Hand dataset and second index
is used for the Right-Hand dataset (see above).
pols : length-2 tuple of strings or integers, or list of length-2
tuples of strings or integers
pols : tuple or list of tuple
Contains polarization pairs to use in forming power spectra
e.g. ('XX','XX') or [('XX','XX'),('pI','pI')] or list of
polarization pairs.
e.g. ('XX','XX') or [('XX','XX'),('pI','pI')] or a list of
polarization pairs. Individual strings are also supported, and will
be expanded into a matching pair of polarizations, e.g. 'xx'
becomes ('xx', 'xx').
If a primary_beam is specified, only equal-polarization pairs can
be cross-correlated, as the beam scalar normalization is only
Expand Down

0 comments on commit 8ba0838

Please sign in to comment.