Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-8a6b96f
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
OutputResults.h
Go to the documentation of this file.
1//
2// Copyright (C) 2016, 2017 Karl Wette
3//
4// This program is free software; you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation; either version 2 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with with program; see the file COPYING. If not, write to the
16// Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17// MA 02110-1301 USA
18//
19
20#ifndef _OUTPUT_RESULTS_H
21#define _OUTPUT_RESULTS_H
22
23///
24/// \file
25/// \ingroup lalpulsar_bin_Weave
26/// \brief Module which handles the output results
27///
28
29#include "Weave.h"
30#include "SetupData.h"
31#include "ComputeResults.h"
32
33#include <lal/UserInputParse.h>
34#include <lal/LFTandTSutils.h>
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40///
41/// Extra toplist output fields
42///
45};
46
47WeaveOutputResults *XLALWeaveOutputResultsCreate(
48 const LIGOTimeGPS *ref_time,
49 const size_t nspins,
50 WeaveStatisticsParams *statistics_params,
51 const UINT4 toplist_limit,
52 const BOOLEAN mean2F_hgrm
53);
55 WeaveOutputResults *out
56);
58 WeaveOutputResults *out,
59 const WeaveSemiResults *semi_res,
60 const UINT4 semi_nfreqs
61);
63 WeaveOutputResults *out
64);
67 const WeaveOutputResults *out
68);
71 WeaveOutputResults **out,
72 UINT4 toplist_limit
73);
75 BOOLEAN *equal,
76 const WeaveSetupData *setup,
77 const BOOLEAN sort_by_semi_phys,
78 const UINT4 round_param_to_dp,
79 const UINT4 round_param_to_sf,
80 const REAL8 unmatched_item_tol,
81 const REAL8 param_tol_mism,
82 const VectorComparison *result_tol,
83 const UINT4 toplist_compare_limit,
84 const WeaveOutputResults *out_1,
85 const WeaveOutputResults *out_2
86);
87
88#ifdef __cplusplus
89}
90#endif
91
92#endif // _OUTPUT_RESULTS_H
93
94// Local Variables:
95// c-file-style: "linux"
96// c-basic-offset: 2
97// End:
Module which computes coherent and semicoherent results.
int XLALWeaveOutputResultsAdd(WeaveOutputResults *out, const WeaveSemiResults *semi_res, const UINT4 semi_nfreqs)
Add semicoherent results to output.
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.
int XLALWeaveOutputResultsWrite(FITSFile *file, const WeaveOutputResults *out)
Write output results to a FITS file.
tagWeaveToplistExtraOutputs
Extra toplist output fields.
Definition: OutputResults.h:43
@ WEAVE_TOPLIST_EXTRA_OUTPUTS
Definition: OutputResults.h:44
int XLALWeaveOutputResultsReadAppend(FITSFile *file, WeaveOutputResults **out, UINT4 toplist_limit)
Read results from a FITS file and append to new/existing output results.
void XLALWeaveOutputResultsDestroy(WeaveOutputResults *out)
Free output results.
int XLALWeaveOutputResultsCompletionLoop(WeaveOutputResults *out)
Compute all the missing 'completion-loop' statistics for all toplist entries.
WeaveOutputResults * XLALWeaveOutputResultsCreate(const LIGOTimeGPS *ref_time, const size_t nspins, WeaveStatisticsParams *statistics_params, const UINT4 toplist_limit, const BOOLEAN mean2F_hgrm)
Create output results.
Module which handles the setup data.
struct tagFITSFile FITSFile
Representation of a FITS file.
Definition: FITSFileIO.h:54
unsigned char BOOLEAN
double REAL8
uint32_t UINT4
Struct holding the results of comparing two floating-point vectors (real-valued or complex),...
Definition: LFTandTSutils.h:64