tgr package

Submodules

tgr.birefringence module

tgr.birefringence.gen_waveform(**kwds)

tgr.birefringence.integrand(redshift)

The integrand: (1.0 + z)^parity_beta / sqrt(Omega_m (1+z)^3 + Omega_Lambda)

tgr.dipole module

tgr.dipole.genwav(dipole_b=0.0, **kwds)

tgr.dipole.genwav_seobnrv4_rom(dipole_b=0.0, **kwds)

tgr.fta module

tgr.fta.gen_waveform(**kwds)

Generate waveform with FTA (flexible theory agnostic) correction. Described in https://arxiv.org/pdf/1811.00364.pdf “Tests of General Relativity with GW170817”

Parameters

kwds: dict

Only support dchi2 atm.

Returns

hp: pycbc.types.FrequencySeries

Plus polarization time series

hc: pycbc.types.FrequencySeries

Cross polarization time series

tgr.lineofsight module

tgr.lineofsight.gen_waveform(**kwds)

tgr.massive_graviton module

tgr.massive_graviton.effective_distance(luminosity_distance, cosmology=None, **kwargs)

Calculate effective distance D_eff for massive graviton phase correction. D_eff = (1+z) * c / H0 * integral_0^z dz’ / ((1+z’)^2 * E(z’))

Parameters

luminosity_distancefloat

Luminosity distance to the source in Mpc

Returns

defffloat

Effective distance in Mpc

tgr.massive_graviton.gen_mg_waveform(**kwds)

Generate frequency-domain waveform with massive graviton phase correction. Based on Will (1997) PRD 57, 2061. Assumes no modification to binary dynamics.

Parameters

kwdsdict

Must contain base_gr_approximant for the GR approximant name, mg for the graviton mass in eV/c^2, and distance for the luminosity distance in Mpc.

Other parameters (masses, spins, etc.) passed to get_fd_waveform.

Returns

hp: pycbc.types.FrequencySeries

Plus polarization time series

hc: pycbc.types.FrequencySeries

Cross polarization time series

tgr.massive_graviton.lambda_g_to_mg(lambda_g)

Convert graviton Compton wavelength to mass.

Parameters

lambda_gfloat

Compton wavelength of graviton in km

Returns

mgfloat

Graviton mass in eV/c^2

tgr.massive_graviton.mg_phase_correction(mg, distance, frequencies, cosmology=None, **kwargs)

Calculate the massive graviton phase correction for given frequencies. delta_phi = -pi * D_eff * c^3 * m_g^2 / h^2 / (1 + z) / f

Parameters

mgfloat

Graviton mass in eV/c^2

distancefloat

Luminosity distance to the source in Mpc

frequenciesarray-like

Array of frequencies in Hz

Returns

delta_phiarray-like

Phase correction for each frequency in radians

tgr.massive_graviton.mg_to_lambda_g(mg)

Convert graviton mass to Compton wavelength.

Parameters

mgfloat

Graviton mass in eV/c^2

Returns

lambda_gfloat

Compton wavelength of graviton in km

tgr.nr module

tgr.nr.gen_lvcnr_waveform(data_file, **kwds)

Generate a LVC NR waveform from a file path

tgr.nr.gen_sxs_waveform(sxs_id, extrapolation_order=2, download=False, **kwds)

tgr.nrsurqnm module

tgr.nrsurqnm.gen_nrsur7dq4_tdtaper(**kwds)

tgr.nrsurqnm.gen_nrsur_remove_qqnm(**kwds)

Generate a NRSur7dq4 waveform with quadratic modes being removed from (4,4) mode. The quadratic modes are constructed from (2,2) mode with amplitude ratio from theory predictions. The ringdown part of (4,4) mode is then replaced by the residual after subtracting the quadratic modes.

kwds should contain: - mass1, mass2, spin1x, spin1y, spin1z, spin2x, spin2y, spin2z, distance, delta_t, f_lower, f_ref, inclination, coa_phase, - mode22: the overtone mode used for quadratic mode), - mode_quadratic: the list of quadratic modes to be removed, e.g. “220220 220221” - toffset: the start time for ringdown treatment, e.g. 0.002 - quadratic_tgr: the amplitude deviation parameter for quadratic modes, e.g. 0. Optional - quadratic_tgr_phase: the phase deviation (in radians) for quadratic modes, e.g. 0. Optional - qqnm_deltaf: the fractional deviation in frequency for the nonGR quadratic modes, e.g. 0. Optional - qqnm_deltatau: the fractional deviation in damping time for the nonGR quadratic modes, e.g. 0. Optional

tgr.nrsurqnm.gen_nrsurqnm(**kwds)

tgr.nrsurqnm.get_qnmpar(qnm_modes, **kwds)

Get the QNM parameters (frequency and damping time) for the given modes based on the remnant black hole properties predicted by NRSur7dq4. The remnant properties are calculated from the initial binary parameters using NRSur7dq4 fits.

The input kwds should contain the initial binary parameters and f_ref for NRSur7dq4. The qnm_modes should be a list of mode labels, e.g. [“220”,”221”] for linear modes, or [“220220”, “220221”] for quadratic modes.

tgr.nrsurqnm.load_interpolation_function(label)

load interpolation function for quadratic modes from cache

tgr.nrsurqnm.qnm_decomposition(qnm_modes, qnm_par, ringdown_start_time, h_target)

Decompose the target waveform h_target into the given QNM modes starting from ringdown_start_time

tgr.ppe module

tgr.ppe.gen_ppe_waveform(**kwds)

Parameterized Post Einstein

Parameters

kwds: dict

Supports original ppE-like phase coefficients ppebetaN. The integer suffix N follows the PN phase index, so ppebeta2 has exponent b = -1 and contributes ppebeta2 / u with u = pi * detector_chirp_mass * f.

Returns

hp: pycbc.types.FrequencySeries

Plus polarization time series

hc: pycbc.types.FrequencySeries

Cross polarization time series

tgr.ppe.ppe_beta_exponent(pn_index)

Return the ppE phase exponent for a PN-indexed beta parameter.

Module contents

tgr.length_in_time(**kwds)