GSkyRegionMap.hpp
4.26 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
/***************************************************************************
* GSkyRegionMap.hpp - sky map region class *
* ----------------------------------------------------------------------- *
* copyright (C) 2013 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 GSkyRegionMap.hpp
* @brief Circular sky region class interface definition
* @author Pierrick Martin and Anneli Schulz
*/
#ifndef GSKYREGIONMAP_HPP
#define GSKYREGIONMAP_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include <string>
#include "GMath.hpp"
#include "GSkyDir.hpp"
#include "GSkyRegion.hpp"
#include "GSkyRegions.hpp"
#include "GFits.hpp"
#include "GSkymap.hpp"
#include "GSkyRegionCircle.hpp"
/***********************************************************************//**
* @class GSkyRegionMap
*
* @brief Interface for a sky region in the form of a map
*
* This class provides an implementation for a sky region defined by a skymap.
* The map is provided as a FITS file filled with 0 and 1 (or non-zero) values.
*
***************************************************************************/
class GSkyRegionMap : public GSkyRegion {
public:
// Constructors and destructors
GSkyRegionMap(void);
GSkyRegionMap(const GFits& file);
GSkyRegionMap(const GFitsHDU& hdu);
GSkyRegionMap(const GSkymap& map);
GSkyRegionMap(const GSkyRegionMap& region);
virtual ~GSkyRegionMap(void);
// Operators
GSkyRegionMap& operator=(const GSkyRegionMap& region);
// Implemented methods
void clear(void);
GSkyRegionMap* clone(void) const;
void load(const GFits& file);
void load(const std::string& filename);
void read(const GFitsHDU& hdu);
void map(const GSkymap& map);
const GSkymap& map(void) const;
bool contains(const GSkyDir& dir) const;
bool contains(const GSkyRegion& reg) const;
bool overlaps(const GSkyRegion& reg) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
std::string write(void) const;
virtual void read(const std::string& regstring);
void read_healpix(const GFitsTable& table);
void read_wcs(const GFitsImage& image);
protected:
// Protected methods
void init_members(void);
void copy_members(const GSkyRegionMap& region);
void free_members(void);
void compute_solid_angle(void);
void get_array_nonzero(std::vector<int> pix_array) const;
// Protected members
GSkymap m_map; //!< The map
GSkyPixel dir2pix(const GSkyDir& dir) const;
};
/***********************************************************************//**
* @brief Set sky map region
*
* @return region sky map.
*
* Sets the sky map region.
***************************************************************************/
inline
const GSkymap& GSkyRegionMap::map(void) const
{
return (m_map);
}
#endif /* GSKYREGIONMAP_HPP */