Prototypes
REAL4	compute_candle_distance (REAL4 candleM1, REAL4 candleM2, REAL4 thissnr, REAL8 chanDeltaT, INT4 nPoints, REAL8FrequencySeries *spec, UINT4 cut)

REAL4	XLALCandleDistanceTD (Approximant approximant, REAL4 candleM1, REAL4 candleM2, REAL4 candlesnr, REAL8 chanDeltaT, INT4 nPoints, REAL8FrequencySeries *spec, UINT4 cut)

void	AddNumRelStrainModes (LALStatus status, REAL4TimeVectorSeries outStrain, SimInspiralTable thisinj)

void	InjectNumRelWaveformsUsingPSDREAL8 (LALStatus status, REAL8TimeSeries chan, SimInspiralTable injections, CHAR ifo[3], REAL8 freqLowCutoff, REAL8 snrLow, REAL8 snrHigh, REAL8FrequencySeries ligoPSD, REAL8 ligoSnrLowFreq, REAL8FrequencySeries virgoPSD, REAL8 virgoSnrLowFreq, CHAR fname)
	Main function for injecting numetrical relativity waveforms. More...

void	InjectNumRelWaveforms (LALStatus status, REAL4TimeSeries chan, SimInspiralTable injections, CHAR ifo[3], REAL8 dynRange, REAL8 freqLowCutoff, REAL8 snrLow, REAL8 snrHigh, CHAR fname)
	Main function for injecting numetrical relativity waveforms. More...

void	InjectNumRelWaveformsREAL8 (LALStatus status, REAL8TimeSeries chan, SimInspiralTable injections, CHAR ifo[3], REAL8 freqLowCutoff, REAL8 snrLow, REAL8 snrHigh, CHAR fname)
	Main function for injecting numetrical relativity waveforms. More...

REAL8	start_freq_from_frame_url (CHAR *url)

REAL8	calculate_ligo_snr_from_strain_real8 (REAL8TimeSeries *strain, const CHAR ifo[3])

REAL8	calculate_snr_from_strain_and_psd_real8 (REAL8TimeSeries strain, REAL8FrequencySeries psd, REAL8 startFreq, const CHAR ifo[3])

REAL8	calculate_ligo_snr_from_strain (REAL4TimeVectorSeries strain, SimInspiralTable thisInj, const CHAR ifo[3])

int	XLALPsdFromFile (REAL8FrequencySeries *psd, const CHAR filename)

REAL8FrequencySeries *	XLALInterpolatePSD (REAL8FrequencySeries *in, REAL8 deltaFout)
	Function for interpolating PSD to a given sample rate. More...

void	get_FakePsdFromString (REAL8FrequencySeries PsdFreqSeries, char FakePsdName, REAL8 StartFreq)

REAL8	calculate_lalsim_snr (SimInspiralTable inj, char IFOname, REAL8FrequencySeries *psd, REAL8 start_freq)

Function Documentation

◆ compute_candle_distance()

REAL4 compute_candle_distance	(	REAL4	candleM1,
		REAL4	candleM2,
		REAL4	thissnr,
		REAL8	chanDeltaT,
		INT4	nPoints,
		REAL8FrequencySeries *	spec,
		UINT4	cut
	)

Definition at line 84 of file inspiralutils.c.

◆ XLALCandleDistanceTD()

REAL4 XLALCandleDistanceTD	(	Approximant	approximant,
		REAL4	candleM1,
		REAL4	candleM2,
		REAL4	candlesnr,
		REAL8	chanDeltaT,
		INT4	nPoints,
		REAL8FrequencySeries *	spec,
		UINT4	cut
	)

Definition at line 119 of file inspiralutils.c.

◆ AddNumRelStrainModes()

void AddNumRelStrainModes	(	LALStatus *	status,
		REAL4TimeVectorSeries **	outStrain,
		SimInspiralTable *	thisinj
	)

Parameters

	status	pointer to LALStatus structure
[out]	outStrain	h+, hx data
[in]	thisinj	injection data

Definition at line 189 of file inspiralutils.c.

◆ InjectNumRelWaveformsUsingPSDREAL8()

void InjectNumRelWaveformsUsingPSDREAL8	(	LALStatus *	status,
		REAL8TimeSeries *	chan,
		SimInspiralTable *	injections,
		CHAR	ifo[3],
		REAL8	freqLowCutoff,
		REAL8	snrLow,
		REAL8	snrHigh,
		REAL8FrequencySeries *	ligoPSD,
		REAL8	ligoSnrLowFreq,
		REAL8FrequencySeries *	virgoPSD,
		REAL8	virgoSnrLowFreq,
		CHAR *	fname
	)

Main function for injecting numetrical relativity waveforms.

Takes as input a list of injections, and adds h(t) to a given timeseries for a specified ifo and a dynamic range factor. Updated/generalized version of InjectNumRelWaveforms that allows arbitrary LIGO and Virgo PSDs and integration starting frequencies

Parameters

	status	pointer to LALStatus structure
[out]	chan	the output time series
[in]	injections	list of injections
[in]	ifo	2 char code for interferometer
[in]	freqLowCutoff	Lower cutoff frequency
[in]	snrLow	lower cutoff value of snr
	snrHigh	TO BE DOCUMENTED
[in]	ligoPSD	PSD to use for LIGO SNRs. If NULL, use initial PSD
[in]	ligoSnrLowFreq	Frequency at which to start integration for LIGO SNRs
[in]	virgoPSD	PSD to use for Virgo SNRs. If NULL, use initial PSD
[in]	virgoSnrLowFreq	Frequency at which to start integration for Virgo SNRs
[in]	fname	higher cutoff value of snr

Definition at line 328 of file inspiralutils.c.

◆ InjectNumRelWaveforms()

void InjectNumRelWaveforms	(	LALStatus *	status,
		REAL4TimeSeries *	chan,
		SimInspiralTable *	injections,
		CHAR	ifo[3],
		REAL8	dynRange,
		REAL8	freqLowCutoff,
		REAL8	snrLow,
		REAL8	snrHigh,
		CHAR *	fname
	)

Main function for injecting numetrical relativity waveforms.

Takes as input a list of injections, and adds h(t) to a given timeseries for a specified ifo and a dynamic range factor.

Parameters

	status	pointer to LALStatus structure
[out]	chan	the output time series
[in]	injections	list of injections
[in]	ifo	2 char code for interferometer
[in]	dynRange	dynamic range factor for scaling time series
[in]	freqLowCutoff	Lower cutoff frequency
[in]	snrLow	lower cutoff value of snr
	snrHigh	TO BE DOCUMENTED
[in]	fname	higher cutoff value of snr

Definition at line 435 of file inspiralutils.c.

◆ InjectNumRelWaveformsREAL8()

void InjectNumRelWaveformsREAL8	(	LALStatus *	status,
		REAL8TimeSeries *	chan,
		SimInspiralTable *	injections,
		CHAR	ifo[3],
		REAL8	freqLowCutoff,
		REAL8	snrLow,
		REAL8	snrHigh,
		CHAR *	fname
	)

Main function for injecting numetrical relativity waveforms.

Takes as input a list of injections, and adds h(t) to a given timeseries for a specified ifo and a dynamic range factor.

Parameters

	status	pointer to LALStatus structure
[out]	chan	the output time series
[in]	injections	list of injections
[in]	ifo	2 char code for interferometer
[in]	freqLowCutoff	Lower cutoff frequency
[in]	snrLow	lower cutoff value of snr
	snrHigh	TO BE DOCUMENTED
[in]	fname	higher cutoff value of snr

Definition at line 534 of file inspiralutils.c.

◆ start_freq_from_frame_url()

REAL8 start_freq_from_frame_url ( CHAR * url )

Definition at line 620 of file inspiralutils.c.

◆ calculate_ligo_snr_from_strain_real8()

REAL8 calculate_ligo_snr_from_strain_real8	(	REAL8TimeSeries *	strain,
		const CHAR	ifo[3]
	)

Definition at line 667 of file inspiralutils.c.

◆ calculate_snr_from_strain_and_psd_real8()

REAL8 calculate_snr_from_strain_and_psd_real8	(	REAL8TimeSeries *	strain,
		REAL8FrequencySeries *	psd,
		REAL8	startFreq,
		const CHAR	ifo[3]
	)

Definition at line 722 of file inspiralutils.c.

◆ calculate_ligo_snr_from_strain()

REAL8 calculate_ligo_snr_from_strain	(	REAL4TimeVectorSeries *	strain,
		SimInspiralTable *	thisInj,
		const CHAR	ifo[3]
	)

Definition at line 798 of file inspiralutils.c.

◆ XLALPsdFromFile()

int XLALPsdFromFile	(	REAL8FrequencySeries **	psd,
		const CHAR *	filename
	)

Parameters

[out]	psd	The PSD
[in]	filename	name of the file to be read

Definition at line 860 of file inspiralutils.c.

◆ XLALInterpolatePSD()

REAL8FrequencySeries * XLALInterpolatePSD	(	REAL8FrequencySeries *	in,
		REAL8	deltaFout
	)

Function for interpolating PSD to a given sample rate.

Parameters

in	input strain time series
deltaFout	sample rate of time series

Definition at line 923 of file inspiralutils.c.

◆ get_FakePsdFromString()

void get_FakePsdFromString	(	REAL8FrequencySeries *	PsdFreqSeries,
		char *	FakePsdName,
		REAL8	StartFreq
	)

Definition at line 983 of file inspiralutils.c.

◆ calculate_lalsim_snr()

REAL8 calculate_lalsim_snr	(	SimInspiralTable *	inj,
		char *	IFOname,
		REAL8FrequencySeries *	psd,
		REAL8	start_freq
	)

Definition at line 1010 of file inspiralutils.c.

Prototypes

Function Documentation

◆ compute_candle_distance()

◆ XLALCandleDistanceTD()

◆ AddNumRelStrainModes()

◆ InjectNumRelWaveformsUsingPSDREAL8()

◆ InjectNumRelWaveforms()

◆ InjectNumRelWaveformsREAL8()

◆ start_freq_from_frame_url()

◆ calculate_ligo_snr_from_strain_real8()

◆ calculate_snr_from_strain_and_psd_real8()

◆ calculate_ligo_snr_from_strain()

◆ XLALPsdFromFile()

◆ XLALInterpolatePSD()

◆ get_FakePsdFromString()

◆ calculate_lalsim_snr()