Detailed Description

This header provides core prototypes, structures and functions to filter interferometer data for binary inspiral chirps.

Author: Allen, B., Brown, D. A. and Creighton, J. D. E.

Synopsis

#include <lal/FindChirp.h>

Each function in findchirp falls into one of four classes:

Generate management functions which are independent of the type of filtering implemented. The prototypes for these functions are provided by this header file.
Functions for filtering data for time domain and frequency domain templates with an unknown amplitude and phase. These are the functions that implement matched filtering for time domain templates (TaylorT1, TaylorT2, TaylorT2, PadeT1, EOB and GeneratePPN) and matched filtering for post-Newtonian frequency domain templates (FindChirpSP). The main filter function FindChirpFilterSegment() is prototyped in this header file. Full documentation of the filtering algorithm used can be found in the documentation of the module FindChirpFilter::c.

The goal of all the filtering functions is to determine if the (calibrated) output of the interferometer \(s(t)\) contains a gravitational wave \(h(t)\) in the presence of the detector noise \(n(t)\). When the interferometer is operating properly

\begin{equation} s(t) = \left\{ \begin{array}{ll} n(t) + h(t) & \textrm{signal present},\\ n(t) & \textrm{signal absent}. \end{array}\right. \end{equation}

The detection of signals of known form in noise is a classic problem of signal processing [23] and can be answered by the construction of a detection statistic and a test to see if the statistic is above some pre-assigned threshold. The construction of the various detection statistics used for each the three types of search are described in the modules that implement the search.

Files
file	FindChirpSimulation.c
	Provides an interface between code build from `findchirp` and various simulation packages for injecting chirps into data.

Error Codes
#define	FINDCHIRPH_ENULL 1
	Null pointer. More...

#define	FINDCHIRPH_ENNUL 2
	Non-null pointer. More...

#define	FINDCHIRPH_EALOC 3
	Memory allocation error. More...

#define	FINDCHIRPH_ENUMZ 5
	Invalid number of points in segment. More...

#define	FINDCHIRPH_ESEGZ 6
	Invalid number of segments. More...

#define	FINDCHIRPH_ECHIZ 7
	Invalid number of chi squared bins. More...

#define	FINDCHIRPH_EDTZO 8
	deltaT is zero or negative More...

#define	FINDCHIRPH_ETRNC 10
	Duration of inverse spectrum in time domain is negative. More...

#define	FINDCHIRPH_EFLOW 11
	Inverse spectrum low frequency cutoff is negative. More...

#define	FINDCHIRPH_EFREE 12
	Error freeing memory. More...

#define	FINDCHIRPH_ERHOT 15
	Rhosq threshold is negative. More...

#define	FINDCHIRPH_ECHIT 16
	Chisq threshold is negative. More...

#define	FINDCHIRPH_ECRUP 17
	Chirp length or invSpecTrunc too long for length of data segment. More...

#define	FINDCHIRPH_ESMSM 18
	Size mismatch between vectors. More...

#define	FINDCHIRPH_EHETR 19
	Attempting to simulate heterodyned GW. More...

#define	FINDCHIRPH_EDFDT 20
	Waveform sampling interval is too large. More...

#define	FINDCHIRPH_EAPRX 21
	Incorrect waveform approximant. More...

#define	FINDCHIRPH_EUAPX 22
	Unknown waveform approximant. More...

#define	FINDCHIRPH_ECHTZ 23
	Length of chirp is zero or negative. More...

#define	FINDCHIRPH_EMASS 24
	Invalid mass parameters for template generation. More...

#define	FINDCHIRPH_EWVFM 25
	Unknown injection waveform. More...

#define	FINDCHIRPH_EBCVC 25
	BCVC code: thetav not in [-pi, pi]. More...

#define	FINDCHIRPH_EMAPX 26
	Mismatch in waveform approximant. More...

#define	FINDCHIRPH_EPTFW 27
	Error generating PTF waveform. More...

#define	FINDCHIRPH_EIGEN 28
	Error computing eigenvalues. More...

#define	FINDCHIRPH_EIMRW 29
	Error computing IMR waveform. More...

#define	FINDCHIRPH_EFLOX 30
	Error computing variable flower. More...

Macro Definition Documentation

◆ FINDCHIRPH_ENULL

#define FINDCHIRPH_ENULL 1

Null pointer.

Definition at line 95 of file FindChirp.h.

◆ FINDCHIRPH_ENNUL

#define FINDCHIRPH_ENNUL 2

Non-null pointer.

Definition at line 96 of file FindChirp.h.

◆ FINDCHIRPH_EALOC

#define FINDCHIRPH_EALOC 3

Memory allocation error.

Definition at line 97 of file FindChirp.h.

◆ FINDCHIRPH_ENUMZ

#define FINDCHIRPH_ENUMZ 5

Invalid number of points in segment.

Definition at line 98 of file FindChirp.h.

◆ FINDCHIRPH_ESEGZ

#define FINDCHIRPH_ESEGZ 6

Invalid number of segments.

Definition at line 99 of file FindChirp.h.

◆ FINDCHIRPH_ECHIZ

#define FINDCHIRPH_ECHIZ 7

Invalid number of chi squared bins.

Definition at line 100 of file FindChirp.h.

◆ FINDCHIRPH_EDTZO

#define FINDCHIRPH_EDTZO 8

deltaT is zero or negative

Definition at line 101 of file FindChirp.h.

◆ FINDCHIRPH_ETRNC

#define FINDCHIRPH_ETRNC 10

Duration of inverse spectrum in time domain is negative.

Definition at line 102 of file FindChirp.h.

◆ FINDCHIRPH_EFLOW

#define FINDCHIRPH_EFLOW 11

Inverse spectrum low frequency cutoff is negative.

Definition at line 103 of file FindChirp.h.

◆ FINDCHIRPH_EFREE

#define FINDCHIRPH_EFREE 12

Error freeing memory.

Definition at line 104 of file FindChirp.h.

◆ FINDCHIRPH_ERHOT

#define FINDCHIRPH_ERHOT 15

Rhosq threshold is negative.

Definition at line 105 of file FindChirp.h.

◆ FINDCHIRPH_ECHIT

#define FINDCHIRPH_ECHIT 16

Chisq threshold is negative.

Definition at line 106 of file FindChirp.h.

◆ FINDCHIRPH_ECRUP

#define FINDCHIRPH_ECRUP 17

Chirp length or invSpecTrunc too long for length of data segment.

Definition at line 107 of file FindChirp.h.

◆ FINDCHIRPH_ESMSM

#define FINDCHIRPH_ESMSM 18

Size mismatch between vectors.

Definition at line 108 of file FindChirp.h.

◆ FINDCHIRPH_EHETR

#define FINDCHIRPH_EHETR 19

Attempting to simulate heterodyned GW.

Definition at line 109 of file FindChirp.h.

◆ FINDCHIRPH_EDFDT

#define FINDCHIRPH_EDFDT 20

Waveform sampling interval is too large.

Definition at line 110 of file FindChirp.h.

◆ FINDCHIRPH_EAPRX

#define FINDCHIRPH_EAPRX 21

Incorrect waveform approximant.

Definition at line 111 of file FindChirp.h.

◆ FINDCHIRPH_EUAPX

#define FINDCHIRPH_EUAPX 22

Unknown waveform approximant.

Definition at line 112 of file FindChirp.h.

◆ FINDCHIRPH_ECHTZ

#define FINDCHIRPH_ECHTZ 23

Length of chirp is zero or negative.

Definition at line 113 of file FindChirp.h.

◆ FINDCHIRPH_EMASS

#define FINDCHIRPH_EMASS 24

Invalid mass parameters for template generation.

Definition at line 114 of file FindChirp.h.

◆ FINDCHIRPH_EWVFM

#define FINDCHIRPH_EWVFM 25

Unknown injection waveform.

Definition at line 115 of file FindChirp.h.

◆ FINDCHIRPH_EBCVC

#define FINDCHIRPH_EBCVC 25

BCVC code: thetav not in [-pi, pi].

Definition at line 116 of file FindChirp.h.

◆ FINDCHIRPH_EMAPX

#define FINDCHIRPH_EMAPX 26

Mismatch in waveform approximant.

Definition at line 117 of file FindChirp.h.

◆ FINDCHIRPH_EPTFW

#define FINDCHIRPH_EPTFW 27

Error generating PTF waveform.

Definition at line 118 of file FindChirp.h.

◆ FINDCHIRPH_EIGEN

#define FINDCHIRPH_EIGEN 28

Error computing eigenvalues.

Definition at line 119 of file FindChirp.h.

◆ FINDCHIRPH_EIMRW

#define FINDCHIRPH_EIMRW 29

Error computing IMR waveform.

Definition at line 120 of file FindChirp.h.

◆ FINDCHIRPH_EFLOX

#define FINDCHIRPH_EFLOX 30

Error computing variable flower.

Definition at line 121 of file FindChirp.h.