IMRPhenomD

Functions:

Name	Description
`Amp`	Computes the amplitude of the PhenomD frequency domain waveform following 1508.07253.
`IMRPhenDAmplitude`	Useful function for IMRPhenomHM. Computes the Amp variable of Amp() (defined below)
`IMRPhenDAmplitude_NoCut`	Same as IMRPhenDAmplitude but without the fM_CUT cutoff.
`Phase`	Computes the phase of the PhenomD waveform following 1508.07253.
`gen_IMRPhenomD`	Generate PhenomD frequency domain waveform following 1508.07253.
`gen_IMRPhenomD_hphc`	Generate PhenomD frequency domain waveform following 1508.07253.
`get_inspiral_phase`	Calculate the inspiral phase for the IMRPhenomD waveform.

`Amp(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike], D: FloatLike = 1) -> Float[Array, ' n_freq']` ¤

Computes the amplitude of the PhenomD frequency domain waveform following 1508.07253. Note that this waveform also assumes that object one is the more massive.

Returns:

Name	Type	Description
`Amplitude`	`array`

`IMRPhenDAmplitude(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike]) -> Float[Array, ' n_freq']` ¤

Useful function for IMRPhenomHM. Computes the Amp variable of Amp() (defined below)

`IMRPhenDAmplitude_NoCut(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike]) -> Float[Array, ' n_freq']` ¤

Same as IMRPhenDAmplitude but without the fM_CUT cutoff. Used by IMRPhenomHM where mapped frequencies can exceed fM_CUT.

`Phase(f: Float[Array, ' n_freq'] | float, theta: Float[Array, 4], coeffs: Float[Array, 19], transition_freqs: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike], Rholm: float = 1.0, Taulm: float = 1.0) -> Float[Array, ' n_freq']` ¤

Computes the phase of the PhenomD waveform following 1508.07253. Sets time and phase of coealence to be zero.

Returns:

Name	Type	Description
`phase`	`array`	Phase of the GW as a function of frequency

`gen_IMRPhenomD(f: Float[Array, ' n_freq'], params: Float[Array, 7], f_ref: float) -> Complex[Array, ' n_freq']` ¤

Generate PhenomD frequency domain waveform following 1508.07253. vars array contains both intrinsic and extrinsic variables theta = [Mchirp, eta, chi1, chi2, D, tc, phic] Mchirp: Chirp mass of the system [solar masses] eta: Symmetric mass ratio [between 0.0 and 0.25] chi1: Dimensionless aligned spin of the primary object [between -1 and 1] chi2: Dimensionless aligned spin of the secondary object [between -1 and 1] D: Luminosity distance to source [Mpc] tc: Time of coalesence. This only appears as an overall linear in f contribution to the phase phic: Phase of coalesence

f_ref: Reference frequency for the waveform

Returns:

Name	Type	Description
`h0`	`array`	Strain

`gen_IMRPhenomD_hphc(f: Float[Array, ' n_freq'], params: Float[Array, 8], f_ref: float) -> tuple[Complex[Array, ' n_freq'], Complex[Array, ' n_freq']]` ¤

Generate PhenomD frequency domain waveform following 1508.07253. vars array contains both intrinsic and extrinsic variables theta = [Mchirp, eta, chi1, chi2, D, tc, phic] Mchirp: Chirp mass of the system [solar masses] eta: Symmetric mass ratio [between 0.0 and 0.25] chi1: Dimensionless aligned spin of the primary object [between -1 and 1] chi2: Dimensionless aligned spin of the secondary object [between -1 and 1] D: Luminosity distance to source [Mpc] tc: Time of coalesence. This only appears as an overall linear in f contribution to the phase phic: Phase of coalesence inclination: Inclination angle of the binary [between 0 and PI]

f_ref: Reference frequency for the waveform

Returns:

Name	Type	Description
`hp`	`array`	Strain of the plus polarization
`hc`	`array`	Strain of the cross polarization

`get_inspiral_phase(fM_s: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19]) -> Float[Array, ' n_freq']` ¤

Calculate the inspiral phase for the IMRPhenomD waveform.

IMRPhenomD

Amp(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike], D: FloatLike = 1) -> Float[Array, ' n_freq'] ¤

IMRPhenDAmplitude(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike]) -> Float[Array, ' n_freq'] ¤

IMRPhenDAmplitude_NoCut(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike]) -> Float[Array, ' n_freq'] ¤

Phase(f: Float[Array, ' n_freq'] | float, theta: Float[Array, 4], coeffs: Float[Array, 19], transition_freqs: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike], Rholm: float = 1.0, Taulm: float = 1.0) -> Float[Array, ' n_freq'] ¤

gen_IMRPhenomD(f: Float[Array, ' n_freq'], params: Float[Array, 7], f_ref: float) -> Complex[Array, ' n_freq'] ¤

gen_IMRPhenomD_hphc(f: Float[Array, ' n_freq'], params: Float[Array, 8], f_ref: float) -> tuple[Complex[Array, ' n_freq'], Complex[Array, ' n_freq']] ¤

get_inspiral_phase(fM_s: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19]) -> Float[Array, ' n_freq'] ¤

`Amp(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike], D: FloatLike = 1) -> Float[Array, ' n_freq']` ¤

`IMRPhenDAmplitude(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike]) -> Float[Array, ' n_freq']` ¤

`IMRPhenDAmplitude_NoCut(f: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19], transition_frequencies: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike]) -> Float[Array, ' n_freq']` ¤

`Phase(f: Float[Array, ' n_freq'] | float, theta: Float[Array, 4], coeffs: Float[Array, 19], transition_freqs: tuple[FloatLike, FloatLike, FloatLike, FloatLike, FloatLike, FloatLike], Rholm: float = 1.0, Taulm: float = 1.0) -> Float[Array, ' n_freq']` ¤

`gen_IMRPhenomD(f: Float[Array, ' n_freq'], params: Float[Array, 7], f_ref: float) -> Complex[Array, ' n_freq']` ¤

`gen_IMRPhenomD_hphc(f: Float[Array, ' n_freq'], params: Float[Array, 8], f_ref: float) -> tuple[Complex[Array, ' n_freq'], Complex[Array, ' n_freq']]` ¤

`get_inspiral_phase(fM_s: Float[Array, ' n_freq'], theta: Float[Array, 4], coeffs: Float[Array, 19]) -> Float[Array, ' n_freq']` ¤