Prototypes
candidateVector *	createcandidateVector (const UINT4 length)
	Allocate a candidateVector. More...

candidateVector *	resizecandidateVector (candidateVector *vector, const UINT4 length)
	Resize a candidateVector. More...

candidateVector *	keepMostSignificantCandidates (const candidateVector input, const UserInput_t params)
	Keep the most significant candidates, potentially reducing the number of candidates if there are more than allowed. More...

void	destroycandidateVector (candidateVector *vector)
	Free a candidateVector. More...

void	loadCandidateData (candidate *output, const REAL8 fsig, const REAL8 period, const REAL8 moddepth, const REAL4 ra, const REAL4 dec, const REAL8 statval, const REAL8 h0, const REAL8 prob, const INT4 proberrcode, const REAL8 normalization, const INT4 templateVectorIndex, const BOOLEAN lineContamination)
	Load candidate data. More...

INT4	analyzeOneTemplate (candidate output, const candidate input, const ffdataStruct ffdata, const REAL4VectorAligned aveNoise, const REAL4VectorAligned aveTFnoisePerFbinRatio, const UserInput_t params, const REAL4FFTPlan plan, const gsl_rng rng, const BOOLEAN exactflag)
	Analyze a single template. More...

INT4	bruteForceTemplateSearch (candidate output, const candidate input, const TwoSpectParamSpaceSearchVals paramspace, const UserInput_t params, const REAL4VectorAligned ffdata, const REAL4VectorAligned aveNoise, const REAL4VectorAligned aveTFnoisePerFbinRatio, const REAL4FFTPlan secondFFTplan, const gsl_rng rng, const BOOLEAN useExactTemplates)
	A brute force template search to find the most significant template around a candidate. More...

INT4	bruteForceTemplateTest (candidateVector *output, const candidate input, const TwoSpectParamSpaceSearchVals paramspace, const UserInput_t params, const REAL4VectorAligned ffdata, const REAL4VectorAligned aveNoise, const REAL4VectorAligned aveTFnoisePerFbinRatio, const REAL4FFTPlan secondFFTplan, const gsl_rng rng, const BOOLEAN useExactTemplates)
	A brute force template search to test templates around a candidate. More...

INT4	templateSearch_scox1Style (candidateVector *output, const REAL8 fminimum, const REAL8 fspan, const REAL8 period, const REAL8 asini, const REAL8 asinisigma, const SkyPosition skypos, const UserInput_t params, const REAL4VectorAligned ffdata, const REAL4VectorAligned aveNoise, const REAL4VectorAligned aveTFnoisePerFbinRatio, const REAL4VectorSequence trackedlines, const REAL4FFTPlan secondFFTplan, const gsl_rng rng, const BOOLEAN useExactTemplates)
	A brute force template search to find the most significant template around a putative source whose parameters are somewhat constrained. More...

INT4	templateSearch_fixedDf (candidateVector *output, const LALStringVector dffixed, const REAL8 fminimum, const REAL8 fspan, const REAL8 period, const SkyPosition skypos, const UserInput_t params, const REAL4VectorAligned ffdata, const REAL4VectorAligned aveNoise, const REAL4VectorAligned aveTFnoisePerFbinRatio, const REAL4VectorSequence trackedlines, const REAL4FFTPlan secondFFTplan, const gsl_rng *rng, const BOOLEAN useExactTemplates)
	A brute force template search to find the most significant template at a fixed modulation depth around a putative source whose parameters are somewhat constrained. More...

INT4	clusterCandidates (candidateVector *output, const candidateVector input, const ffdataStruct ffdata, const UserInput_t params, const REAL4VectorAligned ffplanenoise, const REAL4VectorAligned fbinaveratios, const gsl_rng *rng, const BOOLEAN exactflag)
	Cluster candidates by frequency, period, and modulation depth using templates. More...

INT4	testIHScandidates (candidateVector *output, const candidateVector ihsCandidates, const ffdataStruct ffdata, const REAL4VectorAligned aveNoise, const REAL4VectorAligned aveTFnoisePerFbinRatio, const SkyPosition pos, const UserInput_t params, const gsl_rng *rng)
	Function to test the IHS candidates against Gaussian templates. More...

INT4	testTwoSpectTemplateVector (candidateVector output, const TwoSpectTemplateVector templateVec, const ffdataStruct ffdata, const REAL4VectorAligned aveNoise, const REAL4VectorAligned aveTFnoisePerFbinRatio, const SkyPosition skypos, const UserInput_t params, const gsl_rng *rng, const UINT4 templateLen)
	Test each of the templates in a TwoSpectTemplateVector and keep the top 10 This will not check the false alarm probability of any R value less than 0. More...

INT4	analyzeCandidatesTemplateFromVector (candidateVector output, const candidateVector input, const TwoSpectTemplateVector vector, const ffdataStruct ffdata, const REAL4VectorAligned aveNoise, const REAL4VectorAligned aveTFnoisePerFbinRatio, const UserInput_t params, const gsl_rng rng, const UINT4 templateLen)

INT4	writeCandidateVector2File (const CHAR outputfile, const candidateVector input)

REAL8	maxModDepth (const REAL8 period, const REAL8 cohtime)
	Calculates maximum modulation depth allowed, equation 6 of E. More...

REAL8	minPeriod (const REAL8 moddepth, const REAL8 cohtime)
	Calculates minimum period allowed, equation 6 of E. More...

REAL8	calculateR (const REAL4VectorAligned ffdata, const TwoSpectTemplate template, const REAL4VectorAligned noise, const REAL4VectorAligned fbinaveratios)
	Calculate the R statistic from equation 13 of E. More...

Function Documentation

◆ createcandidateVector()

candidateVector * createcandidateVector ( const UINT4 length )

Allocate a candidateVector.

Parameters

[in] length Length of the candidateVector

Returns: Pointer to the allocated candidateVector

Definition at line 32 of file candidates.c.

◆ resizecandidateVector()

candidateVector * resizecandidateVector	(	candidateVector *	vector,
		const UINT4	length
	)

Resize a candidateVector.

Parameters

[in]	vector	Pointer of vector to resize
[in]	length	New length of candidateVector

Returns: Pointer to resized vector

Definition at line 61 of file candidates.c.

◆ keepMostSignificantCandidates()

candidateVector * keepMostSignificantCandidates	(	const candidateVector *	input,
		const UserInput_t *	params
	)

Keep the most significant candidates, potentially reducing the number of candidates if there are more than allowed.

Parameters

[in]	input	Pointer to input candidateVector
[in]	params	Pointer to UserInput_t

Returns: Pointer to newly allocated candidateVector containing reduced number of candidates

Definition at line 1297 of file candidates.c.

◆ destroycandidateVector()

void destroycandidateVector ( candidateVector * vector )

Free a candidateVector.

Parameters

[in] vector Pointer of candidateVector to be freed

Definition at line 89 of file candidates.c.

◆ loadCandidateData()

void loadCandidateData	(	candidate *	output,
		const REAL8	fsig,
		const REAL8	period,
		const REAL8	moddepth,
		const REAL4	ra,
		const REAL4	dec,
		const REAL8	statval,
		const REAL8	h0,
		const REAL8	prob,
		const INT4	proberrcode,
		const REAL8	normalization,
		const INT4	templateVectorIndex,
		const BOOLEAN	lineContamination
	)

Load candidate data.

Parameters

[out]	output	Pointer to candidate
[in]	fsig	Frequency of candidate
[in]	period	Orbital period of candidate
[in]	moddepth	Modulation depth of candidate
[in]	ra	Right ascension of candidate
[in]	dec	Declination of candidate
[in]	statval	Detection statistic
[in]	h0	Estimated strain amplitude
[in]	prob	False alarm probability
[in]	proberrcode	Davies' method error code
[in]	normalization	Time-frequency normalization
[in]	templateVectorIndex	Index value of the template in a templateVector (can be -1 if not from a vector)
[in]	lineContamination	Boolean flag to indicate 0 = no contamination from lines or 1 = likely contaminated by one or more lines

Definition at line 122 of file candidates.c.

◆ analyzeOneTemplate()

INT4 analyzeOneTemplate	(	candidate *	output,
		const candidate *	input,
		const ffdataStruct *	ffdata,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	aveTFnoisePerFbinRatio,
		const UserInput_t *	params,
		const REAL4FFTPlan *	plan,
		const gsl_rng *	rng,
		const BOOLEAN	exactflag
	)

Analyze a single template.

Parameters

[out]	output	Pointer to candidate structure
[in]	input	Pointer to candidate structure
[in]	ffdata	Pointer to ffdataStruct
[in]	aveNoise	Pointer to REAL4VectorAligned of expected 2nd FFT background powers
[in]	aveTFnoisePerFbinRatio	Pointer to REAL4VectorAligned of normalized power across the frequency band
[in]	params	Pointer to UserInput_t
[in]	plan	Pointer to REAL4FFTPlan
[in]	rng	Pointer to gsl_rng
[in]	exactflag	Boolean value to indicate using exact templates

Returns: Status value

Definition at line 153 of file candidates.c.

◆ bruteForceTemplateSearch()

INT4 bruteForceTemplateSearch	(	candidate *	output,
		const candidate	input,
		const TwoSpectParamSpaceSearchVals *	paramspace,
		const UserInput_t *	params,
		const REAL4VectorAligned *	ffdata,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	aveTFnoisePerFbinRatio,
		const REAL4FFTPlan *	secondFFTplan,
		const gsl_rng *	rng,
		const BOOLEAN	useExactTemplates
	)

A brute force template search to find the most significant template around a candidate.

Parameters

[out]	output	Pointer to candidate structure
[in]	input	Input candidate structure
[in]	paramspace	Pointer to TwoSpectParamSpaceSearchVals containing the parameter space to be searched
[in]	params	Pointer to UserInput_t
[in]	ffdata	Pointer to ffdataStruct
[in]	aveNoise	Pointer to REAL4VectorAligned of 2nd FFT background powers
[in]	aveTFnoisePerFbinRatio	Pointer to REAL4VectorAligned of normalized power across the frequency band
[in]	secondFFTplan	Pointer to REAL4FFTPlan
[in]	rng	Pointer to gsl_rng
[in]	useExactTemplates	Boolean of 0 (use Gaussian templates) or 1 (use exact templates)

Returns: Status value

Definition at line 254 of file candidates.c.

◆ bruteForceTemplateTest()

INT4 bruteForceTemplateTest	(	candidateVector **	output,
		const candidate	input,
		const TwoSpectParamSpaceSearchVals *	paramspace,
		const UserInput_t *	params,
		const REAL4VectorAligned *	ffdata,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	aveTFnoisePerFbinRatio,
		const REAL4FFTPlan *	secondFFTplan,
		const gsl_rng *	rng,
		const BOOLEAN	useExactTemplates
	)

A brute force template search to test templates around a candidate.

Parameters

[out]	output	Pointer to a pointer of a candidateVector
[in]	input	Input candidate structure
[in]	paramspace	Pointer to TwoSpectParamSpaceSearchVals containing the parameter space to be searched
[in]	params	Pointer to UserInput_t
[in]	ffdata	Pointer to ffdataStruct
[in]	aveNoise	Pointer to REAL4VectorAligned of 2nd FFT background powers
[in]	aveTFnoisePerFbinRatio	Pointer to REAL4VectorAligned of normalized power across the frequency band
[in]	secondFFTplan	Pointer to REAL4FFTPlan
[in]	rng	Pointer to gsl_rng
[in]	useExactTemplates	Boolean of 0 (use Gaussian templates) or 1 (use exact templates)

Returns: Status value

Definition at line 429 of file candidates.c.

◆ templateSearch_scox1Style()

INT4 templateSearch_scox1Style	(	candidateVector **	output,
		const REAL8	fminimum,
		const REAL8	fspan,
		const REAL8	period,
		const REAL8	asini,
		const REAL8	asinisigma,
		const SkyPosition	skypos,
		const UserInput_t *	params,
		const REAL4VectorAligned *	ffdata,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	aveTFnoisePerFbinRatio,
		const REAL4VectorSequence *	trackedlines,
		const REAL4FFTPlan *	secondFFTplan,
		const gsl_rng *	rng,
		BOOLEAN	useExactTemplates
	)

A brute force template search to find the most significant template around a putative source whose parameters are somewhat constrained.

Parameters

[out]	output	Pointer to a pointer of a candidateVector
[in]	fminimum	Lower frequency bound to search (inclusive)
[in]	fspan	Span of the frequency band (inclusive of endpoint)
[in]	period	Specific orbital period (measured in seconds)
[in]	asini	Specific projected semi-major axis (measured in light seconds)
[in]	asinisigma	Uncertainty on the specific asini value (measured in light seconds)
[in]	skypos	SkyPosition struct of the sky position (in RA and DEC) being searched
[in]	params	Pointer to UserInput_t
[in]	ffdata	Pointer to ffdataStruct
[in]	aveNoise	Pointer to REAL4VectorAligned of 2nd FFT background powers
[in]	aveTFnoisePerFbinRatio	Pointer to REAL4VectorAligned of normalized power across the frequency band
[in]	trackedlines	Pointer to REAL4VectorSequence of lines (allowed to be NULL if no lines)
[in]	secondFFTplan	Pointer to REAL4FFTPlan
[in]	rng	Pointer to gsl_rng
[in]	useExactTemplates	Boolean of 0 (use Gaussian templates) or 1 (use exact templates)

Returns: Status value

Definition at line 575 of file candidates.c.

◆ templateSearch_fixedDf()

INT4 templateSearch_fixedDf	(	candidateVector **	output,
		const LALStringVector *	dffixed,
		const REAL8	fminimum,
		const REAL8	fspan,
		const REAL8	period,
		const SkyPosition	skypos,
		const UserInput_t *	params,
		const REAL4VectorAligned *	ffdata,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	aveTFnoisePerFbinRatio,
		const REAL4VectorSequence *	trackedlines,
		const REAL4FFTPlan *	secondFFTplan,
		const gsl_rng *	rng,
		BOOLEAN	useExactTemplates
	)

A brute force template search to find the most significant template at a fixed modulation depth around a putative source whose parameters are somewhat constrained.

Parameters

[out]	output	Pointer to a pointer of a candidateVector
[in]	dffixed	Modulation depth (fixed by user)
[in]	fminimum	Lower frequency bound to search (inclusive)
[in]	fspan	Span of the frequency band (inclusive of endpoint)
[in]	period	Specific orbital period (measured in seconds)
[in]	skypos	SkyPosition struct of the sky position (in RA and DEC) being searched
[in]	params	Pointer to UserInput_t
[in]	ffdata	Pointer to ffdataStruct
[in]	aveNoise	Pointer to REAL4VectorAligned of 2nd FFT background powers
[in]	aveTFnoisePerFbinRatio	Pointer to REAL4VectorAligned of normalized power across the frequency band
[in]	trackedlines	Pointer to REAL4VectorSequence of lines (allowed to be NULL if no lines)
[in]	secondFFTplan	Pointer to REAL4FFTPlan
[in]	rng	Pointer to gsl_rng
[in]	useExactTemplates	Boolean of 0 (use Gaussian templates) or 1 (use exact templates)

Returns: Status value

Definition at line 724 of file candidates.c.

◆ clusterCandidates()

INT4 clusterCandidates	(	candidateVector **	output,
		const candidateVector *	input,
		const ffdataStruct *	ffdata,
		const UserInput_t *	params,
		const REAL4VectorAligned *	ffplanenoise,
		const REAL4VectorAligned *	fbinaveratios,
		const gsl_rng *	rng,
		const BOOLEAN	exactflag
	)

Cluster candidates by frequency, period, and modulation depth using templates.

Parameters

[out]	output	Pointer to pointer of a candidateVector
[in]	input	Pointer to a candidateVector
[in]	ffdata	Pointer to ffdataStruct
[in]	params	Pointer to UserInput_t
[in]	ffplanenoise	Pointer to REAL4VectorAligned of 2nd FFT background powers
[in]	fbinaveratios	Pointer to REAL4VectorAligned of normalized SFT background
[in]	rng	Pointer to gsl_rng
[in]	exactflag	Flag to use Gaussian templates (0) or exact templates (1)

Returns: Status value

Definition at line 837 of file candidates.c.

◆ testIHScandidates()

INT4 testIHScandidates	(	candidateVector **	output,
		const candidateVector *	ihsCandidates,
		const ffdataStruct *	ffdata,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	aveTFnoisePerFbinRatio,
		const SkyPosition	pos,
		const UserInput_t *	params,
		const gsl_rng *	rng
	)

Function to test the IHS candidates against Gaussian templates.

Parameters

[out]	output	Pointer to pointer of a candidateVector
[in]	ihsCandidates	Pointer to candidateVector of IHS candidates
[in]	ffdata	Pointer to ffdataStruct
[in]	aveNoise	Pointer to REAL4VectorAligned of 2nd FFT background powers
[in]	aveTFnoisePerFbinRatio	Pointer to REAL4VectorAligned of normalized SFT background spectra
[in]	pos	The current sky position
[in]	params	Pointer to UserInput_t
[in]	rng	Pointer to gsl_rng

Returns: Status value

Definition at line 1062 of file candidates.c.

◆ testTwoSpectTemplateVector()

INT4 testTwoSpectTemplateVector	(	candidateVector *	output,
		const TwoSpectTemplateVector *	templateVec,
		const ffdataStruct *	ffdata,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	aveTFnoisePerFbinRatio,
		const SkyPosition	skypos,
		const UserInput_t *	params,
		const gsl_rng *	rng,
		const UINT4	templateLen
	)

Test each of the templates in a TwoSpectTemplateVector and keep the top 10 This will not check the false alarm probability of any R value less than 0.

Parameters

[out]	output	Pointer to pointer of a candidateVector storing a list of all candidates
[in]	templateVec	Pointer to a TwoSpectTemplateVector containing all the templates to be searched
[in]	ffdata	Pointer to ffdataStruct
[in]	aveNoise	Pointer to REAL4VectorAligned of 2nd FFT background powers
[in]	aveTFnoisePerFbinRatio	Pointer to REAL4VectorAligned of normalized SFT background spectra
[in]	skypos	The current sky position
[in]	params	Pointer to UserInput_t
[in]	rng	Pointer to gsl_rng
[in]	templateLen	Maximum length of a template

Returns: Status value

Definition at line 1222 of file candidates.c.

◆ analyzeCandidatesTemplateFromVector()

INT4 analyzeCandidatesTemplateFromVector	(	candidateVector *	output,
		const candidateVector *	input,
		const TwoSpectTemplateVector *	vector,
		const ffdataStruct *	ffdata,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	aveTFnoisePerFbinRatio,
		const UserInput_t *	params,
		const gsl_rng *	rng,
		const UINT4	templateLen
	)

Definition at line 191 of file candidates.c.

◆ writeCandidateVector2File()

INT4 writeCandidateVector2File	(	const CHAR *	outputfile,
		const candidateVector *	input
	)

Definition at line 1385 of file candidates.c.

◆ maxModDepth()

REAL8 maxModDepth	(	const REAL8	period,
		const REAL8	cohtime
	)

Calculates maximum modulation depth allowed, equation 6 of E.

Goetz and K. Riles (2011)

Parameters

[in]	period	Orbital period value
[in]	cohtime	SFT coherence length

Returns: Maximum modulation depth allowed

Definition at line 1414 of file candidates.c.

◆ minPeriod()

REAL8 minPeriod	(	const REAL8	moddepth,
		const REAL8	cohtime
	)

Calculates minimum period allowed, equation 6 of E.

Goetz and K. Riles (2011)

Parameters

[in]	moddepth	Modulation depth value
[in]	cohtime	SFT coherence length

Returns: Maximum modulation depth allowed

Definition at line 1427 of file candidates.c.

◆ calculateR()

REAL8 calculateR	(	const REAL4VectorAligned *	ffdata,
		const TwoSpectTemplate *	template,
		const REAL4VectorAligned *	noise,
		const REAL4VectorAligned *	fbinaveratios
	)

Calculate the R statistic from equation 13 of E.

Goetz and K. Riles (2011)

Parameters

[in]	ffdata	Pointer to REAL4VectorAligned of the 2nd FFT data
[in]	template	Pointer to the template
[in]	noise	Pointer to the REAL4VectorAligned containing the background 2nd FFT powers
[in]	fbinaveratios	Pointer to the REAL4VectorAligned of normalized SFT background powers

Returns: Value of the R statistic

Definition at line 1358 of file candidates.c.

Prototypes

Function Documentation

◆ createcandidateVector()

◆ resizecandidateVector()

◆ keepMostSignificantCandidates()

◆ destroycandidateVector()

◆ loadCandidateData()

◆ analyzeOneTemplate()

◆ bruteForceTemplateSearch()

◆ bruteForceTemplateTest()

◆ templateSearch_scox1Style()

◆ templateSearch_fixedDf()

◆ clusterCandidates()

◆ testIHScandidates()

◆ testTwoSpectTemplateVector()

◆ analyzeCandidatesTemplateFromVector()

◆ writeCandidateVector2File()

◆ maxModDepth()

◆ minPeriod()

◆ calculateR()