Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update parameters.py #4397

Merged
merged 11 commits into from
Oct 19, 2023
29 changes: 16 additions & 13 deletions pycbc/waveform/parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -417,32 +417,34 @@ def docstr(self, prefix='', include_label=True):
dtype=float, default=0., label=r"$\delta$",
description="Mean anomaly of the periastron (rad).")
tc = Parameter("tc",
dtype=float, default=None, label=r"$t_c$ (s)",
description="Coalescence time (s).")
dtype=float, default=None, label=r"$t_c$ (s)",
description="Coalescence time (s) in "
"geocentric/SSB/LISA coords.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WuShichao Looking at this, I'd take out reference here to coordinates systems generally. I think it's going to end up being confusing.

delta_tc = Parameter("delta_tc", dtype=float,
label=r"$\Delta t_c~(\rm{s})$",
description="Coalesence time offset.")
description="Coalesence time offset in " +
"geocentric/SSB/LISA coords.")
ra = Parameter("ra",
dtype=float, default=0., label=r"$\alpha$",
description="Right ascension (rad).")
dtype=float, default=0., label=r"$\alpha$",
description="Right ascension (rad) in geocentric coords.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't make sense to say that ra/dec are in geocentric coordinates. They are uniquely defined, so there is no extra coordinate freedom.

dec = Parameter("dec",
dtype=float, default=0., label=r"$\delta$",
description="Declination (rad).")
description="Declination (rad) in geocentric coords.")
polarization = Parameter("polarization",
dtype=float, default=0., label=r"$\psi$",
description="Polarization (rad).")
description="Polarization (rad) in geocentric/SSB/LISA coords.")
redshift = Parameter("redshift",
dtype=float, default=None, label=r"$z$",
description="Redshift.")
comoving_volume = Parameter("comoving_volume", dtype=float,
label=r"$V_C~(\rm{Mpc}^3)$",
description="Comoving volume (in cubic Mpc).")
eclipticlatitude = Parameter("eclipticlatitude",
dtype=float, default=0., label=r"$\beta$",
description="eclipticlatitude wrt SSB coords.")
dtype=float, default=0., label=r"$\beta$",
description="eclipticlatitude in SSB/LISA coords.")
eclipticlongitude = Parameter("eclipticlongitude",
dtype=float, default=0., label=r"$\lambda$",
description="eclipticlongitude wrt SSB coords.")
dtype=float, default=0., label=r"$\lambda$",
description="eclipticlongitude in SSB/LISA coords.")

#
# Calibration parameters
Expand Down Expand Up @@ -553,8 +555,9 @@ def docstr(self, prefix='', include_label=True):
# =============================================================================
#

# parameters describing the location of a binary w.r.t. the Earth. Note: we
# do not include distance here. This is because these parameters are not
# parameters describing the location of a binary w.r.t.
# the geocentric/LISA/SSB frame.
# Note: we do not include distance here. This is because these are not
# passed to the waveform generators in lalsimulation, but are instead applied
# after a waveform is generated. Distance, however, is a parameter used by
# the waveform generators.
Expand Down