template_bank_generator_HM.compute_overlap#

Back to Module page

Summary#

Overlap between two waveforms

Signature#

def compute_overlap(wf1, wf2, fs, asds)
Input variables#

Name

Type

Default

Description

wf1

… x len(fs) array with frequency domain waveforms (units of 1/Hz), can be vector if n_wf = 1

wf2

… x len(fs) array with frequency domain waveforms (units of 1/Hz), can be vector if n_wf = 1

fs

Array with regularly spaced frequencies (units of Hz)

asds

ASDs in units of 1/sqrt(Hz) at fs

Output variables#

Return annotation

Docstring type

Description

None

Scalar or array of length n_wf with overlaps

Docstring#

Overlap between two waveforms
:param wf1: ... x len(fs) array with frequency domain waveforms
            (units of 1/Hz), can be vector if n_wf = 1
:param wf2: ... x len(fs) array with frequency domain waveforms
            (units of 1/Hz), can be vector if n_wf = 1
:param fs: Array with regularly spaced frequencies (units of Hz)
:param asds: ASDs in units of 1/sqrt(Hz) at fs
:return: Scalar or array of length n_wf with overlaps