sage.data.waveform.distributions.legacy

Classes

BoundedPriors

Geometrically bounded prior generator in the (tau0, tau3) chirp-time space.

Functions

q_from_mass1_mass2(mass1, mass2)	Return the mass ratio q = m1/m2 (≥ 1 when m1 ≥ m2).
chirp_mass_from_signal_duration(tau, ...)	Convert Newtonian chirp duration to chirp mass.
signal_duration_from_chirp_mass(mchirp, ...)	Convert chirp mass to Newtonian in-band signal duration.
mass1_from_mchirp_q(mchirp, q)	Return the primary mass given chirp mass mchirp and mass ratio q = m1/m2.
mass2_from_mchirp_q(mchirp, q)	Return the secondary mass given chirp mass mchirp and mass ratio q = m1/m2.
mass1_mass2_from_mchirp_q(mchirp, q)	Return (mass1, mass2) from chirp mass and mass ratio q = m1/m2.
get_mchirp_priors(ml, mu)	Return (min_mchirp, max_mchirp) for equal-mass binaries at the given
get_tau_priors(ml, mu, lf)	Return Newtonian chirp-time bounds (tau_lower, tau_upper) for the
get_uniform_masses_with_mass1_gt_mass2(mass_lower, ...)	Draw num_samples pairs of component masses uniformly in

Module Contents

q_from_mass1_mass2(mass1, mass2)

Return the mass ratio q = m1/m2 (≥ 1 when m1 ≥ m2).

chirp_mass_from_signal_duration(tau, signal_low_freq_cutoff)

Convert Newtonian chirp duration to chirp mass.

Parameters:

• tau (float) – Chirp duration in seconds.

• signal_low_freq_cutoff (float) – Lower frequency cutoff (Hz).

Returns:

Chirp mass in solar masses.

Return type:

float

signal_duration_from_chirp_mass(mchirp, signal_low_freq_cutoff)

Convert chirp mass to Newtonian in-band signal duration.

Parameters:

• mchirp (float) – Chirp mass in solar masses.

• signal_low_freq_cutoff (float) – Lower frequency cutoff (Hz).

Returns:

Expected signal duration in seconds.

Return type:

float

mass1_from_mchirp_q(mchirp, q)

Return the primary mass given chirp mass mchirp and mass ratio q = m1/m2.

mass2_from_mchirp_q(mchirp, q)

Return the secondary mass given chirp mass mchirp and mass ratio q = m1/m2.

mass1_mass2_from_mchirp_q(mchirp, q)

Return (mass1, mass2) from chirp mass and mass ratio q = m1/m2.

get_mchirp_priors(ml, mu)

Return (min_mchirp, max_mchirp) for equal-mass binaries at the given component-mass limits ml (lower) and mu (upper).

get_tau_priors(ml, mu, lf)

Return Newtonian chirp-time bounds (tau_lower, tau_upper) for the given mass range [ml, mu] and frequency cutoff lf.

get_uniform_masses_with_mass1_gt_mass2(mass_lower, mass_upper, num_samples)

Draw num_samples pairs of component masses uniformly in [mass_lower, mass_upper] with the mass ordering constraint m1 ≥ m2.

Returns:

mass1, mass2 – Arrays of shape (num_samples,) satisfying mass1 >= mass2.

Return type:

np.ndarray

class BoundedPriors(mu, ml, lf)

Geometrically bounded prior generator in the (tau0, tau3) chirp-time space.

Provides boundary helpers and mass-draw methods for the PyCBC template-placement metric used by the legacy dataset generation pipeline.

Parameters:

• mu (float) – Upper component-mass limit (solar masses).

• ml (float) – Lower component-mass limit (solar masses).

• lf (float) – Signal low-frequency cutoff (Hz).

lf

mu

ml

const

tau3_boundary_low

tau3_boundary_high

tau0_boundary_low

tau0_boundary_high

tau3_lower_boundary_from_tau0(_tau0)

tau3_upper_boundary_from_tau0(_tau0)

q_upper_boundary_from_mchirp(_mchirp)

get_bounded_gwparams_from_uniform_tau()

get_bounded_gwparams_from_uniform_mchirp()

get_bounded_gwparams_from_powerlaw_mchirp()

get_bounded_gwparams_from_powerlaw_tau()

get_bounded_gwparams_from_uniform_mchirp_given_limits(mchirp_lower=None, mchirp_upper=None)

get_bounded_gwparams_from_template_placement_metric()

get_bounded_gwparams_from_uniform_in_mchirp_q()