RecalcToplistStats.h File Reference

Functions to recompute statistics for GCT/hough toplist entries. More...

Prototypes
int	XLALComputeExtraStatsForToplist (toplist_t *list, const RecalcStatsParams *recalcParams)
	XLAL function to go through a (Hough or GCT) toplist and compute line-robust statistics for each candidate. More...
int	XLALComputeExtraStatsSemiCoherent (RecalcStatsComponents *stats, const PulsarDopplerParams *dopplerParams, const RecalcStatsParams *recalcParams)
	XLAL Function to recalculate multi-IFO F-stat 2F and single-IFO 2FX for all semicoherent search segments This returns AVERAGE F-stats over segments, not sums. More...

Detailed Description

Functions to recompute statistics for GCT/hough toplist entries.

Author

David Keitel

Definition in file RecalcToplistStats.h.

Go to the source code of this file.

Data Structures
struct	RecalcStatsComponents
	Type containing multi- and single-detector \( \mathcal{F} \) -statistics and line-robust statistic. More...
struct	RecalcStatsParams
	Type containing input arguments for XLALComputeExtraStatsForToplist() More...

Function Documentation

XLALComputeExtraStatsForToplist()

int XLALComputeExtraStatsForToplist	(	toplist_t *	list,
		const RecalcStatsParams *	recalcParams
	)

XLAL function to go through a (Hough or GCT) toplist and compute line-robust statistics for each candidate.

Parameters

list	list of cancidates with f, sky position etc. - no output so far
recalcParams	additional input values and parameters

Definition at line 43 of file RecalcToplistStats.c.

XLALComputeExtraStatsSemiCoherent()

int XLALComputeExtraStatsSemiCoherent	(	RecalcStatsComponents *	stats,
		const PulsarDopplerParams *	dopplerParams,
		const RecalcStatsParams *	recalcParams
	)

XLAL Function to recalculate multi-IFO F-stat 2F and single-IFO 2FX for all semicoherent search segments This returns AVERAGE F-stats over segments, not sums.

Parameters

[out]	stats	structure containing multi TwoF, single TwoF, BSGL
	dopplerParams	sky position, frequency and fdot for a given candidate
	recalcParams	additional input values and parameters

Definition at line 146 of file RecalcToplistStats.c.