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
Prototypes | Data Structures | Variables
OutputResults.c File Reference
Pulsar Applications » Search Applications » Weave Search Application

Prototypes

WeaveOutputResults * XLALWeaveOutputResultsCreate (const LIGOTimeGPS *ref_time, const size_t nspins, WeaveStatisticsParams *statistics_params, const UINT4 toplist_limit, const BOOLEAN mean2F_hgrm)
 Create output results. More...
 
void XLALWeaveOutputResultsDestroy (WeaveOutputResults *out)
 Free output results. More...
 
int XLALWeaveOutputResultsAdd (WeaveOutputResults *out, const WeaveSemiResults *semi_res, const UINT4 semi_nfreqs)
 Add semicoherent results to output. More...
 
int XLALWeaveOutputResultsCompletionLoop (WeaveOutputResults *out)
 Compute all the missing 'completion-loop' statistics for all toplist entries. More...
 
int XLALWeaveOutputResultsWrite (FITSFile *file, const WeaveOutputResults *out)
 Write output results to a FITS file. More...
 
int XLALWeaveOutputResultsReadAppend (FITSFile *file, WeaveOutputResults **out, UINT4 toplist_limit)
 Read results from a FITS file and append to new/existing output results. More...
 
int XLALWeaveOutputResultsCompare (BOOLEAN *equal, const WeaveSetupData *setup, const BOOLEAN sort_by_semi_phys, const UINT4 round_param_to_dp, const UINT4 round_param_to_sf, const REAL8 unmatched_item_tol, const REAL8 param_tol_mism, const VectorComparison *result_tol, const UINT4 toplist_compare_limit, const WeaveOutputResults *out_1, const WeaveOutputResults *out_2)
 Compare two output results and return whether they are equal. More...
 
Functions for results toplist ranked by summed multi-detector F-statistic
static const REAL4 * toplist_results_sum2F (const WeaveSemiResults *semi_res)
 
static REAL4 toplist_item_get_sum2F (const WeaveResultsToplistItem *item)
 
static void toplist_item_set_sum2F (WeaveResultsToplistItem *item, const REAL4 value)
 
Functions for results toplist ranked by mean multi-detector F-statistic
static const REAL4 * toplist_results_mean2F (const WeaveSemiResults *semi_res)
 
static REAL4 toplist_item_get_mean2F (const WeaveResultsToplistItem *item)
 
static void toplist_item_set_mean2F (WeaveResultsToplistItem *item, const REAL4 value)
 
Functions for results toplist ranked by line-robust log10(B_S/GL) statistic
static const REAL4 * toplist_results_log10BSGL (const WeaveSemiResults *semi_res)
 
static REAL4 toplist_item_get_log10BSGL (const WeaveResultsToplistItem *item)
 
static void toplist_item_set_log10BSGL (WeaveResultsToplistItem *item, const REAL4 value)
 
Functions for results toplist ranked by transient-line-robust log10(B_S/GLtL) statistic
static const REAL4 * toplist_results_log10BSGLtL (const WeaveSemiResults *semi_res)
 
static REAL4 toplist_item_get_log10BSGLtL (const WeaveResultsToplistItem *item)
 
static void toplist_item_set_log10BSGLtL (WeaveResultsToplistItem *item, const REAL4 value)
 
Functions for results toplist ranked by transient-signal line-robust log10(B_tS/GLtL) statistic
static const REAL4 * toplist_results_log10BtSGLtL (const WeaveSemiResults *semi_res)
 
static REAL4 toplist_item_get_log10BtSGLtL (const WeaveResultsToplistItem *item)
 
static void toplist_item_set_log10BtSGLtL (WeaveResultsToplistItem *item, const REAL4 value)
 

Go to the source code of this file.

Data Structures

struct  WeaveMean2FHistogramBin
 Histogram bin of mean multi-F-statistics. More...
 
struct  WeaveOutputResults
 Output results from a search. More...
 

Variables

const REAL4 mean2F_hgrm_bin_width = 0.1
 Histogram bin width of mean multi-F-statistics. More...
 

Function Documentation

◆ toplist_results_sum2F()

static const REAL4 * toplist_results_sum2F ( const WeaveSemiResults *  semi_res)
static

Definition at line 90 of file OutputResults.c.

◆ toplist_item_get_sum2F()

static REAL4 toplist_item_get_sum2F ( const WeaveResultsToplistItem *  item)
static

Definition at line 94 of file OutputResults.c.

◆ toplist_item_set_sum2F()

static void toplist_item_set_sum2F ( WeaveResultsToplistItem *  item,
const REAL4  value 
)
static

Definition at line 98 of file OutputResults.c.

◆ toplist_results_mean2F()

static const REAL4 * toplist_results_mean2F ( const WeaveSemiResults *  semi_res)
static

Definition at line 109 of file OutputResults.c.

◆ toplist_item_get_mean2F()

static REAL4 toplist_item_get_mean2F ( const WeaveResultsToplistItem *  item)
static

Definition at line 113 of file OutputResults.c.

◆ toplist_item_set_mean2F()

static void toplist_item_set_mean2F ( WeaveResultsToplistItem *  item,
const REAL4  value 
)
static

Definition at line 117 of file OutputResults.c.

◆ toplist_results_log10BSGL()

static const REAL4 * toplist_results_log10BSGL ( const WeaveSemiResults *  semi_res)
static

Definition at line 128 of file OutputResults.c.

◆ toplist_item_get_log10BSGL()

static REAL4 toplist_item_get_log10BSGL ( const WeaveResultsToplistItem *  item)
static

Definition at line 132 of file OutputResults.c.

◆ toplist_item_set_log10BSGL()

static void toplist_item_set_log10BSGL ( WeaveResultsToplistItem *  item,
const REAL4  value 
)
static

Definition at line 136 of file OutputResults.c.

◆ toplist_results_log10BSGLtL()

static const REAL4 * toplist_results_log10BSGLtL ( const WeaveSemiResults *  semi_res)
static

Definition at line 147 of file OutputResults.c.

◆ toplist_item_get_log10BSGLtL()

static REAL4 toplist_item_get_log10BSGLtL ( const WeaveResultsToplistItem *  item)
static

Definition at line 151 of file OutputResults.c.

◆ toplist_item_set_log10BSGLtL()

static void toplist_item_set_log10BSGLtL ( WeaveResultsToplistItem *  item,
const REAL4  value 
)
static

Definition at line 155 of file OutputResults.c.

◆ toplist_results_log10BtSGLtL()

static const REAL4 * toplist_results_log10BtSGLtL ( const WeaveSemiResults *  semi_res)
static

Definition at line 166 of file OutputResults.c.

◆ toplist_item_get_log10BtSGLtL()

static REAL4 toplist_item_get_log10BtSGLtL ( const WeaveResultsToplistItem *  item)
static

Definition at line 170 of file OutputResults.c.

◆ toplist_item_set_log10BtSGLtL()

static void toplist_item_set_log10BtSGLtL ( WeaveResultsToplistItem *  item,
const REAL4  value 
)
static

Definition at line 174 of file OutputResults.c.

◆ XLALWeaveOutputResultsCreate()

WeaveOutputResults * XLALWeaveOutputResultsCreate ( const LIGOTimeGPS *  ref_time,
const size_t  nspins,
WeaveStatisticsParams *  statistics_params,
const UINT4  toplist_limit,
const BOOLEAN  mean2F_hgrm 
)

Create output results.

Definition at line 184 of file OutputResults.c.

◆ XLALWeaveOutputResultsDestroy()

void XLALWeaveOutputResultsDestroy ( WeaveOutputResults *  out)

Free output results.

Definition at line 268 of file OutputResults.c.

◆ XLALWeaveOutputResultsAdd()

int XLALWeaveOutputResultsAdd ( WeaveOutputResults *  out,
const WeaveSemiResults *  semi_res,
const UINT4  semi_nfreqs 
)

Add semicoherent results to output.

Definition at line 287 of file OutputResults.c.

◆ XLALWeaveOutputResultsCompletionLoop()

int XLALWeaveOutputResultsCompletionLoop ( WeaveOutputResults *  out)

Compute all the missing 'completion-loop' statistics for all toplist entries.

Definition at line 343 of file OutputResults.c.

◆ XLALWeaveOutputResultsWrite()

int XLALWeaveOutputResultsWrite ( FITSFile *  file,
const WeaveOutputResults *  out 
)

Write output results to a FITS file.

Definition at line 362 of file OutputResults.c.

◆ XLALWeaveOutputResultsReadAppend()

int XLALWeaveOutputResultsReadAppend ( FITSFile *  file,
WeaveOutputResults **  out,
UINT4  toplist_limit 
)

Read results from a FITS file and append to new/existing output results.

Number of segments

Definition at line 465 of file OutputResults.c.

◆ XLALWeaveOutputResultsCompare()

int XLALWeaveOutputResultsCompare ( BOOLEAN *  equal,
const WeaveSetupData *  setup,
const BOOLEAN  sort_by_semi_phys,
const UINT4  round_param_to_dp,
const UINT4  round_param_to_sf,
const REAL8  unmatched_item_tol,
const REAL8  param_tol_mism,
const VectorComparison *  result_tol,
const UINT4  toplist_compare_limit,
const WeaveOutputResults *  out_1,
const WeaveOutputResults *  out_2 
)

Compare two output results and return whether they are equal.

Definition at line 631 of file OutputResults.c.

Variable Documentation

◆ mean2F_hgrm_bin_width

const REAL4 mean2F_hgrm_bin_width = 0.1

Histogram bin width of mean multi-F-statistics.

Definition at line 34 of file OutputResults.c.