GSkyRegionCircle.hpp
7.44 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/***************************************************************************
* GSkyRegionCircle.hpp - circular sky region class *
* ----------------------------------------------------------------------- *
* copyright (C) 2013-2020 by Michael Mayer *
* ----------------------------------------------------------------------- *
* *
* 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 GSkyRegionCircle.hpp
* @brief Circular sky region class interface definition
* @author Michael Mayer
*/
#ifndef GSKYREGIONCIRCLE_HPP
#define GSKYREGIONCIRCLE_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include <string>
#include "GMath.hpp"
#include "GSkyDir.hpp"
#include "GSkyRegion.hpp"
/***********************************************************************//**
* @class GSkyRegionCircle
*
* @brief Interface for the circular sky region class
*
* This class provides an implementation for a circular sky region. The sky
* region is defined by an array of parameters, the meaning of which is
* specific to the derived class where the region type or shape is defined.
* The parameters are GModelPar objects for convenience.
*
* The class holds several properties such as solid angle subtended by the
* region and computed through internal method compute_solid().
*
* To be clarified:
* - Do we want a member relating the region to an observation run ?
* - Constructor and read/write using XML may not be needed if we use DS9
* region file format ?
* - Replace GModelPar by double for the parameters (GModelPar is overkill) ?
*
***************************************************************************/
class GSkyRegionCircle : public GSkyRegion {
// Operator friends
friend bool operator==(const GSkyRegionCircle &a, const GSkyRegionCircle &b);
friend bool operator!=(const GSkyRegionCircle &a, const GSkyRegionCircle &b);
public:
// Constructors and destructors
GSkyRegionCircle(void);
GSkyRegionCircle(const GSkyDir& centre, const double& radius);
GSkyRegionCircle(const double& ra, const double& dec, const double& radius);
explicit GSkyRegionCircle(const std::string& line);
GSkyRegionCircle(const GSkyRegionCircle& region);
virtual ~GSkyRegionCircle(void);
// Operators
GSkyRegionCircle& operator=(const GSkyRegionCircle& region);
// Implemented methods
void clear(void);
GSkyRegionCircle* clone(void) const;
std::string classname(void) const;
const double& radius(void) const;
void radius(const double& radius);
const GSkyDir& centre(void) const;
void centre(const GSkyDir& centre);
void centre(const double& ra,const double& dec);
double ra(void) const;
double dec(void) const;
void read(const std::string& line);
std::string write(void) const;
bool contains(const GSkyDir& dir) const;
bool contains(const GSkyRegion& reg) const;
bool overlaps(const GSkyRegion& reg) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GSkyRegionCircle& region);
void free_members(void);
void compute_solid_angle(void);
// Protected members
GSkyDir m_centre; //!< Centre or reference point of the region
double m_radius; //!< Radius of circular the region (degrees)
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GSkyRegionCircle").
***************************************************************************/
inline
std::string GSkyRegionCircle::classname(void) const
{
return ("GSkyRegionCircle");
}
/***********************************************************************//**
* @brief Return circular region radius (in degrees)
*
* @return Region radius [deg].
*
* Returns the region radius in degrees.
***************************************************************************/
inline
const double& GSkyRegionCircle::radius(void) const
{
return (m_radius);
}
/***********************************************************************//**
* @brief Return circular region centre
*
* @return Region centre.
*
* Returns the region centre.
***************************************************************************/
inline
const GSkyDir& GSkyRegionCircle::centre(void) const
{
return (m_centre);
}
/***********************************************************************//**
* @brief Set circular region centre
*
* @param[in] dir Region centre.
*
* Sets the centre of the circular region to the specified sky direction.
***************************************************************************/
inline
void GSkyRegionCircle::centre(const GSkyDir& dir)
{
// Set centre
m_centre = dir;
// Return
return;
}
/***********************************************************************//**
* @brief Set circular region centre Right Ascension and Declincation
*
* @param[in] ra Right Ascension [deg].
* @param[in] dec Declination [deg].
*
* Sets the centre of the circular region to the specified Right Ascension
* and Declination.
***************************************************************************/
inline
void GSkyRegionCircle::centre(const double& ra, const double& dec)
{
// Set centre values
m_centre.radec_deg(ra,dec);
// Return
return;
}
/***********************************************************************//**
* @brief Return circular region centre Right Ascension
*
* @return Region centre Right Ascension [deg].
*
* Returns the region centre Right Ascension in degrees.
***************************************************************************/
inline
double GSkyRegionCircle::ra(void) const
{
return (m_centre.ra_deg());
}
/***********************************************************************//**
* @brief Return circular region centre Declination
*
* @return Region centre Declination [deg].
*
* Returns the region centre Declination in degrees.
***************************************************************************/
inline
double GSkyRegionCircle::dec(void) const
{
return (m_centre.dec_deg());
}
#endif /* GSKYREGIONCIRCLE_HPP */