update parameters.py (#4397)

* update parameters.py * fix cc issue * Update parameters.py * Update parameters.py * fix cc issues * Update parameters.py
gwastro · Oct 19, 2023 · e8f0b82 · e8f0b82
1 parent 8ab4471
commit e8f0b82
Showing 1 changed file with 14 additions and 11 deletions.
diff --git a/pycbc/waveform/parameters.py b/pycbc/waveform/parameters.py
@@ -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) is the time when a GW "
+                           "reaches the origin of a certain coordinate system.")
 delta_tc = Parameter("delta_tc", dtype=float,
                      label=r"$\Delta t_c~(\rm{s})$",
                      description="Coalesence time offset.")
 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).")
 dec = Parameter("dec",
                 dtype=float, default=0., label=r"$\delta$",
                 description="Declination (rad).")
 polarization = Parameter("polarization",
                 dtype=float, default=0., label=r"$\psi$",
-                description="Polarization (rad).")
+                description="Polarization angle (rad) in "
+                            "a certain coordinate system.")
 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
@@ -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.