API for the jaxqualin.waveforms module

waveform

A class representing a waveform containing a ringdown phase to be fitted.

Attributes:

Name	Type	Description
fulltime	ndarray	The full time array of the waveform.
fullh	ndarray	The full complex waveform.
peaktime	float	The time of peak strain jnp.abs(h) of the waveform.
peakindx	int	The array index of the time of peak strain of the waveform.
t_peak	int	The time of peak strain of the waveform. This can be defined by the user and overrides peaktime.
time	ndarray	The time array of the waveform after the peak, starting at t_peak and time shifted such that t_peak = 0.
hr	ndarray	The real part of the waveform after the peak.
hi	ndarray	The imaginary part of the waveform after the peak.
h	ndarray	The complex waveform after the peak.
l	int	The spherical harmonic mode number l of the waveform.
m	int	The spherical harmonic mode number m of the waveform.

Methods:

Name	Description
update_peaktime	Sets t_peak to override the peak time.
argabsmax	Returns the array index of the time of peak strain of the waveform.
postmerger	Returns the time, real part, and imaginary part of the waveform after the peak.
set_lm	Sets the spherical harmonic mode numbers l and m of the waveform.

__init__(fulltime, fullh, t_peak=None, t_start=0.0, t_end=np.inf, l=None, m=None, remove_num=500)

Initialize a waveform.

Parameters:

Name	Type	Description	Default
fulltime	ndarray	The full time array of the waveform.	required
fullh	ndarray	The full complex waveform.	required
t_peak	Optional[float]	The time of peak strain of the waveform. This can be defined by the user and overrides peaktime.	None
t_start	float	The time after the peak to start the waveform.	0.0
t_end	float	The time after the peak to end the waveform.	inf
l	int	The spherical harmonic mode number l of the waveform.	None
m	int	The spherical harmonic mode number m of the waveform.	None
remove_num	int	The number of points to remove from the beginning of the waveform to avoid numerical artifacts.	500

argabsmax(remove_num=500)

Returns the array index of the time of peak strain of the waveform.

Parameters:

Name	Type	Description	Default
remove_num	int	The number of points to remove from the beginning of the waveform to avoid numerical artifacts.	500

Returns:

Type	Description
int	The array index of the time of peak strain of the waveform.

postmerger(t_start, t_end=np.inf)

Returns the time, real part, and imaginary part of the waveform after the peak.

Parameters:

Name	Type	Description	Default
t_start	float	The time after the peak to start the waveform. t_end: The time after the peak to end the waveform.	required

Returns:

Type	Description
ndarray	The time, real part, and imaginary part of the waveform after the
ndarray	peak.

set_lm(l, m)

Sets the spherical harmonic mode numbers l and m of the waveform.

Parameters:

Name	Type	Description	Default
l	int	The spherical harmonic mode number l of the waveform.	required
m	int	The spherical harmonic mode number m of the waveform.	required

update_peaktime(t_peak)

Override the peak time of the waveform.

Parameters:

Name	Type	Description	Default
t_peak	float	The user-defined peak time of the waveform.	required

get_SXS_waveform_summed(SXSnum, iota, psi, l_max=4, res=0, N_ext=2)

Obtain the waveform of a SXS simulation summed over all modes up to l_max, using pycbc.waveform.waveform_modes.sum_modes.

Parameters:

Name	Type	Description	Default
SXSnum	str	The SXS simulation number.	required
iota	float	The inclination angle of the binary.	required
psi	float	The phase to use.	required
l_max	int	The maximum l mode to include in the waveform.	4
res	int	The level of the simulation, relative to the highest resolution level (res = 0 means highest resolution). Must be zero or negative.	0
N_ext	int	The extrapolation order of the simulation.	2

Returns:

Name	Type	Description
h	waveform	The waveform.
Mf	float	The final mass of the binary.
af	float	The final spin of the binary.