GRoi.hpp
3.06 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
/***************************************************************************
* GRoi.hpp - Abstract Region of interest base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2014 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 GRoi.hpp
* @brief Abstract Region of interest base class definition
* @author Juergen Knoedlseder
*/
#ifndef GROI_HPP
#define GROI_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
/* __ Forward declarations _______________________________________________ */
class GEvent;
/***********************************************************************//**
* @class GRoi
*
* @brief Interface for the region of interest classes
*
* The region of interest class holds instrument specific information about
* the spatial region in detector or telescopes coordinates that is used
* for an analysis. In particular, the definition of a region of interest
* is required for an unbinned analysis.
***************************************************************************/
class GRoi : public GBase {
// Friend classes
friend class GObservation;
public:
// Constructors and destructors
GRoi(void);
GRoi(const GRoi& roi);
virtual ~GRoi(void);
// Operators
virtual GRoi& operator=(const GRoi& roi);
// Pure virtual methods
virtual void clear(void) = 0;
virtual GRoi* clone(void) const = 0;
virtual std::string classname(void) const = 0;
virtual bool contains(const GEvent& event) const = 0;
virtual std::string print(const GChatter& chatter = NORMAL) const = 0;
protected:
// Protected methods
void init_members(void);
void copy_members(const GRoi& roi);
void free_members(void);
};
#endif /* GROI_HPP */