GModelSpatialRadialRing.i
5.02 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
/***************************************************************************
* GModelSpatialRadialRing.i - Radial disk source model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2020-2022 by Pierrick Martin *
* ----------------------------------------------------------------------- *
* *
* 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 GModelSpatialRadialRing.i
* @brief Radial ring model class Python interface definition
* @author Pierrick Martin
*/
%{
/* Put headers and other declarations here that are needed for compilation */
#include "GModelSpatialRadialRing.hpp"
%}
/***************************************************************************
* @class GModelSpatialRadialRing
*
* @brief Ring source model class
*
* This class implements the spatial component of the factorised source model
* model for a ring source, i.e. constant surface brightness starting from a
* given radius and an outer radius, and no emission elsewhere.
***************************************************************************/
class GModelSpatialRadialRing : public GModelSpatialRadial {
public:
// Constructors and destructors
GModelSpatialRadialRing(void);
GModelSpatialRadialRing(const GSkyDir& dir,
const double& radius,
const double& width,
const std::string& coordsys = "CEL");
explicit GModelSpatialRadialRing(const GXmlElement& xml);
GModelSpatialRadialRing(const GModelSpatialRadialRing& model);
virtual ~GModelSpatialRadialRing(void);
// Implemented pure virtual methods
virtual void clear(void);
virtual GModelSpatialRadialRing* clone(void) const;
virtual std::string classname(void) const;
virtual double eval(const double& theta,
const GEnergy& energy,
const GTime& time,
const bool& gradients = false) const;
virtual GSkyDir mc(const GEnergy& energy,
const GTime& time,
GRan& ran) const;
virtual bool contains(const GSkyDir& dir,
const double& margin = 0.0) const;
virtual double theta_min(void) const;
virtual double theta_max(void) const;
virtual void read(const GXmlElement& xml);
virtual void write(GXmlElement& xml) const;
// Other methods
double radius(void) const;
void radius(const double& radius);
double width(void) const;
void width(const double& width);
};
/***********************************************************************//**
* @brief GModelSpatialRadialRing class extension
*
* The eval(GPhoton&, bool&) method need to be defined in the extension to
* force swig to build also the interface for these methods that are
* implemented in the base class only. It's not clear to me why these
* methods are not inherited automatically. Maybe this could also be handled
* by a %typemap(typecheck) construct.
***************************************************************************/
%extend GModelSpatialRadialRing {
GModelSpatialRadialRing copy() {
return (*self);
}
double eval(const GPhoton& photon) const {
return self->GModelSpatialRadial::eval(photon);
}
double eval(const GPhoton& photon, const bool& gradients) const {
return self->GModelSpatialRadial::eval(photon, gradients);
}
%pythoncode {
def __getstate__(self):
xml = gammalib.GXmlElement()
self.write(xml)
state = (xml,)
return state
def __setstate__(self, state):
self.__init__(state[0])
}
};