GEvent.hpp
4.47 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
/***************************************************************************
* GEvent.hpp - Abstract event base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2013 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 GEvent.hpp
* @brief Abstract event base class definition
* @author Juergen Knoedlseder
*/
#ifndef GEVENT_HPP
#define GEVENT_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GInstDir.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
/***********************************************************************//**
* @class GEvent
*
* @brief Abstract interface for the event classes.
*
* This class provides an abstract interface to an event. An event can be
* either a physical event occurring in the instrument (called an event
* atom) or a collection of events with similar properties (called an
* event bin). While event atoms are used for unbinned analysis, event bins
* are used for binned analysis. The methods is_atom() and is_bin() inform
* whether an event is an atom or a bin.
*
* 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 counts and the
* error in this number for each event. For event atoms the number of
* counts is 1 and the error is 0. The event bins, the number of counts
* is the number of events within a bin, and error is the uncertainty in
* this number (typically the square root of the number, yet also other
* schemes may be implemented).
*
* 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. For event atoms this
* quantity is by definition 1. For event bins, the size is the solid
* angle of the event bin times the energy width times the ontime interval
* covered by the events.
*
* The GEvent class does not hold any data members. Data members are stored
* in the derived classes.
***************************************************************************/
class GEvent : public GBase {
public:
// Constructors and destructors
GEvent(void);
GEvent(const GEvent& event);
virtual ~GEvent(void);
// Operators
virtual GEvent& operator=(const GEvent& event);
// 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 bool is_atom(void) const = 0;
virtual bool is_bin(void) const = 0;
virtual std::string print(const GChatter& chatter = NORMAL) const = 0;
protected:
// Protected methods
void init_members(void);
void copy_members(const GEvent& event);
void free_members(void);
};
#endif /* GEVENT_HPP */