ctool.hpp
4.91 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
125
126
127
128
129
130
131
132
/***************************************************************************
* ctool - ctool base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2014-2016 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 ctool.hpp
* @brief ctool base class definition
* @author Juergen Knoedlseder
*/
#ifndef CTOOL_HPP
#define CTOOL_HPP
/* __ Includes ___________________________________________________________ */
#include "GammaLib.hpp"
#include "GCTALib.hpp"
/* __Definitions _________________________________________________________ */
/***********************************************************************//**
* @class ctool
*
* @brief ctool base class
***************************************************************************/
class ctool : public GApplication {
public:
// Constructors and destructors
ctool(void);
ctool(const std::string& name, const std::string& version);
ctool(const std::string& name, const std::string& version,
int argc, char* argv[]);
ctool(const ctool& app);
virtual ~ctool(void);
// Operators
ctool& operator=(const ctool& app);
// Pure virtual methods
virtual void clear(void) = 0;
virtual void run(void) = 0;
virtual void save(void) = 0;
// Public methods
virtual void execute(void);
#ifdef SWIG
public:
#else
protected:
#endif
// Protected methods
void init_members(void);
void copy_members(const ctool& app);
void free_members(void);
const bool& read_ahead(void) const;
const GTimeReference& time_reference(void) const;
GObservations get_observations(const bool& get_response = true);
void setup_observations(GObservations& obs);
// Protected methods that create objects from user parameters
GEbounds create_ebounds(void);
GSkyMap create_map(const GObservations& obs);
GCTAEventCube create_cube(const GObservations& obs);
GCTAObservation create_cta_obs(void);
// Protected methods that check user parameters
void require_inobs(const std::string& method);
void require_inobs_nolist(const std::string& method);
void require_inobs_nocube(const std::string& method);
// Protected support methods
void set_response(GObservations& obs);
void set_obs_response(GCTAObservation* obs);
void set_obs_bounds(GObservations& obs);
GSkyDir get_mean_pointing(const GObservations& obs);
size_t get_current_rss(void);
std::string get_obs_header(const GObservation* obs);
// Protected members
bool m_read_ahead; //!< Read ahead output parameters
protected:
// Protected methods
void provide_help(void) const;
// Protected members
bool m_use_xml; //!< Use XML file instead of FITS file for observations
GTimeReference m_cta_ref; //!< CTA time reference
};
/***********************************************************************//**
* @brief Return observation container
*
* @return Reference to observation container
***************************************************************************/
inline
const bool& ctool::read_ahead(void) const
{
return (m_read_ahead);
}
/***********************************************************************//**
* @brief Return time reference
*
* @return Reference to time reference
***************************************************************************/
inline
const GTimeReference& ctool::time_reference(void) const
{
return (m_cta_ref);
}
#endif /* CTOOL_HPP */