Coverage for pesummary/gw/file/standard_names.py: 100.0%
47 statements
« prev ^ index » next coverage.py v7.4.4, created at 2025-11-05 13:38 +0000
1# Licensed under an MIT style license -- see LICENSE.md
3from itertools import combinations
5__author__ = ["Charlie Hoy <charlie.hoy@ligo.org>"]
6_IFOS = sorted(["H1", "L1", "V1", "K1", "E1"])
7_IFO_combinations = list(combinations(_IFOS, 2))
8tidal_params = ["lambda_1", "lambda_2", "delta_lambda", "lambda_tilde"]
11lalinference_map = {
12 "logl": "log_likelihood",
13 "logprior": "log_prior",
14 "matched_filter_snr": "network_matched_filter_snr",
15 "optimal_snr": "network_optimal_snr",
16 "phi12": "phi_12",
17 "q": "mass_ratio",
18 "time": "geocent_time",
19 "logdistance": "log_luminosity_distance",
20 "dist": "luminosity_distance",
21 "mc": "chirp_mass",
22 "a1": "a_1",
23 "a2": "a_2",
24 "tilt1": "tilt_1",
25 "tilt2": "tilt_2",
26 "m1": "mass_1",
27 "m2": "mass_2",
28 "eta": "symmetric_mass_ratio",
29 "mtotal": "total_mass",
30 "h1_end_time": "H1_time",
31 "l1_end_time": "L1_time",
32 "v1_end_time": "V1_time",
33 "h1l1_delay": "H1_L1_time_delay",
34 "l1v1_delay": "L1_V1_time_delay",
35 "h1v1_delay": "H1_V1_time_delay",
36 "a1z": "spin_1z",
37 "a2z": "spin_2z",
38 "m1_source": "mass_1_source",
39 "m2_source": "mass_2_source",
40 "mtotal_source": "total_mass_source",
41 "mc_source": "chirp_mass_source",
42 "phi1": "phi_1",
43 "phi2": "phi_2",
44 "costilt1": "cos_tilt_1",
45 "costilt2": "cos_tilt_2",
46 "costheta_jn": "cos_theta_jn",
47 "cosiota": "cos_iota",
48 "lambda1": "lambda_1",
49 "lambda2": "lambda_2",
50 "lambdaT": "lambda_tilde",
51 "dLambdaT": "delta_lambda",
52 "logp1": "log_pressure",
53 "gamma1": "gamma_1",
54 "gamma2": "gamma_2",
55 "gamma3": "gamma_3",
56 "SDgamma0": "spectral_decomposition_gamma_0",
57 "SDgamma1": "spectral_decomposition_gamma_1",
58 "SDgamma2": "spectral_decomposition_gamma_2",
59 "SDgamma3": "spectral_decomposition_gamma_3",
60 "sdgamma0": "spectral_decomposition_gamma_0",
61 "sdgamma1": "spectral_decomposition_gamma_1",
62 "sdgamma2": "spectral_decomposition_gamma_2",
63 "sdgamma3": "spectral_decomposition_gamma_3",
64 "mf_evol_avg": "final_mass",
65 "mf_nonevol": "final_mass_non_evolved",
66 "mf_source_evol_avg": "final_mass_source",
67 "mf_source_nonevol": "final_mass_source_non_evolved",
68 "af_nonevol": "final_spin_non_evolved",
69 "af_evol_avg": "final_spin",
70 "l_peak_evol_avg": "peak_luminosity",
71 "l_peak_nonevol": "peak_luminosity_non_evolved",
72 "e_rad_nonevol": "radiated_energy_non_evolved",
73 "e_rad_evol_avg": "radiated_energy",
74 "beta": "beta"
75}
78for detector in _IFOS:
79 lalinference_map["{}_cplx_snr_amp".format(detector.lower())] = (
80 "{}_matched_filter_abs_snr".format(detector)
81 )
82 lalinference_map["{}_cplx_snr_arg".format(detector.lower())] = (
83 "{}_matched_filter_snr_angle".format(detector)
84 )
85 lalinference_map["{}_optimal_snr".format(detector.lower())] = (
86 "{}_optimal_snr".format(detector)
87 )
90bilby_map = {
91 "chirp_mass": "chirp_mass",
92 "mass_ratio": "mass_ratio",
93 "a_1": "a_1",
94 "a_2": "a_2",
95 "tilt_1": "tilt_1",
96 "tilt_2": "tilt_2",
97 "phi_12": "phi_12",
98 "phi_jl": "phi_jl",
99 "dec": "dec",
100 "ra": "ra",
101 "theta_jn": "theta_jn",
102 "psi": "psi",
103 "luminosity_distance": "luminosity_distance",
104 "phase": "phase",
105 "geocent_time": "geocent_time",
106 "log_likelihood": "log_likelihood",
107 "log_prior": "log_prior",
108 "reference_frequency": "reference_frequency",
109 "total_mass": "total_mass",
110 "mass_1": "mass_1",
111 "mass_2": "mass_2",
112 "symmetric_mass_ratio": "symmetric_mass_ratio",
113 "iota": "iota",
114 "spin_1x": "spin_1x",
115 "spin_1y": "spin_1y",
116 "spin_1z": "spin_1z",
117 "spin_2x": "spin_2x",
118 "spin_2y": "spin_2y",
119 "spin_2z": "spin_2z",
120 "phi_1": "phi_1",
121 "phi_2": "phi_2",
122 "chi_eff": "chi_eff",
123 "chi_p": "chi_p",
124 "redshift": "redshift",
125 "mass_1_source": "mass_1_source",
126 "mass_2_source": "mass_2_source",
127 "chirp_mass_source": "chirp_mass_source",
128 "total_mass_source": "total_mass_source",
129 "lambda_1": "lambda_1",
130 "lambda_2": "lambda_2",
131 "lambda_tilde": "lambda_tilde",
132 "cos_iota": "cos_iota",
133 "cos_theta_jn": "cos_theta_jn",
134}
137for detector in _IFOS:
138 bilby_map["{}_matched_filter_snr_abs".format(detector)] = (
139 "{}_matched_filter_snr_abs".format(detector)
140 )
141 bilby_map["{}_matched_filter_snr_angle".format(detector)] = (
142 "{}_matched_filter_snr_angle".format(detector)
143 )
144 bilby_map["{}_optimal_snr".format(detector)] = (
145 "{}_optimal_snr".format(detector)
146 )
149pycbc_map = {
150 "mchirp": "chirp_mass",
151 "srcmchirp": "chirp_mass_source",
152 "coa_phase": "phase",
153 "loglikelihood": "log_likelihood",
154}
157pesummary_map = {
158 "network_21_multipole_snr": "network_21_multipole_snr",
159 "network_33_multipole_snr": "network_33_multipole_snr",
160 "network_44_multipole_snr": "network_44_multipole_snr",
161 "network_precessing_snr": "network_precessing_snr",
162 "chirp_mass_source": "chirp_mass_source",
163 "delta_lambda": "delta_lambda",
164 "viewing_angle": "viewing_angle",
165 "tilt_1_infinity": "tilt_1_infinity",
166 "spin_1z_infinity": "spin_1z_infinity",
167 "spin_1z_infinity_only_prec_avg": "spin_1z_infinity_only_prec_avg",
168 "tilt_2_infinity": "tilt_2_infinity",
169 "spin_2z_infinity": "spin_2z_infinity",
170 "spin_2z_infinity_only_prec_avg": "spin_2z_infinity_only_prec_avg",
171 "tilt_1_infinity_only_prec_avg": "tilt_1_infinity_only_prec_avg",
172 "tilt_2_infinity_only_prec_avg": "tilt_2_infinity_only_prec_avg",
173 "chi_eff_infinity": "chi_eff_infinity",
174 "chi_eff_infinity_only_prec_avg": "chi_eff_infinity_only_prec_avg",
175 "chi_p_infinity": "chi_p_infinity",
176 "chi_p_infinity_only_prec_avg": "chi_p_infinity_only_prec_avg",
177 "cos_tilt_1_infinity": "cos_tilt_1_infinity",
178 "cos_tilt_2_infinity": "cos_tilt_2_infinity",
179 "cos_tilt_1_infinity_only_prec_avg": "cos_tilt_1_infinity_only_prec_avg",
180 "cos_tilt_2_infinity_only_prec_avg": "cos_tilt_2_infinity_only_prec_avg",
181 "spin_1z": "spin_1z",
182 "spin_2z": "spin_2z",
183 "chi_p_2spin": "chi_p_2spin",
184 "peak_luminosity": "peak_luminosity",
185 "peak_luminosity_non_evolved": "peak_luminosity_non_evolved",
186 "final_mass": "final_mass",
187 "final_mass_non_evolved": "final_mass_non_evolved",
188 "final_spin": "final_spin",
189 "final_spin_non_evolved": "final_spin_non_evolved",
190 "radiated_energy": "radiated_energy",
191 "radiated_energy_non_evolved": "radiated_energy_non_evolved",
192 "weights": "weights",
193 "psi_J": "psi_J",
194 "polarization_J": "psi_J",
195 "opening_angle": "beta",
196 "beta0": "beta",
197 "rho_21": "network_21_multipole_snr",
198 "network_rho_21_perp": "network_21_multipole_snr",
199 "rho_33": "network_33_multipole_snr",
200 "network_rho_33_perp": "network_33_multipole_snr",
201 "rho_44": "network_44_multipole_snr",
202 "network_rho_44_perp": "network_44_multipole_snr",
203 "rho_p": "network_precessing_snr",
204 "final_kick": "final_kick",
205 "tidal_disruption_frequency": "tidal_disruption_frequency",
206 "tidal_disruption_frequency_ratio": "tidal_disruption_frequency_ratio",
207 "220_quasinormal_mode_frequency": "220_quasinormal_mode_frequency",
208 "baryonic_torus_mass": "baryonic_torus_mass",
209 "baryonic_torus_mass_source": "baryonic_torus_mass_source",
210 "compactness_1": "compactness_1",
211 "compactness_2": "compactness_2",
212 "baryonic_mass_1": "baryonic_mass_1",
213 "baryonic_mass_1_source": "baryonic_mass_1_source",
214 "baryonic_mass_2": "baryonic_mass_2",
215 "baryonic_mass_2_source": "baryonic_mass_2_source"
216}
219for detector in _IFOS:
220 pesummary_map["{}_matched_filter_snr".format(detector)] = (
221 "{}_matched_filter_snr".format(detector)
222 )
223 pesummary_map["{}_matched_filter_snr_abs".format(detector)] = (
224 "{}_matched_filter_snr_abs".format(detector)
225 )
226 pesummary_map["{}_matched_filter_snr_angle".format(detector)] = (
227 "{}_matched_filter_snr_angle".format(detector)
228 )
229 pesummary_map["{}_optimal_snr".format(detector)] = (
230 "{}_optimal_snr".format(detector)
231 )
234other_map = {
235 "logL": "log_likelihood",
236 "lnL": "log_likelihood",
237 "loglr": "log_likelihood",
238 "tilt_spin1": "tilt_1",
239 "theta_1l": "tilt_1",
240 "tilt_spin2": "tilt_2",
241 "theta_2l": "tilt_2",
242 "chirpmass_source": "chirp_mass_source",
243 "chirp_mass_source": "chirp_mass_source",
244 "mass1": "mass_1",
245 "m1_detector_frame_Msun": "mass_1",
246 "m2_detector_frame_Msun": "mass_2",
247 "mass2": "mass_2",
248 "rightascension": "ra",
249 "right_ascension": "ra",
250 "longitude": "ra",
251 "declination": "dec",
252 "latitude": "dec",
253 "incl": "iota",
254 "inclination": "iota",
255 "phi_1l": "phi_1",
256 "phi_2l": "phi_2",
257 "polarisation": "psi",
258 "polarization": "psi",
259 "phijl": "phi_jl",
260 "a_spin1": "a_1",
261 "spin1": "a_1",
262 "spin1_a": "a_1",
263 "a1x": "spin_1x",
264 "a1y": "spin_1y",
265 "spin1x": "spin_1x",
266 "spin1y": "spin_1y",
267 "spin1z": "spin_1z",
268 "a_spin2": "a_2",
269 "spin2": "a_2",
270 "spin2_a": "a_2",
271 "a2x": "spin_2x",
272 "a2y": "spin_2y",
273 "spin2x": "spin_2x",
274 "spin2y": "spin_2y",
275 "spin2z": "spin_2z",
276 "theta1": "tilt_1",
277 "theta2": "tilt_2",
278 "phiorb": "phase",
279 "phi0": "phase",
280 "distance": "luminosity_distance",
281 "luminosity_distance_Mpc": "luminosity_distance",
282 "chirpmass": "chirp_mass",
283 "tc": "geocent_time",
284 "geocent_end_time": "geocent_time",
285 "fref": "reference_frequency",
286 "time_maxl": "marginalized_geocent_time",
287 "tref": "marginalized_geocent_time",
288 "phase_maxl": "marginalized_phase",
289 "distance_maxl": "marginalized_distance",
290 "spin1_azimuthal": "a_1_azimuthal",
291 "spin1_polar": "a_1_polar",
292 "spin2_azimuthal": "a_2_azimuthal",
293 "spin2_polar": "a_2_polar",
294 "delta_lambda_tilde": "delta_lambda",
295 "logPrior": "log_prior",
296 "weight": "weights",
297 "delta_lambda": "delta_lambda",
298 "peak_luminosity": "peak_luminosity",
299 "final_mass": "final_mass",
300 "final_spin": "final_spin",
301 "weights": "weights",
302 "inverted_mass_ratio": "inverted_mass_ratio",
303 "mf": "final_mass",
304 "mf_evol": "final_mass",
305 "mf_source_evol": "final_mass_source",
306 "af": "final_spin",
307 "af_evol": "final_spin",
308 "l_peak": "peak_luminosity",
309 "l_peak_evol": "peak_luminosity",
310 "e_rad_evol": "radiated_energy",
311}
314for detector in _IFOS:
315 other_map["{}_cplx_snr_arg".format(detector)] = (
316 "{}_matched_filter_snr_angle".format(detector)
317 )
318 other_map["{}_cplx_snr_amp".format(detector)] = (
319 "{}_matched_filter_abs_snr".format(detector)
320 )
321 other_map["{}_matched_filter_abs_snr".format(detector)] = (
322 "{}_matched_filter_abs_snr".format(detector)
323 )
324 other_map["{}_matched_filter_snr_amp".format(detector)] = (
325 "{}_matched_filter_abs_snr".format(detector)
326 )
327 other_map["{}_matched_filter_snr".format(detector.lower())] = (
328 "{}_matched_filter_snr".format(detector)
329 )
330 other_map["{}_matched_filter_snr".format(detector)] = (
331 "{}_matched_filter_snr".format(detector)
332 )
333 other_map["{}_matched_filter_snr_abs".format(detector)] = (
334 "{}_matched_filter_snr_abs".format(detector)
335 )
336 other_map["{}_matched_filter_snr_angle".format(detector)] = (
337 "{}_matched_filter_snr_angle".format(detector)
338 )
341standard_names = {}
342standard_names.update(lalinference_map)
343standard_names.update(bilby_map)
344standard_names.update(pycbc_map)
345standard_names.update(other_map)
347descriptive_names = {
348 "log_likelihood": (
349 "the logarithm of the likelihood"
350 ),
351 "tilt_1": (
352 "the zenith angle between the Newtonian orbital angular momentum, L, and "
353 "the primary spin, S1"
354 ),
355 "tilt_2": (
356 "the zenith angle between the Newtonian orbital angular momentum, L, and "
357 "the secondary spin, S2"
358 ),
359 "tilt_1_infinity_only_prec_avg": (
360 "the zenith angle between the Newtonian orbital angular momentum, L, and "
361 "the primary spin, S1, defined at infinite binary separation computed "
362 "using only the precession-averaged approximation"
363 ),
364 "tilt_2_infinity_only_prec_avg": (
365 "the zenith angle between the Newtonian orbital angular momentum, L, and "
366 "the secondary spin, S2, defined at infinite binary separation computed "
367 "using only the precession-averaged approximation"
368 ),
369 "tilt_1_infinity": (
370 "the zenith angle between the Newtonian orbital angular momentum, L, and "
371 "the primary spin, S1, defined at infinite binary separation"
372 ),
373 "tilt_2_infinity": (
374 "the zenith angle between the Newtonian orbital angular momentum, L, and "
375 "the secondary spin, S2, defined at infinite binary separation"
376 ),
377 "cos_tilt_1": (
378 "the cosine of the zenith angle between the Newtonian orbital angular momentum "
379 "momentum, L, and the primary spin, S1"
380 ),
381 "cos_tilt_2": (
382 "the cosine of the zenith angle between the Newtonian orbital angular momentum "
383 "momentum, L, and the secondary spin, S2"
384 ),
385 "cos_tilt_1_infinity": (
386 "the cosine of the zenith angle between the Newtonian orbital angular momentum "
387 "momentum, L, and the primary spin, S1, defined at infinite binary separation"
388 ),
389 "cos_tilt_2_infinity": (
390 "the cosine of the zenith angle between the Newtonian orbital angular momentum "
391 "momentum, L, and the secondary spin, S2, defined at infinite binary separation"
392 ),
393 "cos_tilt_1_infinity_only_prec_avg": (
394 "the cosine of the zenith angle between the Newtonian orbital angular momentum "
395 "momentum, L, and the primary spin, S1, defined at infinite binary separation "
396 "computed using only the precession-averaged approximation"
397 ),
398 "cos_tilt_2_infinity_only_prec_avg": (
399 "the cosine of the zenith angle between the Newtonian orbital angular momentum "
400 "momentum, L, and the secondary spin, S2, defined at infinite binary separation "
401 "computed using only the precession-averaged approximation"
402 ),
403 "beta": (
404 "the zenith angle between the total orbital angular momentum, L, and "
405 "the total angular momentum J. For a non-precessing system, beta is "
406 "zero by definition"
407 ),
408 "redshift": (
409 "the redshift depending on specified cosmology"
410 ),
411 "network_optimal_snr": (
412 "the optimal signal to noise ratio in the gravitational wave detector "
413 "network"
414 ),
415 "network_matched_filter_snr": (
416 "the matched filter signal to noise ratio in the gravitational wave "
417 "detector network"
418 ),
419 "chirp_mass_source": (
420 "the source-frame chirp mass"
421 ),
422 "symmetric_mass_ratio": (
423 "a definition of mass ratio which is independent of the identity of "
424 "the primary/secondary object"
425 ),
426 "mass_1": (
427 "the detector-frame (redshifted) mass of the heavier object"
428 ),
429 "mass_2": (
430 "the detector-frame (redshifted) mass of the lighter object"
431 ),
432 "ra": (
433 "the right ascension of the source"
434 ),
435 "dec": (
436 "the declination of the source"
437 ),
438 "iota": (
439 "the angle between the total orbital angular momentum, L, and the "
440 "line of sight, N"
441 ),
442 "cos_iota": (
443 "the cosine of the angle between the total orbital angular momentum, L "
444 ", and the line of sight, N"
445 ),
446 "mass_2_source": (
447 "the source mass of the lighter object in the binary"
448 ),
449 "mass_1_source": (
450 "the source mass of the heavier object in the binary"
451 ),
452 "phi_1": (
453 "the azimuthal angle of the spin vector of the primary object"
454 ),
455 "phi_2": (
456 "the azimuthal angle of the spin vector of the secondary object"
457 ),
458 "psi": (
459 "the polarization angle of the source"
460 ),
461 "phi_12": (
462 "the difference between the azimuthal angles of the individual spin "
463 "vectors of the primary and secondary object's"
464 ),
465 "phi_jl": (
466 "the difference between total and orbital angular momentum azimuthal "
467 "angles"
468 ),
469 "a_1": (
470 "the dimensionless spin magnitude of the primary object"
471 ),
472 "spin_1x": (
473 "the x-component of the primary object's spin in Euclidean coordinates"
474 ),
475 "spin_1y": (
476 "the y-component of the primary object's spin in Euclidean coordinates"
477 ),
478 "spin_1z": (
479 "the z-component of the primary object's spin in Euclidean coordinates"
480 ),
481 "spin_1z_infinity": (
482 "the z-component of the primary object's spin in Euclidean coordinates "
483 "defined at infinite binary separation"
484 ),
485 "spin_1z_infinity_only_prec_avg": (
486 "the z-component of the primary object's spin in Euclidean coordinates "
487 "defined at infinite binary separation computed using only the "
488 "precession-averaged approximation"
489 ),
490 "a_2": (
491 "the dimensionless spin magnitude of the secondary object"
492 ),
493 "spin_2x": (
494 "the x-component of the secondary object's spin in Euclidean "
495 "coordinates"
496 ),
497 "spin_2y": (
498 "the y-component of the secondary object's spin in Euclidean "
499 "coordinates"
500 ),
501 "spin_2z": (
502 "the z-component of the secondary object's spin in Euclidean "
503 "coordinates"
504 ),
505 "spin_2z_infinity": (
506 "the z-component of the secondary object's spin in Euclidean coordinates "
507 "defined at infinite binary separation"
508 ),
509 "spin_2z_infinity_only_prec_avg": (
510 "the z-component of the secondary object's spin in Euclidean coordinates "
511 "defined at infinite binary separation computed using only the "
512 "precession-averaged approximation"
513 ),
514 "chi_p": (
515 "the effective precession spin parameter"
516 ),
517 "chi_p_infinity": (
518 "the effective precession spin parameter defined at infinite binary separation"
519 ),
520 "chi_p_infinity_only_prec_avg": (
521 "the effective precession spin parameter defined at infinite binary separation "
522 "computed using only the precession-averaged approximation"
523 ),
524 "chi_p_2spin": (
525 "a modified effective precession spin parameter accounting for "
526 "precessing spin information from both compact objects."
527 ),
528 "phase": (
529 "the binary phase defined at a given reference frequency"
530 ),
531 "luminosity_distance": (
532 "the luminosity distance of the source"
533 ),
534 "chirp_mass": (
535 "the detector-frame chirp mass"
536 ),
537 "chi_eff": (
538 "the effective inspiral spin parameter"
539 ),
540 "chi_eff_infinity": (
541 "the effective inspiral spin parameter defined at infinite binary separation"
542 ),
543 "chi_eff_infinity_only_prec_avg": (
544 "the effective inspiral spin parameter defined at infinite binary separation "
545 "computed using only the precession-averaged approximation"
546 ),
547 "total_mass_source": (
548 "the source-frame combined mass of the primary and secondary masses "
549 ),
550 "total_mass": (
551 "the detector-frame combined mass of the primary and secondary masses "
552 ),
553 "mass_ratio": (
554 "the ratio of the binary component masses. We use the convention that "
555 "the mass ratio is always less than 1"
556 ),
557 "inverted_mass_ratio": (
558 "The inverted ratio of the binary component masses. Note that normal "
559 "convention is mass ratio less than 1, but here the inverted mass ratio "
560 "is always bigger than 1"
561 ),
562 "geocent_time": (
563 "the GPS merger time at the geocenter"
564 ),
565 "theta_jn": (
566 "the angle between the total angular momentum, J, and the line of "
567 "sight, N"
568 ),
569 "cos_theta_jn": (
570 "the cosine of the angle between the total angular momentum, J, and "
571 "the line of sight, N"
572 ),
573 "reference_frequency": (
574 "the frequency at which the frequency dependent parameters are defined"
575 ),
576 "a_1_azimuthal": (
577 "the azimuthal spin angle of the primary object"
578 ),
579 "a_1_polar": (
580 "the polar spin angle of the primary object"
581 ),
582 "a_2_azimuthal": (
583 "the azimuthal spin angle of the secondary object"
584 ),
585 "a_2_polar": (
586 "the polar spin angle of the secondary object"
587 ),
588 "lambda_1": (
589 "the dimensionless tidal deformability of the primary object"
590 ),
591 "lambda_2": (
592 "the dimensionless tidal deformability of the secondary object"
593 ),
594 "lambda_tilde": (
595 "the combined dimensionless tidal deformability"
596 ),
597 "delta_lambda": (
598 "the relative difference in the combined tidal deformability"
599 ),
600 "log_pressure": (
601 "the base 10 logarithm of the pressure in Pa at the reference density "
602 "of 10^17.7 kg/m^3"
603 ),
604 "gamma_1": (
605 "the adiabatic index for densities below 10^17.7 kg/m^3"
606 ),
607 "gamma_2": (
608 "the adiabatic index for densities from 10^17.7 kg/m^3 to 10^18 kg/m^3"
609 ),
610 "gamma_3": (
611 "the adiabatic index for densities above 10^18 kg/m^3"
612 ),
613 "spectral_decomposition_gamma_0": (
614 "the 0th expansion coefficient of the spectrally decomposed adiabatic "
615 "index of the EOS"
616 ),
617 "spectral_decomposition_gamma_1": (
618 "the 1st expansion coefficient of the spectrally decomposed adiabatic "
619 "index of the EOS"
620 ),
621 "spectral_decomposition_gamma_2": (
622 "the 2nd expansion coefficient of the spectrally decomposed adiabatic "
623 "index of the EOS"
624 ),
625 "spectral_decomposition_gamma_3": (
626 "the 3rd expansion coefficient of the spectrally decomposed adiabatic "
627 "index of the EOS"
628 ),
629 "peak_luminosity": (
630 "the peak gravitational wave luminosity estimated using the spins "
631 "evolved to the ISCO frequency"
632 ),
633 "peak_luminosity_non_evolved": (
634 "the peak gravitational wave luminosity estimated using the spins "
635 "defined at the reference frequency"
636 ),
637 "final_mass": (
638 "the detector-frame remnant mass estimated using the spins evolved to "
639 "the ISCO frequency"
640 ),
641 "final_mass_source": (
642 "the source-frame remnant mass estimated using the spins evolved to "
643 "the ISCO frequency"
644 ),
645 "final_mass_non_evolved": (
646 "the detector-frame remnant mass estimated using the spins defined at "
647 "the reference frequency"
648 ),
649 "final_mass_source_non_evolved": (
650 "the source-frame remnant mass estimated using the spins defined at "
651 "the reference frequency"
652 ),
653 "final_spin": (
654 "the spin of the remnant object estimated using the spins evolved to "
655 "the ISCO frequency"
656 ),
657 "final_spin_non_evolved": (
658 "the spin of the remnant object estimated using the spins defined at "
659 "the reference frequency"
660 ),
661 "radiated_energy": (
662 "the energy radiated in gravitational waves. Defined as the difference "
663 "between the source total and source remnant mass. The source remnant "
664 "mass was estimated using the spins evolved at the ISCO frequency"
665 ),
666 "radiated_energy_non_evolved": (
667 "the energy radiated in gravitational waves. Defined as the difference "
668 "between the source total and source remant mass. The source remnant "
669 "mass was estimated using the spins defined at the reference frequency"
670 ),
671 "tidal_disruption_frequency": (
672 "the gravitational wave detector-frame frequency at which tidal forces "
673 "dominate over the self-gravity forces, invoking mass shedding"
674 ),
675 "tidal_disruption_frequency_ratio": (
676 "the ratio of the tidal disruption and the 220 quasinormal mode "
677 "frequency of the system. In NSBH models this ratio describes whether the "
678 "system is disruptive or non-disruptive. If the ratio is less than 1, the "
679 "system is characterised as either mildly disruptive or disruptive. If the ratio "
680 "is greater than 1, the system is characterised as non-disruptive meaning "
681 "the secondary object remains intact as it plunges into the primary."
682 ),
683 "220_quasinormal_mode_frequency": (
684 "the detector-frame 220 quasinormal mode (QNM) frequency of the "
685 "remnant object"
686 ),
687 "baryonic_torus_mass": (
688 "the detector-frame (redshifted) baryonic mass of the torus formed "
689 "around the primary object. If the baryonic torus mass is 0, the system "
690 "is characterised as either mildly disruptive or non-disruptive."
691 ),
692 "baryonic_torus_mass_source": (
693 "the source-frame baryonic mass of the torus formed around the primary "
694 "object"
695 ),
696 "compactness_1": "the compactness of the primary object",
697 "compactness_2": "the compactness of the secondary object",
698 "baryonic_mass_1": (
699 "the detector-frame (redshifted) baryonic mass of the primary object"
700 ),
701 "baryonic_mass_1_source": (
702 "the source-frame baryonic mass of the primary object"
703 ),
704 "baryonic_mass_2": (
705 "the detector-frame (redshifted) baryonic mass of the secondary object"
706 ),
707 "baryonic_mass_2_source": (
708 "the source-frame baryonic mass of the secondary object"
709 ),
710 "network_21_multipole_snr": (
711 "the network SNR in the 21 subdominant multipole when assuming that the "
712 "system is non-precessing"
713 ),
714 "network_33_multipole_snr": (
715 "the network SNR in the 33 subdominant multipole when assuming that the "
716 "system is non-precessing"
717 ),
718 "network_44_multipole_snr": (
719 "the network SNR in the 44 subdominant multipole when assuming that the "
720 "system is non-precessing"
721 )
722}
724for detector in _IFOS:
725 descriptive_names["{}_optimal_snr".format(detector)] = (
726 "the optimal signal to noise ratio in the %s gravitational wave "
727 "detector" % (detector)
728 )
729 descriptive_names["{}_matched_filter_snr".format(detector)] = (
730 "the real component of the complex matched filter signal to noise "
731 "ratio in the %s gravitational wave detector" % (detector)
732 )
733 descriptive_names["{}_matched_filter_abs_snr".format(detector)] = (
734 "the absolute value of the complex matched filter signal to noise "
735 "ratio in the %s gravitational wave detector" % (detector)
736 )
737 descriptive_names["{}_matched_filter_snr_abs".format(detector)] = (
738 "the absolute value of the complex matched filter signal to noise "
739 "ratio in the %s gravitational wave detector" % (detector)
740 )
741 descriptive_names["{}_matched_filter_snr_angle".format(detector)] = (
742 "the angle of the complex component of the matched filter signal to "
743 "noise ratio in the %s gravitational wave detector" % (detector)
744 )
745 descriptive_names["{}_time".format(detector)] = (
746 "the GPS merger time at the %s gravitational wave detector" % (detector)
747 )
749for detector_combination in _IFO_combinations:
750 descriptive_names["{}_{}_time_delay".format(*detector_combination)] = (
751 "the difference in GPS merger time between the %s and %s "
752 "gravitational wave detectors" % (
753 detector_combination[0], detector_combination[1]
754 )
755 )