ctbin.hpp
4.99 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/***************************************************************************
* ctbin - Event binning tool *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2017 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file ctbin.hpp
* @brief Event binning tool definition
* @author Juergen Knoedlseder
*/
#ifndef CTBIN_HPP
#define CTBIN_HPP
/* __ Includes ___________________________________________________________ */
#include "ctobservation.hpp"
/* __Definitions _________________________________________________________ */
#define CTBIN_NAME "ctbin"
/***********************************************************************//**
* @class ctbin
*
* @brief Event binning tool
*
* This class bins event list(s) into a single counts cube. The class can
* operate on predefined observation containers, on individual event list
* FITS files, and on observation definition XML files.
*
* If multiple event lists are specified in the observation container or the
* XML definition file, the class will merge these events into a single
* counts cube.
*
* Results are stored in an observation container that can be written to disk
* in form of a single FITS file. On output, the observation container will
* have merged the input event lists into a single observation.
*
* WARNING: Note that the pointing direction of the counts cube will be set
* to the skymap centre used for the counts cube definition. If usepnt=yes
* is used, the pointing direction will be extracted from the first
* observation encountered in the list. Ultimately, pointing direction
* information should not be removed from the counts cube and exposure and
* PSF cubes should be used for response computation. This is however not
* yet fully implemented.
***************************************************************************/
class ctbin : public ctobservation {
public:
// Constructors and destructors
ctbin(void);
explicit ctbin(const GObservations& obs);
ctbin(int argc, char *argv[]);
ctbin(const ctbin& app);
virtual ~ctbin(void);
// Operators
ctbin& operator=(const ctbin& app);
// Methods
void clear(void);
void run(void);
void save(void);
void publish(const std::string& name = "");
const GCTAEventCube& cube(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const ctbin& app);
void free_members(void);
void get_parameters(void);
void fill_cube(GCTAObservation* obs);
void set_weights(GCTAObservation* obs);
void obs_cube(void);
// User parameters
GFilename m_outcube; //!< Output counts map file name
bool m_usepnt; //!< Use pointing instead of xref/yref parameters
bool m_publish; //!< Publish counts cube?
GChatter m_chatter; //!< Chattiness
// Protected members
GSkyMap m_counts; //!< Event cube counts
GSkyMap m_weights; //!< Event cube weights
GEbounds m_ebounds; //!< Energy boundaries
GGti m_gti; //!< Good time intervals
GCTAEventCube m_cube; //!< Events cube (for cube() method)
double m_ontime; //!< Total ontime
double m_livetime; //!< Total livetime
// Cache members
std::vector<GSkyDir> m_dirs; //!< Cached GSkyDir for each pixel in m_counts
};
/***********************************************************************//**
* @brief Return event cube
*
* @return Reference to event cube
*
* Returns a reference to the event cube.
***************************************************************************/
inline
const GCTAEventCube& ctbin::cube(void) const
{
return m_cube;
}
#endif /* CTBIN_HPP */