GSkyRegionRing.hpp
7.04 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
/***************************************************************************
* GSkyRegionRing.hpp - Ring sky region class *
* ----------------------------------------------------------------------- *
* copyright (C) 2013 by Maria Krause, Anneli Schulz *
* ----------------------------------------------------------------------- *
* *
* 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 GSkyRegionRing.hpp
* @brief Ring sky region class interface definition
* @author Maria Krause, Anneli Schulz
*/
#ifndef GSKYREGIONRING_HPP
#define GSKYREGIONRING_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include <string>
#include "GMath.hpp"
#include "GSkyDir.hpp"
#include "GSkyRegion.hpp"
/***********************************************************************//**
* @class GSkyRegionRing
*
* @brief Interface for the Ring 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 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 ?
*
***************************************************************************/
class GSkyRegionRing : public GSkyRegion {
public:
// Constructors and destructors
GSkyRegionRing(void);
GSkyRegionRing(GSkyDir& centre, const double& radius1, const double& radius2);
GSkyRegionRing(const double& ra, const double& dec, const double& radius1, const double& radius2);
explicit GSkyRegionRing(const std::string& line);
GSkyRegionRing(const GSkyRegionRing& region);
virtual ~GSkyRegionRing(void);
// Operators
GSkyRegionRing& operator=(const GSkyRegionRing& region);
// Implemented methods
void clear(void);
GSkyRegionRing* clone(void) const;
const double& radius1(void) const;
void radius1(const double& radius1);
const double& radius2(void) const;
void radius2(const double& radius2);
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 GSkyRegionRing& region);
void free_members(void);
void compute_solid_angle(void);
// Protected members
GSkyDir m_centre; //!< Centre or reference point of the region
double m_radius1; //!< Radius of inner ring the region [deg]
double m_radius2; //!< Radius of outer ring the region [deg]
};
/***********************************************************************//**
* @brief Return ring region inner (radius1) and outer (radius2) region (in degrees)
*
* @return Region radius [deg].
*
* Returns the region radius in degrees.
***************************************************************************/
inline
const double& GSkyRegionRing::radius1(void) const
{
return (m_radius1);
}
inline
const double& GSkyRegionRing::radius2(void) const
{
return (m_radius2);
}
/***********************************************************************//**
* @brief Return circular region centre
*
* @return Region centre.
*
* Returns the region centre.
***************************************************************************/
inline
const GSkyDir& GSkyRegionRing::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 GSkyRegionRing::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 GSkyRegionRing::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 GSkyRegionRing::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 GSkyRegionRing::dec(void) const
{
return (m_centre.dec_deg());
}
#endif /* GSKYREGIONRing_HPP */