Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-b246709
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages

Module which handles the output results. More...

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

Detailed Description

Module which handles the output results.

Definition in file OutputResults.h.

Go to the source code of this file.

Enumerations

enum  tagWeaveToplistExtraOutputs { WEAVE_TOPLIST_EXTRA_OUTPUTS }
 Extra toplist output fields. More...
 

Enumeration Type Documentation

◆ tagWeaveToplistExtraOutputs

Extra toplist output fields.

Enumerator
WEAVE_TOPLIST_EXTRA_OUTPUTS 

Definition at line 43 of file OutputResults.h.

Function Documentation

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