GModels.hpp
4.07 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
/***************************************************************************
* GModels.hpp - Model container class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2012 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 GModels.hpp
* @brief Model container class definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELS_HPP
#define GMODELS_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GOptimizerPars.hpp"
#include "GModel.hpp"
#include "GXml.hpp"
/* __ Forward declarations _______________________________________________ */
class GEvent;
class GObservation;
/***********************************************************************//**
* @class GModels
*
* @brief Model container class
*
* This container class collects models of gamma-ray data that are used
* for maximum likelihood fitting. It derives from the optimizer parameter
* class GOptimizerPars.
*
* @todo Add extend method to append a container to the container
* @todo Add insert method to insert a model into the container
* @todo Add pop method to delete a model from the container (default: last)
***************************************************************************/
class GModels : public GOptimizerPars {
public:
// Constructors and destructors
GModels(void);
GModels(const GModels& models);
explicit GModels(const std::string& filename);
virtual ~GModels(void);
// Operators
GModels& operator=(const GModels& models);
GModel* operator[](const int& index);
const GModel* operator[](const int& index) const;
GModel* operator[](const std::string& name);
const GModel* operator[](const std::string& name) const;
// Methods
void clear(void);
GModels* clone(void) const;
int size(void) const { return m_models.size(); }
void append(const GModel& model);
void set(const int& index, const GModel& model);
void set(const std::string& name, const GModel& model);
void load(const std::string& filename);
void save(const std::string& filename) const;
void read(const GXml& xml);
void write(GXml& xml) const;
double eval(const GEvent& event, const GObservation& obs) const;
double eval_gradients(const GEvent& event, const GObservation& obs) const;
std::string print(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GModels& models);
void free_members(void);
void set_pointers(void);
int get_index(const std::string& name) const;
// Proteced members
std::vector<GModel*> m_models; //!< List of models
};
#endif /* GMODELS_HPP */