Help on function get_imr_esigma_waveform in module gwnr.waveform.esigma_utils:
get_imr_esigma_waveform(mass1, mass2, f_lower, delta_t, f_ref=None, spin1z=0.0, spin2z=0.0, eccentricity=0.0, mean_anomaly=0.0, coa_phase=0.0, inclination=0.0, distance=1.0, modes_to_use=[(2, 2), (3, 3), (4, 4)], mode_to_align_by=(2, 2), f_mr_transition=None, f_window_mr_transition=None, num_hyb_orbits=0.25, hybridize_using_avg_orbital_frequency=True, hybridize_aligning_merger_to_inspiral=True, keep_f_mr_transition_at_center=False, merger_ringdown_approximant='NRSur7dq4', return_hybridization_info=False, return_orbital_params=False, failsafe=True, verbose=False, **kwargs)
Returns IMR GW polarizations constructed using IMR ESIGMA modes
Parameters:
-----------
mass1, mass2 -- Binary's component masses (in solar masses)
f_lower -- Starting frequency of the waveform (in Hz)
f_ref -- Reference frequency at which to define the
waveform parameters. We require that
`f_ref <= f_lower`.
`f_ref = f_lower` by default.
delta_t -- Waveform's time grid-spacing (in s)
spin1z, spin2z -- z-components of component dimensionless
spins (lies in [0,1))
eccentricity -- Initial eccentricity
mean_anomaly -- Mean anomaly of the periastron (in rad)
inclination -- Inclination (in rad), defined as the angle
between the orbital angular momentum L and
the line-of-sight
coa_phase -- Coalesence phase of the binary (in rad)
distance -- Luminosity distance to the binary (in Mpc)
modes_to_use -- GW modes to use. List of tuples (l, |m|)
mode_to_align_by -- GW mode to use to align inspiral and merger
in phase and time
f_mr_transition -- Inspiral to merger transition GW frequency
(Hz).
Defaults to the minimum of the Kerr and
Schwarzschild ISCO frequency
f_window_mr_transition -- Hybridization frequency window (in Hz).
Disabled by the default value (None). In
such a case, the hybridization proceeds
over a window of `num_hyb_orbits` orbital
cycles (1 orbital cycle ~ 2 GW cycles)
that ends at the frequency value given by
`f_mr_transition`.
Also see `keep_f_mr_transition_at_center`
to choose the position of `f_mr_transition`
within this window.
num_hyb_orbits -- number of orbital cycles to hybridize over.
Only used if f_window_mr_transition is not
specified.
hybridize_using_avg_orbital_frequency -- If True, the orbit averaged
frequency during the inspiral is used to
hybridize modes, instead of the modes'
frequency.
keep_f_mr_transition_at_center -- If True, `f_mr_transition` is kept at
the center of the hybridization window.
Otherwise, it's kept at the end of the
window (default).
merger_ringdown_approximant -- Choose merger-ringdown model. Tested
choices: [NRSur7dq4, SEOBNRv4PHM]
return_hybridization_info -- If True, returns hybridization related data
return_orbital_params -- If True, returns the orbital evolution of
all the orbital elements (in
geometrized units). Can also be a list of
orbital variable names to return
only those specific variables. Available
orbital variables names are:
['x', 'e', 'l', 'phi', 'phidot', 'r', 'rdot'].
Note that these are available only for the
inspiral portion of the waveform!
failsafe -- If True, we make reasonable choices for the
user, if the inputs to this method lead
into exceptions.
verbose -- Verbosity level. Available values are: 0, 1, 2
Returns:
--------
hp, hc -- Plus and cross IMR GW polarizations PyCBC TimeSeries
orbital_vars_dict -- Dictionary of evolution of orbital elements.
Returned only if return_orbital_params is specified
retval -- Hybridization related data.
Returned only if return_hybridization_info is True
