GEventBin.i
3.83 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
/***************************************************************************
* GEventBin.i - Abstract event bin base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2013 by Jurgen Knodlseder *
* ----------------------------------------------------------------------- *
* *
* 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 GEventBin.i
* @brief Abstract event bin base class definition
* @author Juergen Knoedlseder
*/
%{
/* Put headers and other declarations here that are needed for compilation */
#include "GEventBin.hpp"
%}
/***********************************************************************//**
* @class GEventBin
*
* @brief Abstract event bin class.
*
* An event bin is a collection of event atoms with similar properties.
* Event bins are used for binned analysis.
*
* Each event has 3 attributes: energy, instrument direction and time.
* These attributes can be accessed and changed through the energy(),
* dir(), and time() methods.
*
* The counts() and error() methods return the number of events within an
* event bin and the uncertainty in this number, which by default is
* given by the square root of the number of events (this is the default
* implementation provided by this class).
*
* The size() method returns the size of an event bin, which is the
* quantity that has to be multiplied by the probability for an event to
* occur to predict the number of events in a bin). The size is the solid
* angle of the event bin times the energy width times the ontime interval
* covered by the events.
*
* The GEventBin class does not hold any data members. Data members are
* stored in the derived classes.
***************************************************************************/
class GEventBin : public GEvent {
public:
// Constructors and destructors
GEventBin(void);
GEventBin(const GEventBin& bin);
virtual ~GEventBin(void);
// Pure virtual methods
virtual void clear(void) = 0;
virtual GEvent* clone(void) const = 0;
virtual double size(void) const = 0;
virtual const GInstDir& dir(void) const = 0;
virtual const GEnergy& energy(void) const = 0;
virtual const GTime& time(void) const = 0;
virtual double counts(void) const = 0;
virtual double error(void) const = 0;
virtual void counts(const double& counts) = 0;
// Other methods
bool is_atom(void) const;
bool is_bin(void) const;
};
/***********************************************************************//**
* @brief GEventBin class extension
***************************************************************************/
%extend GEventBin {
};