Go to the source code of this file.
ihsMaximaStruct * createihsMaxima | ( | const UINT4 | fbins, |
const UINT4 | rows | ||
) |
Create vectors for IHS maxima struct.
[in] | fbins | Number of frequency bins |
[in] | rows | Number of neighboring rows to be summed |
void destroyihsMaxima | ( | ihsMaximaStruct * | data | ) |
Destroy vectors and the IHS maxima struct.
[in] | data | Pointer to an ihsMaximaStruct to be freed |
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.
[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 |
ihsVals * createihsVals | ( | void | ) |
void destroyihsVals | ( | ihsVals * | ihsvals | ) |
Compute the IHS sum maximum.
[out] | output | Pointer to the ihsVals structure |
[in] | input | Pointer to a REAL4VectorAligned |
[in] | ihsfactor | Number of folds of the 2nd FFT |
INT4 incHarmSumVector | ( | REAL4VectorAligned * | output, |
const REAL4VectorAligned * | input, | ||
const UINT4 | ihsfactor | ||
) |
Compute the IHS vector – does not compute the maximum value.
[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 |
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.
[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 |
ihsfarStruct * createihsfarStruct | ( | const UINT4 | rows, |
const UserInput_t * | params | ||
) |
Allocate memory for ihsfarStruct struct.
[in] | rows | Number of neighbors to sum |
[in] | params | Pointer to UserInput_t |
void destroyihsfarStruct | ( | ihsfarStruct * | ihsfarstruct | ) |
Destroy ihsfarStruct struct.
[in] | ihsfarstruct | Pointer to the ihsfarStruct to be destroyed |
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.
[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 |
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.
[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 |
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
[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 |
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.
[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) |
REAL4 ihsFOM | ( | const INT4Vector * | locs, |
const INT4 | fomnorm | ||
) |
Calculate the IHS FOM for a number of rows.
[in] | locs | Pointer to INT4Vector of location values |
[in] | fomnorm | Normalization value and is the number of XXX |
REAL8 ihs2h0 | ( | const REAL8 | ihsval, |
const UserInput_t * | params | ||
) |
Convert the IHS statistic to an estimated h0, based on injections.
[in] | ihsval | The IHS statistic value |
[in] | params | Pointer to UserInput_t |