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