GSkyRegionRect.hpp
9.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
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/***************************************************************************
* GSkyRegionRect.hpp - rectangular sky region class *
* ----------------------------------------------------------------------- *
* copyright (C) 2019-2020 by Andreas Specovius *
* ----------------------------------------------------------------------- *
* *
* 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 GSkyRegionRect.hpp
* @brief Rectangular sky region class interface definition
* @author Andreas Specovius
*/
#ifndef GSKYREGIONRECT_HPP
#define GSKYREGIONRECT_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include <string>
#include "GSkyDir.hpp"
#include "GSkyRegion.hpp"
/* __ Forward declarations _______________________________________________ */
/***********************************************************************//**
* @class GSkyRegionRect
*
* @brief Interface for the rectangular sky region class
*
* This class provides an implementation for a rectangular 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 class holds several properties such as solid angle subtended by the
* region and computed through internal method compute_solid().
*
* The position angle counts counter-clockwise from celestial North and is
* aligned with the height axis of the rectangle. Note, that height and width
* describe the diameter of the region.
*
* Sky directions can be transformed to the local/global coordinate system via
* the methods transform_to_local() / transform_to_global().
* The position (in global coordinates) of the 4 corners of the rectangle can
* be received via the method get_corner(index).
*
***************************************************************************/
class GSkyRegionRect : public GSkyRegion {
public:
// Constructors and destructors
GSkyRegionRect(void);
GSkyRegionRect(const GSkyDir& centre,
const double& width,
const double& height,
const double& posang);
GSkyRegionRect(const double& ra,
const double& dec,
const double& width,
const double& height,
const double& posang);
explicit GSkyRegionRect(const std::string& line);
GSkyRegionRect(const GSkyRegionRect& region);
virtual ~GSkyRegionRect(void);
// Operators
GSkyRegionRect& operator=(const GSkyRegionRect& region);
// Implemented methods
void clear(void);
GSkyRegionRect* clone(void) const;
std::string classname(void) const;
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;
const double& width(void) const;
void width(const double& width);
const double& height(void) const;
void height(const double& height);
const double& posang(void) const;
void posang(const double& posang);
void read(const std::string& line);
std::string write(void) const;
bool contains(const GSkyDir& dir) const;
bool contains_local(const GSkyDir& locdir) const;
bool contains(const GSkyRegion& reg) const;
bool overlaps(const GSkyRegion& reg) const;
GSkyDir transform_to_local(const GSkyDir& skydir) const;
GSkyDir transform_to_global(const GSkyDir& locdir) const;
GSkyDir get_corner(const int& index) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GSkyRegionRect& region);
void free_members(void);
void compute_solid_angle(void);
// Protected members
GSkyDir m_centre; //!< Centre or reference point of the region
double m_width; //!< Width of the region (degrees)
double m_height; //!< Height of the region (degrees)
double m_posang; //!< Position angle, counterclockwise from North (degrees)
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GSkyRegionRect").
***************************************************************************/
inline
std::string GSkyRegionRect::classname(void) const
{
return ("GSkyRegionRect");
}
/***********************************************************************//**
* @brief Return rectangular region centre
*
* @return Region centre.
*
* Returns the region centre.
***************************************************************************/
inline
const GSkyDir& GSkyRegionRect::centre(void) const
{
return (m_centre);
}
/***********************************************************************//**
* @brief Set rectangular region centre
*
* @param[in] dir Region centre.
*
* Sets the centre of the rectangular region to the specified sky direction.
***************************************************************************/
inline
void GSkyRegionRect::centre(const GSkyDir& dir)
{
m_centre = dir;
return;
}
/***********************************************************************//**
* @brief Set rectangular region centre Right Ascension and Declincation
*
* @param[in] ra Right Ascension (degrees).
* @param[in] dec Declination (degrees).
*
* Sets the centre of the rectangular region to the specified Right Ascension
* and Declination.
***************************************************************************/
inline
void GSkyRegionRect::centre(const double& ra, const double& dec)
{
m_centre.radec_deg(ra, dec);
return;
}
/***********************************************************************//**
* @brief Return rectangular region centre Right Ascension
*
* @return Region centre Right Ascension (degrees).
*
* Returns the region centre Right Ascension in degrees.
***************************************************************************/
inline
double GSkyRegionRect::ra(void) const
{
return (m_centre.ra_deg());
}
/***********************************************************************//**
* @brief Return rectangular region centre Declination
*
* @return Region centre Declination (degrees).
*
* Returns the region centre Declination in degrees.
***************************************************************************/
inline
double GSkyRegionRect::dec(void) const
{
return (m_centre.dec_deg());
}
/***********************************************************************//**
* @brief Return region width extension (in degrees)
*
* @return Region width (degrees).
*
* Returns the region width extension in degrees.
***************************************************************************/
inline
const double& GSkyRegionRect::width(void) const
{
return (m_width);
}
/***********************************************************************//**
* @brief Return region height extension (in degrees)
*
* @return Region height (degrees).
*
* Returns the region height extension in degrees.
***************************************************************************/
inline
const double& GSkyRegionRect::height(void) const
{
return (m_height);
}
/***********************************************************************//**
* @brief Return region position angle (in degrees)
*
* @return Region position angle (degrees).
*
* Returns the region position angle in degrees. The position angle is
* counted counterclockwise from North.
***************************************************************************/
inline
const double& GSkyRegionRect::posang(void) const
{
return (m_posang);
}
/***********************************************************************//**
* @brief Set position angle of rectangular region
*
* @param[in] posang Position angle (degrees).
*
* Sets the position angle of the rectangular sky region. The position angle
* is counted counterclockwise from celestial North and is aligned to the
* rectangle height.
***************************************************************************/
inline
void GSkyRegionRect::posang(const double& posang)
{
m_posang = posang;
return;
}
#endif /* GSKYREGIONRECT_HPP */