IMRPhenomHM
Functions:
| Name | Description |
|---|---|
IMRPhenomHMAmplitude |
Returns IMRPhenomHM amplitude evaluated at a set of input frequencies for the l,m mode |
IMRPhenomHMEvaluateOnehlmMode |
Implementation of IMRPhenomHMEvaluateOnehlmMode in LALSimIMRPhenomHM.c |
IMRPhenomHMFreqDomainMap |
Map input frequency Mflm to the effective 22-mode frequency Mf22 for the (ell, mm) mode. |
IMRPhenomHMFreqDomainMapParams |
Implementation of the phase computation of IMRPhenomHMFreqDomainMapParams in LALSimIMRPhenomHM.c |
IMRPhenomHMGetRingdownFrequency |
Implementation of IMRPhenomHMGetRingdownFrequency in LALSimIMRPhenomHM.c |
IMRPhenomHMMapParams |
Implementation of IMRPhenomHMMapParams in LALSimIMRPhenomHM.c, line 557 |
IMRPhenomHMOnePointFiveSpinPN |
Implementation of IMRPhenomHMOnePointFiveSpinPN from LALSimIMRPhenomHM.c |
IMRPhenomHMPhase |
Returns IMRPhenomHM phase evaluated at a set of input frequencies for the l,m mode |
IMRPhenomHMPhasePreComp |
Implementation of IMRPhenomHMPhasePreComp in LALSimIMRPhenomHM.c |
IMRPhenomHMSlopeAmAndBm |
Implementation of IMRPhenomHMSlopeAmAndBm in LALSimIMRPhenomHM.c |
IMRPhenomHMTrd |
Implementation of IMRPhenomHMTrd in LALSimIMRPhenomHM.c |
SimRingdownCW_CW07102016 |
Dimensionless QNM Frequencies: Note that name encodes date of writing |
SimRingdownCW_KAPPA |
Domain mapping for dimnesionless BH spin |
XLALSimIMRPhenomHMGethlmModes |
Compute all hlm modes for IMRPhenomHM. JAX translation of XLALSimIMRPhenomHMGethlmModes. |
XLALSimPhenomUtilsChiP |
Compute the effective precession parameter chip. |
XLALSimPhenomUtilsPhenomPv2FinalSpin |
Implementation of XLALSimPhenomUtilsPhenomPv2FinalSpin in LALSimPhenomUtils.c |
gen_IMRPhenomHM |
Generate IMRPhenomHM plus and cross polarizations. |
get_phenomHMFD_mode_projection |
Helper function to compute mode-by-mode plus- and cross-polarisation prefactors |
init_PhenomHM_Storage |
Precompute a bunch of PhenomHM related quantities and store them |
IMRPhenomHMAmplitude(freqs_geom: Float[Array, ' n_freq'], pHM: dict[str, Any], ell: int, mm: int) -> Float[Array, ' n_freq']
¤
Returns IMRPhenomHM amplitude evaluated at a set of input frequencies for the l,m mode Implementation of IMRPhenomHMAmplitude in LALSimIMRPhenomHM.c
IMRPhenomHMEvaluateOnehlmMode(freqs_geom: Float[Array, ' n_freq'], pHM: dict[str, Any], ell: int, mm: int, phi0: FloatLike) -> Complex[Array, ' n_freq']
¤
Implementation of IMRPhenomHMEvaluateOnehlmMode in LALSimIMRPhenomHM.c
IMRPhenomHMFreqDomainMap(Mflm: Float[Array, ' n_freq'], ell: int, mm: int, pHM: dict[str, Any], AmpFlag: bool) -> Float[Array, ' n_freq']
¤
Map input frequency Mflm to the effective 22-mode frequency Mf22 for the (ell, mm) mode.
IMRPhenomHMFreqDomainMapParams(flm: FloatLike | Float[Array, ' n_freq'], ell: int, mm: int, pHM: dict[str, Any], ampFlag: bool) -> tuple[FloatLike | Float[Array, ' n_freq'], FloatLike | Float[Array, ' n_freq']]
¤
Implementation of the phase computation of IMRPhenomHMFreqDomainMapParams in LALSimIMRPhenomHM.c
IMRPhenomHMGetRingdownFrequency(ell: Integer, mm: Integer, finalmass: FloatLike, finalspin: FloatLike) -> tuple[FloatLike, FloatLike]
¤
Implementation of IMRPhenomHMGetRingdownFrequency in LALSimIMRPhenomHM.c
IMRPhenomHMMapParams(flm: FloatLike, fi: FloatLike, fr: FloatLike, Ai: FloatLike, Bi: FloatLike, Am: FloatLike, Bm: FloatLike, Ar: FloatLike, Br: FloatLike) -> tuple[FloatLike, FloatLike]
¤
Implementation of IMRPhenomHMMapParams in LALSimIMRPhenomHM.c, line 557
IMRPhenomHMOnePointFiveSpinPN(fM: Float[Array, ' n_freq'], ell: int, m: int, M1: FloatLike, M2: FloatLike, X1z: FloatLike, X2z: FloatLike) -> Float[Array, ' n_freq']
¤
Implementation of IMRPhenomHMOnePointFiveSpinPN from LALSimIMRPhenomHM.c Currently supported modes: (2,1), (2,2), (3,2), (3,3), (4,3), (4,4)
IMRPhenomHMPhase(freqs_geom: Float[Array, ' n_freq'], pHM: dict[str, Any], ell: int, mm: int) -> Float[Array, ' n_freq']
¤
Returns IMRPhenomHM phase evaluated at a set of input frequencies for the l,m mode Implementation of IMRPhenomHMPhase in LALSimIMRPhenomHM.c
IMRPhenomHMPhasePreComp(q: dict[str, FloatLike], ell: int, emm: int, pHM: dict[str, Any]) -> dict[str, FloatLike]
¤
Implementation of IMRPhenomHMPhasePreComp in LALSimIMRPhenomHM.c
IMRPhenomHMSlopeAmAndBm(mm: int, fi: FloatLike, fr: FloatLike, Mf_RD_22: FloatLike, Mf_RD_lm: FloatLike, AmpFlag: bool, ell: int, pHM: dict[str, Any]) -> tuple[FloatLike, FloatLike]
¤
Implementation of IMRPhenomHMSlopeAmAndBm in LALSimIMRPhenomHM.c
IMRPhenomHMTrd(Mf: FloatLike, Mf_RD_22: FloatLike, Mf_RD_lm: FloatLike, AmpFlag: bool, mode_idx: int, pHM: dict[str, Any]) -> FloatLike
¤
Implementation of IMRPhenomHMTrd in LALSimIMRPhenomHM.c domain mapping function - ringdown
SimRingdownCW_CW07102016(kappa: FloatLike, ell: Integer, input_m: Integer, n: int) -> Complex
¤
Dimensionless QNM Frequencies: Note that name encodes date of writing
SimRingdownCW_KAPPA(jf: FloatLike, ell: Integer, emm: Integer) -> FloatLike
¤
Domain mapping for dimnesionless BH spin
XLALSimIMRPhenomHMGethlmModes(freqs: Float[Array, ' n_freq'], m1_SI: FloatLike, m2_SI: FloatLike, chi1x: FloatLike, chi1y: FloatLike, chi1z: FloatLike, chi2x: FloatLike, chi2y: FloatLike, chi2z: FloatLike, phiRef: FloatLike, deltaF: FloatLike, f_ref: FloatLike, extraParams: dict[str, Any]) -> Complex[Array, 'n_modes n_freq']
¤
Compute all hlm modes for IMRPhenomHM. JAX translation of XLALSimIMRPhenomHMGethlmModes.
XLALSimPhenomUtilsChiP(m1: FloatLike, m2: FloatLike, s1x: FloatLike, s1y: FloatLike, s2x: FloatLike, s2y: FloatLike) -> FloatLike
¤
Compute the effective precession parameter chip.
This is a JAX translation of LALSimIMRPhenomUtils.c XLALSimPhenomUtilsChiP.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
m1
|
float or array
|
Mass of companion 1 (solar masses). |
required |
m2
|
float or array
|
Mass of companion 2 (solar masses). |
required |
s1x
|
float or array
|
x-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1). |
required |
s1y
|
float or array
|
y-component of the dimensionless spin of object 1 w.r.t. Lhat = (0,0,1). |
required |
s2x
|
float or array
|
x-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1). |
required |
s2y
|
float or array
|
y-component of the dimensionless spin of object 2 w.r.t. Lhat = (0,0,1). |
required |
Returns:
| Type | Description |
|---|---|
FloatLike
|
float or array: Effective precession parameter chip. |
XLALSimPhenomUtilsPhenomPv2FinalSpin(m1: FloatLike, m2: FloatLike, chi1_l: FloatLike, chi2_l: FloatLike, chip: FloatLike) -> FloatLike
¤
Implementation of XLALSimPhenomUtilsPhenomPv2FinalSpin in LALSimPhenomUtils.c Assuming m1 >= m2
gen_IMRPhenomHM(frequency_array: Float[Array, ' n_freq'], mass_1: FloatLike, mass_2: FloatLike, chi1: FloatLike, chi2: FloatLike, distance: FloatLike, inclination: FloatLike, phi0: FloatLike, reference_frequency: FloatLike) -> tuple[Complex[Array, ' n_freq'], Complex[Array, ' n_freq']]
¤
Generate IMRPhenomHM plus and cross polarizations.
get_phenomHMFD_mode_projection(theta: FloatLike, minus1l: int | Array, ell: int | Array, m: int | Array) -> Array
¤
Helper function to compute mode-by-mode plus- and cross-polarisation prefactors
init_PhenomHM_Storage(p: dict[str, Any], m1_SI: FloatLike, m2_SI: FloatLike, chi1x: FloatLike, chi1y: FloatLike, chi1z: FloatLike, chi2x: FloatLike, chi2y: FloatLike, chi2z: FloatLike, freqs: Float[Array, ' n_freq'], deltaF: FloatLike, f_ref: FloatLike, phiRef: FloatLike, ModeArray: Integer[Array, 'n_modes 2']) -> dict[str, Any]
¤
Precompute a bunch of PhenomHM related quantities and store them Implementation of init_PhenomHM_Storage in LALSimIMRPhenomHM.c