Prototypes
ihsMaximaStruct *	createihsMaxima (const UINT4 fbins, const UINT4 rows)
	Create vectors for IHS maxima struct. More...

void	destroyihsMaxima (ihsMaximaStruct *data)
	Destroy vectors and the IHS maxima struct. More...

INT4	runIHS (ihsMaximaStruct output, const ffdataStruct input, const ihsfarStruct ihsfarinput, const UserInput_t params, const UINT4 rows, const REAL4VectorAligned aveNoise, const REAL4VectorAligned FbinMean)
	Run the IHS algorithm. More...

ihsVals *	createihsVals (void)
	Allocate memory for ihsVals struct. More...

void	destroyihsVals (ihsVals *ihsvals)
	Destroy ihsVals struct. More...

INT4	incHarmSum (ihsVals output, const REAL4VectorAligned input, const UINT4 ihsfactor)
	Compute the IHS sum maximum. More...

INT4	incHarmSumVector (REAL4VectorAligned output, const REAL4VectorAligned input, const UINT4 ihsfactor)
	Compute the IHS vector – does not compute the maximum value. More...

INT4	incHarmSumVectorWeighted (REAL4VectorAligned output, const REAL4VectorAligned input, const REAL4VectorAligned *aveNoise, const UINT4 ihsfactor)
	Compute the noise weighted IHS vector – does not compute the maximum value. More...

ihsfarStruct *	createihsfarStruct (const UINT4 rows, const UserInput_t *params)
	Allocate memory for ihsfarStruct struct. More...

void	destroyihsfarStruct (ihsfarStruct *ihsfarstruct)
	Destroy ihsfarStruct struct. More...

INT4	genIhsFar (ihsfarStruct output, const UserInput_t params, const UINT4 rows, const REAL4VectorAligned aveNoise, const gsl_rng rng)
	Compute the IHS FAR for a sum of a number of rows. More...

INT4	sumIHSarrayFAR (ihsfarStruct outputfar, REAL4VectorAlignedArray ihsvectorarray, const UINT4 rows, const REAL4VectorAligned FbinMean, const UserInput_t params, const gsl_rng *rng)
	Compute the IHS sums for a number of rows used for the FAR calculation. More...

INT4	sumIHSarray (ihsMaximaStruct output, const ihsfarStruct inputfar, REAL4VectorAlignedArray ihsvectorarray, const UINT4 rows, const REAL4VectorAligned FbinMean, const UserInput_t *params)
	Compute the IHS sums for a number of rows. More...

REAL4	ihsFOM (const INT4Vector *locs, const INT4 fomnorm)
	Calculate the IHS FOM for a number of rows. More...

INT4	findIHScandidates (candidateVector *candlist, const ihsfarStruct ihsfarstruct, const UserInput_t params, const ffdataStruct ffdata, const ihsMaximaStruct ihsmaxima, const REAL4VectorAligned fbinavgs, const REAL4VectorSequence *trackedlines)
	Find IHS candidates above thresholds. More...

REAL8	ihs2h0 (const REAL8 ihsval, const UserInput_t *params)
	Convert the IHS statistic to an estimated h0, based on injections. More...

Function Documentation

◆ createihsMaxima()

ihsMaximaStruct * createihsMaxima	(	const UINT4	fbins,
		const UINT4	rows
	)

Create vectors for IHS maxima struct.

Parameters

[in]	fbins	Number of frequency bins
[in]	rows	Number of neighboring rows to be summed

Returns: Pointer to a newly created ihsMaximaStruct

Definition at line 37 of file IHS.c.

◆ destroyihsMaxima()

void destroyihsMaxima ( ihsMaximaStruct * data )

Destroy vectors and the IHS maxima struct.

Parameters

[in] data Pointer to an ihsMaximaStruct to be freed

Definition at line 65 of file IHS.c.

◆ runIHS()

INT4 runIHS	(	ihsMaximaStruct *	output,
		const ffdataStruct *	input,
		const ihsfarStruct *	ihsfarinput,
		const UserInput_t *	params,
		const UINT4	rows,
		const REAL4VectorAligned *	aveNoise,
		const REAL4VectorAligned *	FbinMean
	)

Run the IHS algorithm.

Parameters

[out]	output	Pointer to the ihsMaximaStruct
[in]	input	Pointer to the ffdataStruct
[in]	ihsfarinput	Pointer to the ihsfarStruct
[in]	params	Pointer to UserInput_t
[in]	rows	Number of neighboring rows to be summed
[in]	aveNoise	Pointer to a REAL4VectorAligned of 2nd FFT background powers
[in]	FbinMean	Pointer to a REAL4VectorAligned of normalized SFT background powers

Returns: Status value

Definition at line 89 of file IHS.c.

◆ createihsVals()

ihsVals * createihsVals ( void )

Allocate memory for ihsVals struct.

Returns: Pointer to a newly created ihsVals structure

Definition at line 168 of file IHS.c.

◆ destroyihsVals()

void destroyihsVals ( ihsVals * ihsvals )

Destroy ihsVals struct.

Parameters

[in] ihsvals Pointer to an ihsVals structure to be freed

Definition at line 180 of file IHS.c.

◆ incHarmSum()

INT4 incHarmSum	(	ihsVals *	output,
		const REAL4VectorAligned *	input,
		const UINT4	ihsfactor
	)

Compute the IHS sum maximum.

Parameters

[out]	output	Pointer to the ihsVals structure
[in]	input	Pointer to a REAL4VectorAligned
[in]	ihsfactor	Number of folds of the 2nd FFT

Returns: Status value

Definition at line 195 of file IHS.c.

◆ incHarmSumVector()

INT4 incHarmSumVector	(	REAL4VectorAligned *	output,
		const REAL4VectorAligned *	input,
		const UINT4	ihsfactor
	)

Compute the IHS vector – does not compute the maximum value.

Parameters

[out]	output	Pointer to a REAL4VectorAligned to contain the folded values
[in]	input	Pointer to a REAL4VectorAligned for the input to the IHS
[in]	ihsfactor	Number of folds of the 2nd FFT

Returns: Status value

Definition at line 228 of file IHS.c.

◆ incHarmSumVectorWeighted()

INT4 incHarmSumVectorWeighted	(	REAL4VectorAligned *	output,
		const REAL4VectorAligned *	input,
		const REAL4VectorAligned *	aveNoise,
		const UINT4	ihsfactor
	)

Compute the noise weighted IHS vector – does not compute the maximum value.

Parameters

[out]	output	Pointer to a REAL4VectorAligned to contain the folded values
[in]	input	Pointer to a REAL4VectorAligned for the input to the IHS
[in]	aveNoise	Pointer to a REAL4VectorAligned of 2nd FFT background powers
[in]	ihsfactor	Number of folds of the 2nd FFT

Returns: Status value

Definition at line 259 of file IHS.c.

◆ createihsfarStruct()

ihsfarStruct * createihsfarStruct	(	const UINT4	rows,
		const UserInput_t *	params
	)

Allocate memory for ihsfarStruct struct.

Parameters

[in]	rows	Number of neighbors to sum
[in]	params	Pointer to UserInput_t

Returns: Pointer to a newly allocated ihsfarStruct

Definition at line 289 of file IHS.c.

◆ destroyihsfarStruct()

void destroyihsfarStruct ( ihsfarStruct * ihsfarstruct )

Destroy ihsfarStruct struct.

Parameters

[in] ihsfarstruct Pointer to the ihsfarStruct to be destroyed

Definition at line 316 of file IHS.c.

◆ genIhsFar()

INT4 genIhsFar	(	ihsfarStruct *	output,
		const UserInput_t *	params,
		const UINT4	rows,
		const REAL4VectorAligned *	aveNoise,
		const gsl_rng *	rng
	)

Compute the IHS FAR for a sum of a number of rows.

Parameters

[out]	output	Pointer to the output ihsfarStruct
[in]	params	Pointer to UserInput_t
[in]	rows	Number of neighbors to sum
[in]	aveNoise	Pointer to REAL4VectorAligned of 2nd FFT background powers
[in]	rng	Pointer to GSL random number generator

Returns: Status value

Definition at line 340 of file IHS.c.

◆ sumIHSarrayFAR()

INT4 sumIHSarrayFAR	(	ihsfarStruct *	outputfar,
		REAL4VectorAlignedArray *	ihsvectorarray,
		const UINT4	rows,
		const REAL4VectorAligned *	FbinMean,
		const UserInput_t *	params,
		const gsl_rng *	rng
	)

Compute the IHS sums for a number of rows used for the FAR calculation.

Parameters

[out]	outputfar	Pointer to the output ihsfarStruct
[in]	ihsvectorarray	Pointer to REAL4VectorAlignedArray to be summed
[in]	rows	Number of neighbors to sum
[in]	FbinMean	Pointer to REAL4VectorAligned of normalized SFT background powers
[in]	params	Pointer to UserInput_t
[in]	rng	Pointer to random number generator

Returns: Status value

Definition at line 469 of file IHS.c.

◆ sumIHSarray()

INT4 sumIHSarray	(	ihsMaximaStruct *	output,
		const ihsfarStruct *	inputfar,
		REAL4VectorAlignedArray *	ihsvectorarray,
		const UINT4	rows,
		const REAL4VectorAligned *	FbinMean,
		const UserInput_t *	params
	)

Compute the IHS sums for a number of rows.

In the function we will select the the location which is the maximum above the noise

Parameters

[out]	output	Pointer to the output ihsMaximaStruct
[in]	inputfar	Pointer to ihsfarStruct
[in]	ihsvectorarray	Pointer to REAL4VectorAlignedArray to be summed
[in]	rows	Number of neighbors to sum
[in]	FbinMean	Pointer to REAL4VectorAligned of normalized SFT background powers
[in]	params	Pointer to UserInput_t

Returns: Status value

Definition at line 639 of file IHS.c.

◆ ihsFOM()

REAL4 ihsFOM	(	const INT4Vector *	locs,
		const INT4	fomnorm
	)

Calculate the IHS FOM for a number of rows.

Parameters

[in]	locs	Pointer to INT4Vector of location values
[in]	fomnorm	Normalization value and is the number of XXX

Returns: IHS FOM value

Definition at line 782 of file IHS.c.

◆ findIHScandidates()

INT4 findIHScandidates	(	candidateVector **	candlist,
		const ihsfarStruct *	ihsfarstruct,
		const UserInput_t *	params,
		const ffdataStruct *	ffdata,
		const ihsMaximaStruct *	ihsmaxima,
		const REAL4VectorAligned *	fbinavgs,
		const REAL4VectorSequence *	trackedlines
	)

Find IHS candidates above thresholds.

Parameters

[out]	candlist	Pointer to a pointer containing the candidate list
[in]	ihsfarstruct	Pointer to ihsfarStruct
[in]	params	Pointer to UserInput_t
[in]	ffdata	Pointer to ffdataStruct
[in]	ihsmaxima	Pointer to ihsMaximaStruct containing the data to be tested above thresholds
[in]	fbinavgs	Pointer to REAL4VectorAligned of normalized SFT background powers
[in]	trackedlines	Pointer to REAL4VectorSequence of lines (allowed to be NULL if no lines)

Returns: Status value

Definition at line 809 of file IHS.c.

◆ ihs2h0()

REAL8 ihs2h0	(	const REAL8	ihsval,
		const UserInput_t *	params
	)

Convert the IHS statistic to an estimated h0, based on injections.

Parameters

[in]	ihsval	The IHS statistic value
[in]	params	Pointer to UserInput_t

Returns: Estimated h0

Definition at line 1083 of file IHS.c.

Prototypes

Function Documentation

◆ createihsMaxima()

◆ destroyihsMaxima()

◆ runIHS()

◆ createihsVals()

◆ destroyihsVals()

◆ incHarmSum()

◆ incHarmSumVector()

◆ incHarmSumVectorWeighted()

◆ createihsfarStruct()

◆ destroyihsfarStruct()

◆ genIhsFar()

◆ sumIHSarrayFAR()

◆ sumIHSarray()

◆ ihsFOM()

◆ findIHScandidates()

◆ ihs2h0()