LALPulsar  6.1.0.1-89842e6
LALHough.h File Reference

Prototypes

void LALHOUGHConstructSpacePHMD (LALStatus *status, PHMDVectorSequence *phmdVS, HOUGHPeakGramVector *pgV, HOUGHptfLUTVector *lutV)
 constructs the space of phmd PHMDVectorSequence *phmdVS, given a HOUGHPeakGramVector *pgV and HOUGHptfLUTVector *lutV. More...
 
void LALHOUGHupdateSpacePHMDup (LALStatus *status, PHMDVectorSequence *phmdVS, HOUGHPeakGramVector *pgV, HOUGHptfLUTVector *lutV)
 This function updates the space of phmd increasing the frequency phmdVS->fBinMin by one. More...
 
void LALHOUGHupdateSpacePHMDdn (LALStatus *status, PHMDVectorSequence *phmdVS, HOUGHPeakGramVector *pgV, HOUGHptfLUTVector *lutV)
 Function for shifting the cylindrical buffer of PHMDs down by one frequency bin – the highest frequency bin is dropped and an extra frequency bin is added at the lowest frequency. More...
 
void LALHOUGHConstructHMT (LALStatus *status, HOUGHMapTotal *ht, UINT8FrequencyIndexVector *freqInd, PHMDVectorSequence *phmdVS)
 Given PHMDVectorSequence *phmdVS, the space of phmd, and UINT8FrequencyIndexVector *freqInd, a structure containing the frequency indices of the phmd at different time stamps that have to be combined to form a Hough map, the function LALHOUGHConstructHMT() produces the total Hough map. More...
 
void LALHOUGHComputeFBinMap (LALStatus *status, UINT8 *fBinMap, UINT8 *f0Bin, HOUGHResidualSpinPar *rs)
 This function computes the corresponding frequency bin of a phmd UINT8 *fBinMap for a given intrinsic frequency bin of a source UINT8 *f0Bin, and information regarding the time and the residual spin down parameters HOUGHResidualSpinPar *rs. More...
 
void LALHOUGHConstructHMT_W (LALStatus *status, HOUGHMapTotal *ht, UINT8FrequencyIndexVector *freqInd, PHMDVectorSequence *phmdVS)
 Calculates the total hough map for a given trajectory in the time-frequency plane and a set of partial hough map derivatives allowing each PHMD to have a different weight factor to account for varying sensitivity at different sky-locations. More...
 
void LALHOUGHWeighSpacePHMD (LALStatus *status, PHMDVectorSequence *phmdVS, REAL8Vector *weightV)
 Adds weight factors for set of partial hough map derivatives – the weights must be calculated outside this function. More...
 
void LALHOUGHInitializeWeights (LALStatus *status, REAL8Vector *weightV)
 Initializes weight factors to unity. More...
 
void LALHOUGHNormalizeWeights (LALStatus *status, REAL8Vector *weightV)
 Normalizes weight factors so that their sum is N. More...
 
void LALHOUGHComputeAMWeights (LALStatus *status, REAL8Vector *weightV, LIGOTimeGPSVector *timeV, LALDetector *detector, EphemerisData *edat, REAL8 alpha, REAL8 delta)
 Computes weight factors arising from amplitude modulation – it multiplies an existing weight vector. More...
 
void LALHOUGHComputeMultiIFOAMWeights (LALStatus *status, REAL8Vector *weightV, SFTCatalog *catalog, EphemerisData *edat, REAL8 alpha, REAL8 delta)
 

Go to the source code of this file.

Data Structures

struct  UINT8FrequencyIndexVector
 This structure stores the frequency indexes of the partial-Hough map derivatives at different time stamps that have to be combined to form a Hough map for a given (null or) residual spin-down parameters. More...
 
struct  UINT8FrequencyIndexVectorSequence
 This structure stores a set of frequency-index vectors. More...
 
struct  HOUGHPeakGramVector
 This structure contains a vector of peak-grams (for the different time stamps) More...
 
struct  HOUGHptfLUTVector
 This structure contains a vector of partial look up tables (for the different time stamps) More...
 
struct  HOUGHMapTotalVector
 This structure contains a vector of Hough maps. More...
 
struct  PHMDVectorSequence
 This structure contains a vector sequence of partial-Hough maps derivatives (for different time stamps and different frequencies) representing a circular buffer for the frequency indexes. More...
 
struct  HOUGHResidualSpinPar
 This structure stores the residual spin-down parameters at a given time. More...
 

Macros

Error Codes
#define LALHOUGHH_ENULL   1
 
#define LALHOUGHH_ESIZE   2
 
#define LALHOUGHH_ESZMM   4
 
#define LALHOUGHH_EINT   6
 
#define LALHOUGHH_ESAME   8
 
#define LALHOUGHH_EFREQ   10
 
#define LALHOUGHH_EVAL   12
 
#define LALHOUGHH_EMEM   32
 
#define LALHOUGHH_MSGENULL   "Null pointer"
 
#define LALHOUGHH_MSGESIZE   "Invalid input size"
 
#define LALHOUGHH_MSGESZMM   "Size mismatch"
 
#define LALHOUGHH_MSGEINT   "Invalid interval"
 
#define LALHOUGHH_MSGESAME   "Input/Output pointers are the same"
 
#define LALHOUGHH_MSGEFREQ   "Invalid frequency"
 
#define LALHOUGHH_MSGEVAL   "Invalid value"
 
#define LALHOUGHH_MSGEMEM   "malloc() failed / Out of memory"