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

Module which handles toplists of results. More...

Prototypes

WeaveResultsToplist * XLALWeaveResultsToplistCreate (const size_t nspins, WeaveStatisticsParams *statistics_params, const char *stat_name, const char *stat_desc, const UINT4 toplist_limit, WeaveResultsToplistRankingStats toplist_rank_stats_fcn, WeaveResultsToplistItemGetRankStat toplist_item_get_rank_stat_fcn, WeaveResultsToplistItemSetRankStat toplist_item_set_rank_stat_fcn)
 Create results toplist. More...
 
void XLALWeaveResultsToplistDestroy (WeaveResultsToplist *toplist)
 Free results toplist. More...
 
int XLALWeaveResultsToplistAdd (WeaveResultsToplist *toplist, const WeaveSemiResults *semi_res, const UINT4 semi_nfreqs)
 Add semicoherent results to toplist. More...
 
int XLALWeaveResultsToplistCompletionLoop (WeaveResultsToplist *toplist)
 Compute all missing 'extra' (non-toplist-ranking) statistics for all toplist entries. More...
 
int XLALWeaveResultsToplistWrite (FITSFile *file, const WeaveResultsToplist *toplist)
 Write results toplist to a FITS file. More...
 
int XLALWeaveResultsToplistReadAppend (FITSFile *file, WeaveResultsToplist *toplist)
 Read results from a FITS file and append to existing results toplist. More...
 
int XLALWeaveResultsToplistCompare (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 WeaveResultsToplist *toplist_1, const WeaveResultsToplist *toplist_2)
 Compare two results toplists and return whether they are equal. More...
 

Detailed Description

Module which handles toplists of results.

Definition in file ResultsToplist.h.

Go to the source code of this file.

Data Structures

struct  WeaveResultsToplistItem
 Toplist item. More...
 

Typedefs

typedef const REAL4 *(* WeaveResultsToplistRankingStats) (const WeaveSemiResults *semi_res)
 Function which returns pointer to array of statistics by which toplist items are ranked. More...
 
typedef REAL4(* WeaveResultsToplistItemGetRankStat) (const WeaveResultsToplistItem *item)
 Function which returns the value of the statistic by which toplist items are ranked. More...
 
typedef void(* WeaveResultsToplistItemSetRankStat) (WeaveResultsToplistItem *item, const REAL4 value)
 Function which sets the value of the statistic by which toplist items are ranked. More...
 

Typedef Documentation

◆ WeaveResultsToplistRankingStats

typedef const REAL4 *(* WeaveResultsToplistRankingStats) (const WeaveSemiResults *semi_res)

Function which returns pointer to array of statistics by which toplist items are ranked.

Definition at line 68 of file ResultsToplist.h.

◆ WeaveResultsToplistItemGetRankStat

typedef REAL4(* WeaveResultsToplistItemGetRankStat) (const WeaveResultsToplistItem *item)

Function which returns the value of the statistic by which toplist items are ranked.

Definition at line 73 of file ResultsToplist.h.

◆ WeaveResultsToplistItemSetRankStat

typedef void(* WeaveResultsToplistItemSetRankStat) (WeaveResultsToplistItem *item, const REAL4 value)

Function which sets the value of the statistic by which toplist items are ranked.

Definition at line 78 of file ResultsToplist.h.

Function Documentation

◆ XLALWeaveResultsToplistCreate()

WeaveResultsToplist * XLALWeaveResultsToplistCreate ( const size_t  nspins,
WeaveStatisticsParams *  statistics_params,
const char stat_name,
const char stat_desc,
const UINT4  toplist_limit,
WeaveResultsToplistRankingStats  toplist_rank_stats_fcn,
WeaveResultsToplistItemGetRankStat  toplist_item_get_rank_stat_fcn,
WeaveResultsToplistItemSetRankStat  toplist_item_set_rank_stat_fcn 
)

Create results toplist.

Definition at line 659 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistDestroy()

void XLALWeaveResultsToplistDestroy ( WeaveResultsToplist *  toplist)

Free results toplist.

Definition at line 700 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistAdd()

int XLALWeaveResultsToplistAdd ( WeaveResultsToplist *  toplist,
const WeaveSemiResults *  semi_res,
const UINT4  semi_nfreqs 
)

Add semicoherent results to toplist.

Definition at line 715 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistCompletionLoop()

int XLALWeaveResultsToplistCompletionLoop ( WeaveResultsToplist *  toplist)

Compute all missing 'extra' (non-toplist-ranking) statistics for all toplist entries.

Definition at line 863 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistWrite()

int XLALWeaveResultsToplistWrite ( FITSFile file,
const WeaveResultsToplist *  toplist 
)

Write results toplist to a FITS file.

Definition at line 880 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistReadAppend()

int XLALWeaveResultsToplistReadAppend ( FITSFile file,
WeaveResultsToplist *  toplist 
)

Read results from a FITS file and append to existing results toplist.

Definition at line 913 of file ResultsToplist.c.

◆ XLALWeaveResultsToplistCompare()

int XLALWeaveResultsToplistCompare ( 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 WeaveResultsToplist *  toplist_1,
const WeaveResultsToplist *  toplist_2 
)

Compare two results toplists and return whether they are equal.

Definition at line 964 of file ResultsToplist.c.