ctobservation.i
6.66 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/***************************************************************************
* ctobservation - Base class for observation tools *
* ----------------------------------------------------------------------- *
* copyright (C) 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 ctobservation.i
* @brief Observation tool base class interface definition
* @author Juergen Knoedlseder
*/
%{
/* Put headers and other declarations here that are needed for compilation */
#define SWIG
#include "ctobservation.hpp"
/***********************************************************************//**
* @class csobservation
*
* @brief csobservation base class
*
* This class is a non-abstract C++ implementation of the ctobservation base
* class. It serves as Python base class since Python does not know about
* abstract classes.
***************************************************************************/
class csobservation : public ctobservation {
public:
// Constructors and destructors
csobservation(const std::string& name, const std::string& version) :
ctobservation(name, version) {}
csobservation(const std::string& name, const std::string& version,
const GObservations& obs) :
ctobservation(name, version, obs) {}
csobservation(const std::string& name, const std::string& version,
int argc, char* argv[]) :
ctobservation(name, version, argc, argv){}
csobservation(const csobservation& app) : ctobservation(app) {}
virtual ~csobservation(void) {}
// Dummy methods (implementation makes this class non-abstract)
virtual void clear(void) {}
virtual void run(void) {}
virtual void save(void) {}
};
%}
// Include (int ARGC, char **ARGV) typemap to allow passing command line
// arguments to GApplication constructor
%include "argcargv.i"
/***********************************************************************//**
* @class ctobservation
*
* @brief Base class for observation tools
***************************************************************************/
class ctobservation : public ctool {
public:
// Constructors and destructors
ctobservation(const std::string& name, const std::string& version);
ctobservation(const std::string& name, const std::string& version,
const GObservations& obs);
ctobservation(const std::string& name, const std::string& version,
int ARGC, char **ARGV);
ctobservation(const ctobservation& app);
virtual ~ctobservation(void);
// Pure virtual methods
virtual void clear(void) = 0;
virtual void run(void) = 0;
virtual void save(void) = 0;
// Public methods
const GObservations& obs(void) const;
// Make methods private in Python by prepending an underscore
%rename(_first_unbinned_observation) first_unbinned_observation;
%rename(_next_unbinned_observation) next_unbinned_observation;
// Protected methods
GCTAObservation* first_unbinned_observation(void);
GCTAObservation* next_unbinned_observation(void);
};
/***********************************************************************//**
* @class csobservation
*
* @brief Base class for observation scripts
*
* This is the base class from which observation scripts should derive.
***************************************************************************/
class csobservation : public ctobservation {
public:
// Constructors and destructors
csobservation(const std::string& name, const std::string& version);
csobservation(const std::string& name, const std::string& version,
const GObservations& obs);
csobservation(const std::string& name, const std::string& version,
int ARGC, char **ARGV);
csobservation(const csobservation& app);
virtual ~csobservation(void);
// Methods
virtual void clear(void);
virtual void run(void);
virtual void save(void);
};
/***********************************************************************//**
* @brief Observation tool base class C++ extensions
***************************************************************************/
%extend ctobservation {
}
/***********************************************************************//**
* @brief Observation tool base class Python extensions
***************************************************************************/
%pythoncode %{
# Initialise application by calling the appropriate base class constructor.
# The function supports either an observation container, or an argument
# list or no argument as "argv" parameter. The function also writes the
# header in the log file and switches the date on for logging.
def _init_csobservation(self, argv):
if len(argv) > 0 and isinstance(argv[0],gammalib.GObservations):
csobservation.__init__(self, self._name, self._version, argv[0])
elif len(argv) > 0:
csobservation.__init__(self, self._name, self._version, *argv)
else:
csobservation.__init__(self, self._name, self._version)
# Set logger properties
self._log_header()
self._log.date(True)
csobservation._init_csobservation = _init_csobservation
# Define an iterator over all observations
def _unbinned_observations(self):
obs = self._first_unbinned_observation()
while obs != None:
yield obs
obs = self._next_unbinned_observation()
ctool._unbinned_observations = _unbinned_observations
cscript._unbinned_observations = _unbinned_observations
%}