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