Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-ea7c608
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
bin/Weave/Statistics.c File Reference

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...
 

Go to the source code of this file.

Data Structures

struct  WeaveStatisticMap
 Struct defining the global 'statistics map' that contains all the defining properties of the supported statistics. More...
 

Macros

#define ENTRY_NONE
 Sets of toplists, extra statistics and dependencies handled by this code. More...
 
#define ENTRY_COH2F
 
#define ENTRY_COH2F_DET
 
#define ENTRY_MAX2F
 
#define ENTRY_MAX2F_DET
 
#define ENTRY_SUM2F
 
#define ENTRY_SUM2F_DET
 
#define ENTRY_MEAN2F
 
#define ENTRY_MEAN2F_DET
 
#define ENTRY_BSGL
 
#define ENTRY_BSGLtL
 
#define ENTRY_BtSGLtL
 
#define ENTRY_NCOUNT
 
#define ENTRY_NCOUNT_DET
 
#define ENTRY_2_NAME(X)   ENTRY_2_NAME_X(X)
 
#define ENTRY_2_NAME_X(v, n, s, d, h)   [XLAL_BIT2IDX(v)] = n
 
#define ENTRY_2_MAP(X)   ENTRY_2_MAP_X(X)
 
#define ENTRY_2_MAP_X(v, n, s, d, h)   { .val = v, .name = n, .dependencies = d, .help = h }
 
#define ENTRY_2_CHOICES(X)   ENTRY_2_CHOICES_X(X)
 
#define ENTRY_2_CHOICES_X(v, n, s, d, h)   { .val = v, .name = n }
 
#define ENTRY_2_HELPSTR(X)   ENTRY_2_HELPSTR_X(X)
 
#define ENTRY_2_HELPSTR_X(v, n, s, d, h)   " - " n s ": " h ".\n"
 
#define SUPPORTED_STATISTICS
 
#define SUPPORTED_TOPLISTS
 

Variables

const char *const WeaveStatisticNamesByIndex [XLAL_BIT2IDX(WEAVE_STATISTIC_MAX)]
 
const WeaveStatisticMap statistic_map []
 Array of descriptor structs for all statistics supported by Weave. 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...
 
const UserChoices WeaveToplistChoices
 User input choices for toplist ranking statistics. More...
 
const char *const WeaveToplistHelpString
 User input help string for toplist ranking statistics. More...
 

Macro Definition Documentation

◆ ENTRY_NONE

#define ENTRY_NONE
Value:
WEAVE_STATISTIC_NONE, "none", " ", 0, \
"No statistic selected"
@ WEAVE_STATISTIC_NONE

Sets of toplists, extra statistics and dependencies handled by this code.

Definition at line 44 of file bin/Weave/Statistics.c.

◆ ENTRY_COH2F

#define ENTRY_COH2F
Value:
WEAVE_STATISTIC_COH2F, "coh2F", " ", 0, \
"Per-segment multi-detector coherent 2F statistic"
@ WEAVE_STATISTIC_COH2F
Per segment multi-detector F-statistic.

Definition at line 47 of file bin/Weave/Statistics.c.

◆ ENTRY_COH2F_DET

#define ENTRY_COH2F_DET
Value:
WEAVE_STATISTIC_COH2F_DET, "coh2F_det", " ", 0, \
"Per-segment per-detector coherent 2F statistic"
@ WEAVE_STATISTIC_COH2F_DET
Per segment per-detector F-statistic.

Definition at line 50 of file bin/Weave/Statistics.c.

◆ ENTRY_MAX2F

#define ENTRY_MAX2F
Value:
"Maximum over segments multi-detector coherent 2F statistic"
@ WEAVE_STATISTIC_MAX2F

Definition at line 53 of file bin/Weave/Statistics.c.

◆ ENTRY_MAX2F_DET

#define ENTRY_MAX2F_DET
Value:
"Maximum over segments per-detector coherent 2F statistic"
@ WEAVE_STATISTIC_MAX2F_DET

Definition at line 56 of file bin/Weave/Statistics.c.

◆ ENTRY_SUM2F

#define ENTRY_SUM2F
Value:
"Sum over segments of multi-detector coherent 2F statistic"
@ WEAVE_STATISTIC_SUM2F
Multi-detector sum (over segments) F-statistic.

Definition at line 59 of file bin/Weave/Statistics.c.

◆ ENTRY_SUM2F_DET

#define ENTRY_SUM2F_DET
Value:
"Sum over segments of single-detector coherent 2F statistic"
@ WEAVE_STATISTIC_SUM2F_DET
Per detector sum F-statistic.

Definition at line 62 of file bin/Weave/Statistics.c.

◆ ENTRY_MEAN2F

#define ENTRY_MEAN2F
Value:
"Average over segments of multi-detector coherent 2F statistic"
@ WEAVE_STATISTIC_MEAN2F
Multi-detector average (over segments) F-statistic.

Definition at line 65 of file bin/Weave/Statistics.c.

◆ ENTRY_MEAN2F_DET

#define ENTRY_MEAN2F_DET
Value:
"Average over segments of single-detector coherent 2F statistic"
@ WEAVE_STATISTIC_MEAN2F_DET
Per detector average F-statistic.

Definition at line 68 of file bin/Weave/Statistics.c.

◆ ENTRY_BSGL

#define ENTRY_BSGL
Value:
"Bayes factor 'Signal' vs 'Gaussian noise' or 'Line'"
@ WEAVE_STATISTIC_BSGL
Line-robust log10(B_S/GL) statistic.

Definition at line 71 of file bin/Weave/Statistics.c.

◆ ENTRY_BSGLtL

#define ENTRY_BSGLtL
Value:
"Bayes factor 'Signal' vs 'Gaussian noise' or 'Line' or 'transient Line'."
@ WEAVE_STATISTIC_BSGLtL
(transient-)line robust log10(B_S/GLtL) statistic

Definition at line 74 of file bin/Weave/Statistics.c.

◆ ENTRY_BtSGLtL

#define ENTRY_BtSGLtL
Value:
"Bayes factor 'transient Signal' vs 'Gaussian noise' or 'Line' or 'transient Line'."
@ WEAVE_STATISTIC_BtSGLtL
(transient-)line robust log10(B_tS/GLtL) statistic

Definition at line 77 of file bin/Weave/Statistics.c.

◆ ENTRY_NCOUNT

#define ENTRY_NCOUNT
Value:
"Multi-detector 'Hough' number count of 'threshold crossings' heavyside(2F - 2Fth) over segments"
@ WEAVE_STATISTIC_NCOUNT
Hough number count.

Definition at line 80 of file bin/Weave/Statistics.c.

◆ ENTRY_NCOUNT_DET

#define ENTRY_NCOUNT_DET
Value:
"Per-detector 'Hough' number count of 'threshold crossings' heavyside(2F - 2Fth) over segments"
@ WEAVE_STATISTIC_NCOUNT_DET
Hough number count per detector.

Definition at line 83 of file bin/Weave/Statistics.c.

◆ ENTRY_2_NAME

#define ENTRY_2_NAME (   X)    ENTRY_2_NAME_X(X)

Definition at line 86 of file bin/Weave/Statistics.c.

◆ ENTRY_2_NAME_X

#define ENTRY_2_NAME_X (   v,
  n,
  s,
  d,
 
)    [XLAL_BIT2IDX(v)] = n

Definition at line 87 of file bin/Weave/Statistics.c.

◆ ENTRY_2_MAP

#define ENTRY_2_MAP (   X)    ENTRY_2_MAP_X(X)

Definition at line 89 of file bin/Weave/Statistics.c.

◆ ENTRY_2_MAP_X

#define ENTRY_2_MAP_X (   v,
  n,
  s,
  d,
 
)    { .val = v, .name = n, .dependencies = d, .help = h }

Definition at line 90 of file bin/Weave/Statistics.c.

◆ ENTRY_2_CHOICES

#define ENTRY_2_CHOICES (   X)    ENTRY_2_CHOICES_X(X)

Definition at line 92 of file bin/Weave/Statistics.c.

◆ ENTRY_2_CHOICES_X

#define ENTRY_2_CHOICES_X (   v,
  n,
  s,
  d,
 
)    { .val = v, .name = n }

Definition at line 93 of file bin/Weave/Statistics.c.

◆ ENTRY_2_HELPSTR

#define ENTRY_2_HELPSTR (   X)    ENTRY_2_HELPSTR_X(X)

Definition at line 95 of file bin/Weave/Statistics.c.

◆ ENTRY_2_HELPSTR_X

#define ENTRY_2_HELPSTR_X (   v,
  n,
  s,
  d,
 
)    " - " n s ": " h ".\n"

Definition at line 96 of file bin/Weave/Statistics.c.

◆ SUPPORTED_STATISTICS

◆ SUPPORTED_TOPLISTS

#define SUPPORTED_TOPLISTS

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_paramsstatstics dependency map
[in]toplist_statsrequested toplist statistics
[in]extra_output_statsrequested 'extra' (stage0) output statistics
[in]recalc_statsrequested '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

◆ WeaveStatisticNamesByIndex

const char* const WeaveStatisticNamesByIndex[XLAL_BIT2IDX(WEAVE_STATISTIC_MAX)]
Initial value:

Definition at line 98 of file bin/Weave/Statistics.c.

◆ statistic_map

◆ WeaveStatisticChoices

const UserChoices WeaveStatisticChoices
Initial value:

User input choices for all supported statistics.

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

◆ WeaveStatisticHelpString

◆ WeaveToplistChoices

const UserChoices WeaveToplistChoices
Initial value:

User input choices for toplist ranking statistics.

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

◆ WeaveToplistHelpString

const char* const WeaveToplistHelpString
Initial value:

User input help string for toplist ranking statistics.

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