template_bank_generator_HM#

Back to API tree index

Purpose#

HM template-bank generation and basis-coefficient utilities.

Module summary#

No module-level description available.

Top-level functions#
Function	Summary
compute_hplus_hcross	Generate frequency domain waveform using LAL. Return hplus, hcross evaluated at f.
compute_overlap	Overlap between two waveforms
compute_snr_efficiency	Computes factor by which overlap degrades = SNR efficiency
gen_random_pars	Generates n_wf random parameters. Applies either mrng (preferably) or mtrng, along with qrng
gen_waveform	Generates waveforms with given binary parameters
get_df	No docstring summary available.
get_efficient_frequencies	Return a grid of frequencies that allows to safely get unwrapped phase. At low frequencies (fmin < f < fmid) it guarantees that the post-Newtonian phase increases by constant amounts of <= delta_radians for mchirp >= mchirp_min. At high frequencies (fmid < f < fmax) it switches to a regular grid.
get_prior_interp_func	create a function that interpolate the prior for N-dimensional c-alpha array
remove_linear_component	Fits out a linear dependence of phase w.r.t frequency
summarize_prior	This module creates the .pickle file for the template prior which is later used in ranking the candidates.
summarize_prior_single_subbank	calpha_samples and calpha_test_set should have sample weights as their last column (the sample weights are corresponding to volume sensitivity in the case of the HM search)
transform_basis	Returns components of waveforms in the given basis
transform_pars	Transforms [m1, m2, s1z, s2z, lambda1, lambda2] to commonly used parameters [mchirp, eta, chieff, chia, tilde{lambda}, delta tilde{lambda}]
upsample_lwfs	Upsample given lwfs to an output frequency grid Note: Amplitudes are linearly interpolated, with zeros outside the range Pad phases with edge values to avoid discontinuities at the edges

Classes#
Class	Summary
MultiBank	No class docstring summary available.
TemplateBank	No class docstring summary available.