bin/Weave/statistics.h File Reference

Module which defines statistics that can be computed and their parameters. More...

Prototypes
int	XLALWeaveStatisticsSetDirectDependencies (WeaveStatisticType *deps, const WeaveStatisticType stats)
	Set all bits in 'deps' corresponding to direct dependencies of the set of input statistics 'stat'. More...
int	XLALWeaveStatisticsParamsSetDependencyMap (WeaveStatisticsParams *statistics_params, const WeaveStatisticType toplist_stats, const WeaveStatisticType extra_output_stats, const WeaveStatisticType recalc_stats)
	Fill StatisticsParams logic for given toplist and extra-output stats. More...
void	XLALWeaveStatisticsParamsDestroy (WeaveStatisticsParams *statistics_params)
	Destroy a StatisticsParams struct. More...

Detailed Description

Module which defines statistics that can be computed and their parameters.

Definition in file bin/Weave/statistics.h.

Go to the source code of this file.

Data Structures
struct	WeaveStatisticsParams
	Struct holding all parameters and status values for computing various statistics. More...
struct	WeaveStatisticsValues

Macros
#define	WEAVE_STATISTIC_NAME(ws)   WeaveStatisticNamesByIndex[XLAL_BIT2IDX(ws)]
	Names of all possible statistics. More...

Enumerations
enum	tagWeaveStatisticType {   WEAVE_STATISTIC_NONE = 0 , WEAVE_STATISTIC_COH2F = XLAL_IDX2BIT( 0 ) , WEAVE_STATISTIC_COH2F_DET = XLAL_IDX2BIT( 1 ) , WEAVE_STATISTIC_MAX2F = XLAL_IDX2BIT( 2 ) ,   WEAVE_STATISTIC_MAX2F_DET = XLAL_IDX2BIT( 3 ) , WEAVE_STATISTIC_SUM2F = XLAL_IDX2BIT( 4 ) , WEAVE_STATISTIC_SUM2F_DET = XLAL_IDX2BIT( 5 ) , WEAVE_STATISTIC_MEAN2F = XLAL_IDX2BIT( 6 ) ,   WEAVE_STATISTIC_MEAN2F_DET = XLAL_IDX2BIT( 7 ) , WEAVE_STATISTIC_BSGL = XLAL_IDX2BIT( 8 ) , WEAVE_STATISTIC_BSGLtL = XLAL_IDX2BIT( 9 ) , WEAVE_STATISTIC_BtSGLtL = XLAL_IDX2BIT( 10 ) ,   WEAVE_STATISTIC_NCOUNT = XLAL_IDX2BIT( 11 ) , WEAVE_STATISTIC_NCOUNT_DET = XLAL_IDX2BIT( 12 ) , WEAVE_STATISTIC_MAX = XLAL_IDX2BIT( 13 ) }
	Bitflags representing all possible statistics that can be computed or returned by Weave. More...

Variables
const UserChoices	WeaveToplistChoices
	User input choices for toplist ranking statistics. More...
const char *const	WeaveToplistHelpString
	User input help string for toplist ranking statistics. More...
const UserChoices	WeaveStatisticChoices
	User input choices for all supported statistics. More...
const char *const	WeaveStatisticHelpString
	User input help string for all supported statistics. More...

Macro Definition Documentation

WEAVE_STATISTIC_NAME

#define WEAVE_STATISTIC_NAME

(

ws

)

WeaveStatisticNamesByIndex[XLAL_BIT2IDX(ws)]

Names of all possible statistics.

Definition at line 77 of file bin/Weave/statistics.h.

Enumeration Type Documentation

tagWeaveStatisticType

enum tagWeaveStatisticType

Bitflags representing all possible statistics that can be computed or returned by Weave.

Enumerator
WEAVE_STATISTIC_NONE
WEAVE_STATISTIC_COH2F	Per segment multi-detector F-statistic.
WEAVE_STATISTIC_COH2F_DET	Per segment per-detector F-statistic.
WEAVE_STATISTIC_MAX2F
WEAVE_STATISTIC_MAX2F_DET
WEAVE_STATISTIC_SUM2F	Multi-detector sum (over segments) F-statistic.
WEAVE_STATISTIC_SUM2F_DET	Per detector sum F-statistic.
WEAVE_STATISTIC_MEAN2F	Multi-detector average (over segments) F-statistic.
WEAVE_STATISTIC_MEAN2F_DET	Per detector average F-statistic.
WEAVE_STATISTIC_BSGL	Line-robust log10(B_S/GL) statistic.
WEAVE_STATISTIC_BSGLtL	(transient-)line robust log10(B_S/GLtL) statistic
WEAVE_STATISTIC_BtSGLtL	(transient-)line robust log10(B_tS/GLtL) statistic
WEAVE_STATISTIC_NCOUNT	Hough number count.
WEAVE_STATISTIC_NCOUNT_DET	Hough number count per detector.
WEAVE_STATISTIC_MAX	Marker +1 of maximal combined valid statistics value.

Definition at line 42 of file bin/Weave/statistics.h.

Function Documentation

XLALWeaveStatisticsSetDirectDependencies()

int XLALWeaveStatisticsSetDirectDependencies	(	WeaveStatisticType *	deps,
		const WeaveStatisticType	stats
	)

Set all bits in 'deps' corresponding to direct dependencies of the set of input statistics 'stat'.

Definition at line 211 of file bin/Weave/statistics.c.

XLALWeaveStatisticsParamsSetDependencyMap()

int XLALWeaveStatisticsParamsSetDependencyMap	(	WeaveStatisticsParams *	statistics_params,
		const WeaveStatisticType	toplist_stats,
		const WeaveStatisticType	extra_output_stats,
		const WeaveStatisticType	recalc_stats
	)

Fill StatisticsParams logic for given toplist and extra-output stats.

Parameters

[out]	statistics_params	statstics dependency map
[in]	toplist_stats	requested toplist statistics
[in]	extra_output_stats	requested 'extra' (stage0) output statistics
[in]	recalc_stats	requested 'recalc' (stage1) statistics

Definition at line 235 of file bin/Weave/statistics.c.

XLALWeaveStatisticsParamsDestroy()

void XLALWeaveStatisticsParamsDestroy

(

WeaveStatisticsParams *

statistics_params

)

Destroy a StatisticsParams struct.

Definition at line 325 of file bin/Weave/statistics.c.

Variable Documentation

WeaveToplistChoices

const UserChoices WeaveToplistChoices

extern

User input choices for toplist ranking statistics.

Definition at line 192 of file bin/Weave/statistics.c.

WeaveToplistHelpString

const char* const WeaveToplistHelpString

extern

User input help string for toplist ranking statistics.

Definition at line 200 of file bin/Weave/statistics.c.

WeaveStatisticChoices

const UserChoices WeaveStatisticChoices

extern

User input choices for all supported statistics.

Definition at line 150 of file bin/Weave/statistics.c.

WeaveStatisticHelpString

const char* const WeaveStatisticHelpString

extern

User input help string for all supported statistics.

Definition at line 167 of file bin/Weave/statistics.c.