Prototypes
ffdataStruct *	createffdata (const UserInput_t *params)
	Create a new frequency-frequency data structure for the TwoSpect analysis. More...

void	destroyffdata (ffdataStruct *data)
	Free the frequency-frequency data structure. More...

INT4Vector *	detectLines_simple (const REAL4VectorAligned TFdata, const ffdataStruct ffdata, const UserInput_t *params)
	Line detection algorithm. More...

REAL4VectorSequence *	trackLines (const INT4Vector lines, const INT4Vector binshifts, const REAL4 minfbin, const REAL4 df)
	Track the lines for the sky position. More...

INT4	cleanLines (REAL4VectorAligned TFdata, const REAL4VectorAligned background, const INT4Vector lines, const UserInput_t params, const gsl_rng *rng)
	Test algorithm to clean lines. More...

INT4	makeSecondFFT (ffdataStruct ffdata, REAL4VectorAligned tfdata, const REAL4FFTPlan *plan)
	Compute the second Fourier transform for TwoSpect. More...

INT4	ffPlaneNoise (REAL4VectorAligned aveNoise, const UserInput_t params, const INT4Vector sftexist, const REAL4VectorAligned aveNoiseInTime, const REAL4VectorAligned antweights, const REAL4VectorAligned backgroundScaling, const REAL4FFTPlan plan, const REAL4VectorAligned expDistVals, const gsl_rng rng, REAL8 normalization)
	Measure of the average noise power in each 2nd FFT frequency bin. More...

REAL4	avgTFdataBand (const REAL4VectorAligned *backgrnd, UINT4 numfbins, UINT4 numffts, UINT4 binmin, UINT4 binmax)
	Determine the average of the noise power in each frequency bin across the band. More...

REAL4	rmsTFdataBand (const REAL4VectorAligned *backgrnd, UINT4 numfbins, UINT4 numffts, UINT4 binmin, UINT4 binmax)
	Determine the rms of the noise power in each frequency bin across the band. More...

REAL4VectorAligned *	calcAveTFnoisePerFbinRatio (const REAL4VectorAligned background, const REAL4VectorAligned backgroundScaling, const UINT4 numffts)
	Calculate the ratio of the average SFT noise to the mean of the average SFT noise. More...

INT4	medianBackgroundBandInTime (REAL4VectorAligned aveNoiseInTime, const REAL4VectorAligned backgrnd, const INT4Vector *sftexist)

MultiLALDetector *	setupMultiLALDetector (LALStringVector *IFO)

INT4	readTwoSpectInputParams (UserInput_t uvar, int argc, char argv[])

INT4	printREAL4Vector2File (const REAL4Vector vector, const CHAR directory, const CHAR *filename)
	Print REAL4Vector values to an ASCII file. More...

Function Documentation

◆ createffdata()

ffdataStruct * createffdata ( const UserInput_t * params )

Create a new frequency-frequency data structure for the TwoSpect analysis.

Parameters

[in] params Pointer to the UserInput_t

Returns: Pointer to new ffdataStruct

Definition at line 1185 of file TwoSpect.c.

◆ destroyffdata()

void destroyffdata ( ffdataStruct * data )

Free the frequency-frequency data structure.

Parameters

[in] data Pointer to the ffdataStruct

Definition at line 1209 of file TwoSpect.c.

◆ detectLines_simple()

INT4Vector * detectLines_simple	(	const REAL4VectorAligned *	TFdata,
		const ffdataStruct *	ffdata,
		const UserInput_t *	params
	)

Line detection algorithm.

Calculate RMS for each fbin as function of time
Calculate running median of RMS values
Divide RMS values by running median. Lines stick out by being >>1
Add up number of lines above threshold and report

Parameters

[in]	TFdata	Pointer to REAL4VectorAligned of SFT powers
[in]	ffdata	Pointer to ffdataStruct
[in]	params	Pointer to UserInput_t

Returns: Pointer to INT4Vector of bin number of the lines

Definition at line 1231 of file TwoSpect.c.

◆ trackLines()

REAL4VectorSequence * trackLines	(	const INT4Vector *	lines,
		const INT4Vector *	binshifts,
		const REAL4	minfbin,
		const REAL4	df
	)

Track the lines for the sky position.

Parameters

[in]	lines	Pointer to INT4Vector with list of lines
[in]	binshifts	Pointer to INT4Vector of SFT bin shifts
[in]	minfbin	Frequency value of the lowest frequency bin
[in]	df	Spacing of frequency bins (typically 1/Tsft)

Returns: Pointer to REAL4VectorSequence containing lower/mid/upper frequency for each line

Definition at line 1318 of file TwoSpect.c.

◆ cleanLines()

INT4 cleanLines	(	REAL4VectorAligned *	TFdata,
		const REAL4VectorAligned *	background,
		const INT4Vector *	lines,
		const UserInput_t *	params,
		const gsl_rng *	rng
	)

Test algorithm to clean lines.

NOT FULLY TESTED!

Parameters

[in,out]	TFdata	Pointer to time-frequency data in a REAL4Vector to be cleaned
[in]	background	Pointer to REAL4Vector of running mean data
[in]	lines	Pointer to INT4Vector of lines
[in]	params	Pointer to UserInput_t
[in]	rng	Pointer to gsl_rng

Returns: Status value

Definition at line 1359 of file TwoSpect.c.

◆ makeSecondFFT()

INT4 makeSecondFFT	(	ffdataStruct *	output,
		REAL4VectorAligned *	tfdata,
		const REAL4FFTPlan *	plan
	)

Compute the second Fourier transform for TwoSpect.

Parameters

[out]	output	Pointer to the ffdataStruct to the containers for the second FFT
[in]	tfdata	Pointer REAL4VectorAligned of mean subtracted and weighted data
[in]	plan	Pointer to REAL4FFTPlan

Returns: Status value

Definition at line 1435 of file TwoSpect.c.

◆ ffPlaneNoise()

INT4 ffPlaneNoise	(	REAL4VectorAligned *	aveNoise,
		const UserInput_t *	params,
		const INT4Vector *	sftexist,
		const REAL4VectorAligned *	aveNoiseInTime,
		const REAL4VectorAligned *	antweights,
		const REAL4VectorAligned *	backgroundScaling,
		const REAL4FFTPlan *	plan,
		const REAL4VectorAligned *	expDistVals,
		const gsl_rng *	rng,
		REAL8 *	normalization
	)

Measure of the average noise power in each 2nd FFT frequency bin.

Parameters

[out]	aveNoise	Pointer to REAL4VectorAligned of the expected 2nd FFT powers
[in]	params	Pointer to UserInput_t
[in]	sftexist	Pointer to INT4Vector of SFTs existing or not
[in]	aveNoiseInTime	Pointer to REAL4VectorAligned of running means
[in]	antweights	Pointer to REAL4VectorAligned of antenna pattern weights
[in]	backgroundScaling	Pointer to REAL4VectorAligned of background scaling values
[in]	plan	Pointer to REAL4FFTPlan
[in]	expDistVals	Pointer to REAL4VectorAligned of precomputed exponentially distributed random values to sample from
[in]	rng	Pointer to gsl_rng
[in,out]	normalization	Pointer to REAL8 value of the normalization for the 2nd FFT

Returns: Status value

Definition at line 1596 of file TwoSpect.c.

◆ avgTFdataBand()

REAL4 avgTFdataBand	(	const REAL4VectorAligned *	backgrnd,
		UINT4	numfbins,
		UINT4	numffts,
		UINT4	binmin,
		UINT4	binmax
	)

Determine the average of the noise power in each frequency bin across the band.

Parameters

[in]	backgrnd	Pointer to REAL4VectorAligned of the running mean values
[in]	numfbins	Number of frequency bins in the SFTs
[in]	numffts	Number of SFTs in the observation time
[in]	binmin	Minimum SFT bin to look at with this algorithm
[in]	binmax	Maximum SFT bin to look at with this algorithm

Returns: The average of the noise power across the frequency band

Definition at line 1507 of file TwoSpect.c.

◆ rmsTFdataBand()

REAL4 rmsTFdataBand	(	const REAL4VectorAligned *	backgrnd,
		UINT4	numfbins,
		UINT4	numffts,
		UINT4	binmin,
		UINT4	binmax
	)

Determine the rms of the noise power in each frequency bin across the band.

Parameters

[in]	backgrnd	Pointer to REAL4Vector of the running mean values
[in]	numfbins	Number of frequency bins in the SFTs
[in]	numffts	Number of SFTs in the observation time
[in]	binmin	Minimum SFT bin to look at with this algorithm
[in]	binmax	Maximum SFT bin to look at with this algorithm

Returns: The RMS of the noise power across the frequency band

Definition at line 1541 of file TwoSpect.c.

◆ calcAveTFnoisePerFbinRatio()

REAL4VectorAligned * calcAveTFnoisePerFbinRatio	(	const REAL4VectorAligned *	background,
		const REAL4VectorAligned *	backgroundScaling,
		const UINT4	numffts
	)

Calculate the ratio of the average SFT noise to the mean of the average SFT noise.

Parameters

[in]	background	Pointer to REAL4VectorAligned of the running means
[in]	backgroundScaling	Pointer to REAL4VectorAligned of background scaling values
[in]	numffts	Number of SFTs in the total observation time

Returns: Pointer to REAL4VectorAligned of the ratio of values to the band mean

Definition at line 1398 of file TwoSpect.c.

◆ medianBackgroundBandInTime()

INT4 medianBackgroundBandInTime	(	REAL4VectorAligned *	aveNoiseInTime,
		const REAL4VectorAligned *	backgrnd,
		const INT4Vector *	sftexist
	)

Definition at line 1566 of file TwoSpect.c.

◆ setupMultiLALDetector()

MultiLALDetector * setupMultiLALDetector ( LALStringVector * IFO )

Parameters

[in] IFO Pointer to LALStringVector of the IFO names like H1/L1/V1/etc.

Returns: Pointer to MultiLALDetector

Definition at line 1761 of file TwoSpect.c.

◆ readTwoSpectInputParams()

INT4 readTwoSpectInputParams	(	UserInput_t *	uvar,
		int	argc,
		char *	argv[]
	)

Definition at line 1803 of file TwoSpect.c.

◆ printREAL4Vector2File()

INT4 printREAL4Vector2File	(	const REAL4Vector *	vector,
		const CHAR *	directory,
		const CHAR *	filename
	)

Print REAL4Vector values to an ASCII file.

Parameters

[in]	vector	Pointer to the REAL4Vector to be printed
[in]	directory	CHAR array of the file path
[in]	filename	CHAR array of the file name

Returns: Status value

Definition at line 2087 of file TwoSpect.c.

Prototypes

Function Documentation

◆ createffdata()

◆ destroyffdata()

◆ detectLines_simple()

◆ trackLines()

◆ cleanLines()

◆ makeSecondFFT()

◆ ffPlaneNoise()

◆ avgTFdataBand()

◆ rmsTFdataBand()

◆ calcAveTFnoisePerFbinRatio()

◆ medianBackgroundBandInTime()

◆ setupMultiLALDetector()

◆ readTwoSpectInputParams()

◆ printREAL4Vector2File()