lalinference.imrtgr.nrutils Namespace Reference

Data Structures
class	bbh_final_state_fits
	Final mass and spin fits. More...
class	bbh_Kerr_trunc_opts
class	bbh_Lpeak_fits
	Peak luminosity fits. More...

Functions
def	bbh_final_mass_non_spinning_Panetal (m1, m2)
	Calculate the mass of the final BH resulting from the merger of two non-spinning black holes using eqn. More...
def	bbh_final_spin_non_spinning_Panetal (m1, m2)
	Calculate the spin of the final BH resulting from the merger of two non-spinning black holes using eqn. More...
def	calc_isco_radius (a)
	Calculate the ISCO radius of a Kerr BH as a function of the Kerr parameter using eqns. More...
def	bbh_final_spin_non_precessing_Healyetal (m1, m2, chi1, chi2, version="2014")
	Calculate the spin of the final BH resulting from the merger of two black holes with non-precessing spins using fit from Healy et al Phys Rev D 90, 104004 (2014) (version == "2014") or the small update from Healy and Lousto arXiv:1610.09713 (version == "2016") More...
def	bbh_final_mass_non_precessing_Healyetal (m1, m2, chi1, chi2, version="2014", chif=None)
	Calculate the mass of the final BH resulting from the merger of two black holes with non-precessing spins using fit from Healy et al Phys Rev D 90, 104004 (2014) (version == "2014") or the small update from Healy and Lousto arXiv:1610.09713 (version == "2016") More...
def	bbh_final_spin_projected_spin_Healyetal (m1, m2, chi1, chi2, tilt1, tilt2)
	wrapper to bbh_final_spin_projected_spins() for backwards compatibility More...
def	bbh_final_mass_projected_spin_Healyetal (m1, m2, chi1, chi2, tilt1, tilt2, chif=None)
	wrapper to bbh_final_mass_projected_spins() for backwards compatibility More...
def	bbh_final_spin_precessing_Healyetal_extension_Minit (m1, m2, chi1, chi2, tilt1, tilt2, phi12)
	wrapper to bbh_final_spin_precessing() for backwards compatibility More...
def	bbh_final_mass_projected_spins (m1, m2, chi1, chi2, tilt1, tilt2, fitname, chif=None)
	Calculate the mass of the final BH resulting from the merger of two black holes, only using the projected spins along the total angular momentum and some aligned-spin fit from the literature. More...
def	bbh_final_spin_projected_spins (m1, m2, chi1, chi2, tilt1, tilt2, fitname, truncate=bbh_Kerr_trunc_opts.trunc)
	Calculate the (signed) dimensionless spin parameter of the final BH resulting from the merger of two black holes, only using the projected spins along the total angular momentum and some aligned-spin fit from the literature. More...
def	bbh_final_spin_precessing (m1, m2, chi1, chi2, tilt1, tilt2, phi12, fitname, truncate=bbh_Kerr_trunc_opts.trunc)
	Calculate the magnitude of the dimensionless spin parameter of the final BH resulting from the merger of two black holes, including the in-plane spin components; by either using a precessing fit from the literature; or by first projecting the spins along the angular momentum and using an aligned-spin fit from the literature, then adding in quadrature the in-plane dimensionful spin scaled by the initial mass squared. More...
def	bbh_final_mass_non_precessing_Husaetal (m1, m2, chi1, chi2)
	Calculate the mass of the final BH resulting from the merger of two black holes with non-precessing spins using the fits used by IMRPhenomD, given in Eqs. More...
def	bbh_final_spin_non_precessing_Husaetal (m1, m2, chi1, chi2)
	Calculate the spin of the final BH resulting from the merger of two black holes with non-precessing spins using the fits used by IMRPhenomD, given in Eqs. More...
def	bbh_UIBfits_setup (m1, m2, chi1, chi2)
	common setup function for UIB final-state and luminosity fit functions More...
def	bbh_final_mass_non_precessing_UIB2016 (m1, m2, chi1, chi2, version="v2")
	Calculate the final mass with the aligned-spin NR fit by Xisco Jimenez Forteza, David Keitel, Sascha Husa et al. More...
def	bbh_final_spin_non_precessing_UIB2016 (m1, m2, chi1, chi2, version="v2")
	Calculate the final spin with the aligned-spin NR fit by Xisco Jimenez Forteza, David Keitel, Sascha Husa et al. More...
def	bbh_final_spin_non_precessing_HBR2016 (m1, m2, chi1z, chi2z, version="M3J3")
	Calculate the (signed) dimensionless spin of the final BH resulting from the merger of two black holes with aligned spins using the fit from Hofmann, Barausse, and Rezzolla ApJL 825, L19 (2016), henceforth HBR. More...
def	bbh_final_spin_precessing_HBR2016 (m1, m2, chi1, chi2, tilt1, tilt2, phi12, version="M3J3")
	Calculate the dimensionless spin of the final BH resulting from the merger of two black holes with precessing spins using the fit from Hofmann, Barausse, and Rezzolla ApJL 825, L19 (2016), henceforth HBR. More...
def	bbh_aligned_Lpeak_6mode_SHXJDK (q, chi1, chi2)
	wrapper to bbh_peak_luminosity_non_precessing_T1600018() for backwards compatibility More...
def	bbh_peak_luminosity_non_precessing_T1600018 (m1, m2, chi1, chi2)
	Calculate the peak luminosity (using modes 22, 21, 33, 32, 44, and 43) of a binary black hole with aligned spins using the fit made by Sascha Husa, Xisco Jimenez Forteza, David Keitel [LIGO-T1500598] using 5th order in chieff and return results in units of 10^56 ergs/s. More...
def	bbh_peak_luminosity_non_precessing_UIB2016 (m1, m2, chi1, chi2)
	Calculate the peak luminosity with the aligned-spin NR fit by David Keitel, Xisco Jimenez Forteza, Sascha Husa, Lionel London et al. More...
def	bbh_peak_luminosity_non_precessing_Healyetal (m1, m2, chi1z, chi2z)
	Calculate the peak luminosity of an aligned-spin binary black hole coalescence using the fit from Healy and Lousto arXiv:1610.09713 (henceforth HL) More...
def	bbh_peak_luminosity_projected_spins (m1, m2, chi1, chi2, tilt1, tilt2, fitname)
	Calculate the peak luminosity of the merger of two black holes, only using the projected spins along the total angular momentum and some aligned-spin fit from the literature. More...
def	bbh_average_fits_precessing (m1, m2, chi1, chi2, tilt1, tilt2, phi12, quantity, fits)
	Convenience functions. More...

Function Documentation

bbh_final_mass_non_spinning_Panetal()

def lalinference.imrtgr.nrutils.bbh_final_mass_non_spinning_Panetal	(		m1,
			m2
	)

Calculate the mass of the final BH resulting from the merger of two non-spinning black holes using eqn.

29a of from Pan et al, Phys Rev D 84, 124052 (2011).

Parameters

m1, m2 : component masses

Returns

final mass, mf

Definition at line 110 of file nrutils.py.

bbh_final_spin_non_spinning_Panetal()

def lalinference.imrtgr.nrutils.bbh_final_spin_non_spinning_Panetal	(		m1,
			m2
	)

Calculate the spin of the final BH resulting from the merger of two non-spinning black holes using eqn.

29b of Pan et al, Phys Rev D 84, 124052 (2011).

Parameters

m1, m2 : component masses

Returns

final dimensionless spin, chif

Definition at line 129 of file nrutils.py.

calc_isco_radius()

def lalinference.imrtgr.nrutils.calc_isco_radius

(

a

)

Calculate the ISCO radius of a Kerr BH as a function of the Kerr parameter using eqns.

2.5 and 2.8 from Ori and Thorne, Phys Rev D 62, 24022 (2000)

Parameters

a : Kerr parameter

Returns

ISCO radius

Definition at line 147 of file nrutils.py.

bbh_final_spin_non_precessing_Healyetal()

def lalinference.imrtgr.nrutils.bbh_final_spin_non_precessing_Healyetal	(		m1,
			m2,
			chi1,
			chi2,
			version = "2014"
	)

Calculate the spin of the final BH resulting from the merger of two black holes with non-precessing spins using fit from Healy et al Phys Rev D 90, 104004 (2014) (version == "2014") or the small update from Healy and Lousto arXiv:1610.09713 (version == "2016")

Parameters

m1, m2 : component masses chi1, chi2 : dimensionless spins of two BHs

Returns

dimensionless final spin, chif

Definition at line 267 of file nrutils.py.

bbh_final_mass_non_precessing_Healyetal()

def lalinference.imrtgr.nrutils.bbh_final_mass_non_precessing_Healyetal	(		m1,
			m2,
			chi1,
			chi2,
			version = "2014",
			chif = None
	)

Calculate the mass of the final BH resulting from the merger of two black holes with non-precessing spins using fit from Healy et al Phys Rev D 90, 104004 (2014) (version == "2014") or the small update from Healy and Lousto arXiv:1610.09713 (version == "2016")

Parameters

m1, m2 : component masses chi1, chi2 : dimensionless spins of two BHs chif: final spin (optional), if already calculated

Returns

final mass, mf

Definition at line 306 of file nrutils.py.

bbh_final_spin_projected_spin_Healyetal()

def lalinference.imrtgr.nrutils.bbh_final_spin_projected_spin_Healyetal	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2
	)

wrapper to bbh_final_spin_projected_spins() for backwards compatibility

Definition at line 385 of file nrutils.py.

bbh_final_mass_projected_spin_Healyetal()

def lalinference.imrtgr.nrutils.bbh_final_mass_projected_spin_Healyetal	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2,
			chif = None
	)

wrapper to bbh_final_mass_projected_spins() for backwards compatibility

Definition at line 391 of file nrutils.py.

bbh_final_spin_precessing_Healyetal_extension_Minit()

def lalinference.imrtgr.nrutils.bbh_final_spin_precessing_Healyetal_extension_Minit	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2,
			phi12
	)

wrapper to bbh_final_spin_precessing() for backwards compatibility

Definition at line 397 of file nrutils.py.

bbh_final_mass_projected_spins()

def lalinference.imrtgr.nrutils.bbh_final_mass_projected_spins	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2,
			fitname,
			chif = None
	)

Calculate the mass of the final BH resulting from the merger of two black holes, only using the projected spins along the total angular momentum and some aligned-spin fit from the literature.

Parameters

m1, m2 : component masses chi1, chi2 : dimensionless spins of two BHs tilt1, tilt2 : tilts (in radians) in the new spin convention fitname: fit selection currently supports Pan2011 (non-spinning), HLZ2014, PhenomD, UIB2016, HL2016 chif: final spin (optional, only used for HLZ2014 and HL2016), if already calculated

Returns

final mass, mf

Definition at line 417 of file nrutils.py.

bbh_final_spin_projected_spins()

def lalinference.imrtgr.nrutils.bbh_final_spin_projected_spins	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2,
			fitname,
			truncate = bbh_Kerr_trunc_opts.trunc
	)

Calculate the (signed) dimensionless spin parameter of the final BH resulting from the merger of two black holes, only using the projected spins along the total angular momentum and some aligned-spin fit from the literature.

Parameters

m1, m2 : component masses chi1, chi2 : dimensionless spins of two BHs tilt1, tilt2 : tilts (in radians) in the new spin convention fitname: fit selection currently supports Pan2011 (non-spinning), HLZ2014, PhenomD, UIB2016, HBR2016, HL2016

Returns

(signed) dimensionless final spin parameter, chif

Definition at line 476 of file nrutils.py.

bbh_final_spin_precessing()

def lalinference.imrtgr.nrutils.bbh_final_spin_precessing	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2,
			phi12,
			fitname,
			truncate = bbh_Kerr_trunc_opts.trunc
	)

Calculate the magnitude of the dimensionless spin parameter of the final BH resulting from the merger of two black holes, including the in-plane spin components; by either using a precessing fit from the literature; or by first projecting the spins along the angular momentum and using an aligned-spin fit from the literature, then adding in quadrature the in-plane dimensionful spin scaled by the initial mass squared.

Parameters

m1, m2 : component masses chi1, chi2 : dimensionless spins of two BHs tilt1, tilt2 : tilts (in radians) in the new spin convention phi12: angle (in radians) between in-plane spin components fitname: fit selection currently supports Pan2011 (non-spinning), HLZ2014 (aligned+augmentation), PhenomD (aligned+augmentation), UIB2016 (aligned+augmentation), HL2016 (aligned+augmentation), HBR2016 (precessing)

Returns

magnitude of the dimensionless final spin parameter, chif

Definition at line 534 of file nrutils.py.

bbh_final_mass_non_precessing_Husaetal()

def lalinference.imrtgr.nrutils.bbh_final_mass_non_precessing_Husaetal	(		m1,
			m2,
			chi1,
			chi2
	)

Calculate the mass of the final BH resulting from the merger of two black holes with non-precessing spins using the fits used by IMRPhenomD, given in Eqs.

(3.6) and (3.8) of Husa et al. arXiv:1508.07250. Note that Eq. (3.8) gives the radiated energy, not the final mass directly

m1, m2: component masses chi1, chi2: dimensionless spins of two BHs

Definition at line 580 of file nrutils.py.

bbh_final_spin_non_precessing_Husaetal()

def lalinference.imrtgr.nrutils.bbh_final_spin_non_precessing_Husaetal	(		m1,
			m2,
			chi1,
			chi2
	)

Calculate the spin of the final BH resulting from the merger of two black holes with non-precessing spins using the fits used by IMRPhenomD, given in Eqs.

(3.6) and (3.8) of Husa et al. arXiv:1508.07250. Note that Eq. (3.8) gives the radiated energy, not the final mass directly

m1, m2: component masses chi1, chi2: dimensionless spins of two BHs

Definition at line 622 of file nrutils.py.

bbh_UIBfits_setup()

def lalinference.imrtgr.nrutils.bbh_UIBfits_setup	(		m1,
			m2,
			chi1,
			chi2
	)

common setup function for UIB final-state and luminosity fit functions

Definition at line 661 of file nrutils.py.

bbh_final_mass_non_precessing_UIB2016()

def lalinference.imrtgr.nrutils.bbh_final_mass_non_precessing_UIB2016	(		m1,
			m2,
			chi1,
			chi2,
			version = "v2"
	)

Calculate the final mass with the aligned-spin NR fit by Xisco Jimenez Forteza, David Keitel, Sascha Husa et al.

[LIGO-P1600270] [https://arxiv.org/abs/1611.00332] versions v1 and v2 use the same ansatz, with v2 calibrated to additional SXS and RIT data

m1, m2: component masses chi1, chi2: dimensionless spins of two BHs Results are symmetric under simultaneous exchange of m1<->m2 and chi1<->chi2.

Definition at line 734 of file nrutils.py.

bbh_final_spin_non_precessing_UIB2016()

def lalinference.imrtgr.nrutils.bbh_final_spin_non_precessing_UIB2016	(		m1,
			m2,
			chi1,
			chi2,
			version = "v2"
	)

Calculate the final spin with the aligned-spin NR fit by Xisco Jimenez Forteza, David Keitel, Sascha Husa et al.

[LIGO-P1600270] [https://arxiv.org/abs/1611.00332] versions v1 and v2 use the same ansatz, with v2 calibrated to additional SXS and RIT data

m1, m2: component masses chi1, chi2: dimensionless spins of two BHs Results are symmetric under simultaneous exchange of m1<->m2 and chi1<->chi2.

Definition at line 821 of file nrutils.py.

bbh_final_spin_non_precessing_HBR2016()

def lalinference.imrtgr.nrutils.bbh_final_spin_non_precessing_HBR2016	(		m1,
			m2,
			chi1z,
			chi2z,
			version = "M3J3"
	)

Calculate the (signed) dimensionless spin of the final BH resulting from the merger of two black holes with aligned spins using the fit from Hofmann, Barausse, and Rezzolla ApJL 825, L19 (2016), henceforth HBR.

The three versions available correspond to the three choices of fit coefficients given in Table 1 of that paper, with 6, 16, and 20 coefficients, respectively.

version can thus be "M1J2", "M3J3", or "M3J4"

m1, m2: component masses chi1z, chi2z: components of the dimensionless spins of the two BHs along the orbital angular momentum

Definition at line 1033 of file nrutils.py.

bbh_final_spin_precessing_HBR2016()

def lalinference.imrtgr.nrutils.bbh_final_spin_precessing_HBR2016	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2,
			phi12,
			version = "M3J3"
	)

Calculate the dimensionless spin of the final BH resulting from the merger of two black holes with precessing spins using the fit from Hofmann, Barausse, and Rezzolla ApJL 825, L19 (2016), henceforth HBR.

The three versions available correspond to the three choices of fit coefficients given in Table 1 of that paper, with 6, 16, and 20 coefficients, respectively.

version can thus be "M1J2", "M3J3", or "M3J4"

m1, m2: component masses chi1, chi2: dimensionless spins of two BHs tilt1, tilt2: tilt angles of the spins from the orbital angular momentum phi12: angle between in-plane spin components

Definition at line 1060 of file nrutils.py.

bbh_aligned_Lpeak_6mode_SHXJDK()

def lalinference.imrtgr.nrutils.bbh_aligned_Lpeak_6mode_SHXJDK	(		q,
			chi1,
			chi2
	)

wrapper to bbh_peak_luminosity_non_precessing_T1600018() for backwards compatibility

q: mass ratio (here m2/m1, where m1>m2) chi1: the component of the dimensionless spin of m1 along the angular momentum (z) chi2: the component of the dimensionless spin of m2 along the angular momentum (z)

Definition at line 1125 of file nrutils.py.

bbh_peak_luminosity_non_precessing_T1600018()

def lalinference.imrtgr.nrutils.bbh_peak_luminosity_non_precessing_T1600018	(		m1,
			m2,
			chi1,
			chi2
	)

Calculate the peak luminosity (using modes 22, 21, 33, 32, 44, and 43) of a binary black hole with aligned spins using the fit made by Sascha Husa, Xisco Jimenez Forteza, David Keitel [LIGO-T1500598] using 5th order in chieff and return results in units of 10^56 ergs/s.

m1, m2: component masses chi1: the component of the dimensionless spin of m1 along the angular momentum (z) chi2: the component of the dimensionless spin of m2 along the angular momentum (z) Results are symmetric under simultaneous exchange of m1<->m2 and chi1<->chi2.

Definition at line 1151 of file nrutils.py.

bbh_peak_luminosity_non_precessing_UIB2016()

def lalinference.imrtgr.nrutils.bbh_peak_luminosity_non_precessing_UIB2016	(		m1,
			m2,
			chi1,
			chi2
	)

Calculate the peak luminosity with the aligned-spin NR fit by David Keitel, Xisco Jimenez Forteza, Sascha Husa, Lionel London et al.

[LIGO-P1600279-v5] [https://arxiv.org/abs/1612.09566v1] using modes up to lmax=6, and return results in units of 10^56 ergs/s

m1, m2: component masses chi1, chi2: dimensionless spins of two BHs Results are symmetric under simultaneous exchange of m1<->m2 and chi1<->chi2.

Definition at line 1187 of file nrutils.py.

bbh_peak_luminosity_non_precessing_Healyetal()

def lalinference.imrtgr.nrutils.bbh_peak_luminosity_non_precessing_Healyetal	(		m1,
			m2,
			chi1z,
			chi2z
	)

Calculate the peak luminosity of an aligned-spin binary black hole coalescence using the fit from Healy and Lousto arXiv:1610.09713 (henceforth HL)

Parameters

m1, m2 : component masses chi1z, chi2z : components of the dimensionless spins of the two BHs along their orbital angular momentum

Returns

peak luminosity in units of 10^56 ergs/s

Definition at line 1245 of file nrutils.py.

bbh_peak_luminosity_projected_spins()

def lalinference.imrtgr.nrutils.bbh_peak_luminosity_projected_spins	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2,
			fitname
	)

Calculate the peak luminosity of the merger of two black holes, only using the projected spins along the total angular momentum and some aligned-spin fit from the literature.

Parameters

m1, m2 : component masses chi1, chi2 : dimensionless spins of two BHs tilt1, tilt2 : tilts (in radians) in the new spin convention fitname: fit selection currently supports T1600018, UIB2016, HL2016

Returns

peak luminosity, Lpeak, in units of 10^56 ergs/s

Definition at line 1278 of file nrutils.py.

bbh_average_fits_precessing()

def lalinference.imrtgr.nrutils.bbh_average_fits_precessing	(		m1,
			m2,
			chi1,
			chi2,
			tilt1,
			tilt2,
			phi12,
			quantity,
			fits
	)

Convenience functions.

Calculate the average of the predictions of various fits, currently just for the final mass, final spin, or peak luminosity of a quasicircular binary black hole coalescence. The final spin calculation returns the magnitude of the final spin, including the contribution from in-plane spins; the other two cases just apply aligned-spin fits to the components of the spins along the orbital angular momentum.

Parameters

m1, m2 : component masses chi1, chi2 : dimensionless spins of two BHs tilt1, tilt2 : tilts (in radians) in the new spin convention phi12: angle (in radians) between in-plane spin components (only used for the final spin) quantity: "Mf", "af", "afz", or "Lpeak" fits: An array of fit names to be used. The possible fit names are those known by bbh_final_mass_projected_spins, bbh_final_spin_precessing, and bbh_peak_luminosity_projected_spins

The shape of m1 is used to determine the shape of the output.

Returns

Average of the results for the given fits for the chosen quantity

Definition at line 1328 of file nrutils.py.