LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Q3cPixelization.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2016 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #ifndef LSST_SPHGEOM_Q3CPIXELIZATION_H_
24 #define LSST_SPHGEOM_Q3CPIXELIZATION_H_
25 
29 
30 #include <cstdint>
31 #include <vector>
32 
33 #include "ConvexPolygon.h"
34 #include "Pixelization.h"
35 
36 
37 namespace lsst {
38 namespace sphgeom {
39 
50 class Q3cPixelization : public Pixelization {
51 public:
53  static constexpr int MAX_LEVEL = 30;
54 
58  explicit Q3cPixelization(int level);
59 
61  int getLevel() const { return _level; }
62 
67  ConvexPolygon quad(uint64_t i) const;
68 
75  std::vector<uint64_t> neighborhood(uint64_t i) const;
76 
77  RangeSet universe() const override {
78  return RangeSet(0, static_cast<uint64_t>(6) << 2 * _level);
79  }
80 
81  std::unique_ptr<Region> pixel(uint64_t i) const override;
82 
83  uint64_t index(UnitVector3d const & v) const override;
84 
95  std::string toString(uint64_t i) const override;
96 
97 private:
98  int _level;
99 
100  RangeSet _envelope(Region const & r, size_t maxRanges) const override;
101  RangeSet _interior(Region const & r, size_t maxRanges) const override;
102 };
103 
104 }} // namespace lsst::sphgeom
105 
106 #endif // LSST_SPHGEOM_Q3CPIXELIZATION_H_
lsst::sphgeom::Pixelization
A Pixelization (or partitioning) of the sphere is a mapping between points on the sphere and a set of...
Definition: Pixelization.h:77
lsst::sphgeom::Q3cPixelization::neighborhood
std::vector< uint64_t > neighborhood(uint64_t i) const
neighborhood returns the indexes of all pixels that share a vertex with pixel i (including i itself).
Definition: Q3cPixelization.cc:271
lsst::sphgeom::Q3cPixelization::toString
std::string toString(uint64_t i) const override
toString converts the given Q3C index to a human readable string.
Definition: Q3cPixelization.cc:280
std::string
STL class.
lsst::sphgeom::Q3cPixelization::pixel
std::unique_ptr< Region > pixel(uint64_t i) const override
pixel returns the spherical region corresponding to the pixel with index i.
Definition: Q3cPixelization.cc:301
lsst::sphgeom::Region
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition: Region.h:79
lsst::sphgeom::Q3cPixelization::quad
ConvexPolygon quad(uint64_t i) const
quad returns the quadrilateral corresponding to the Q3C pixel with index i.
Definition: Q3cPixelization.cc:262
lsst::sphgeom::Q3cPixelization::MAX_LEVEL
static constexpr int MAX_LEVEL
The maximum supported cube-face grid resolution is 2^30 by 2^30.
Definition: Q3cPixelization.h:53
std::vector< uint64_t >
lsst::sphgeom::Q3cPixelization::index
uint64_t index(UnitVector3d const &v) const override
index computes the index of the pixel for v.
Definition: Q3cPixelization.cc:312
lsst::sphgeom::UnitVector3d
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
Definition: UnitVector3d.h:55
lsst::sphgeom::ConvexPolygon
ConvexPolygon is a closed convex polygon on the unit sphere.
Definition: ConvexPolygon.h:57
lsst::sphgeom::Q3cPixelization::universe
RangeSet universe() const override
universe returns the set of all pixel indexes for this pixelization.
Definition: Q3cPixelization.h:77
lsst::sphgeom::Q3cPixelization
Q3cPixelization provides Q3C indexing of points and regions.
Definition: Q3cPixelization.h:50
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::sphgeom::Q3cPixelization::getLevel
int getLevel() const
getLevel returns the subdivision level of this pixelization.
Definition: Q3cPixelization.h:61
lsst::sphgeom::RangeSet
A RangeSet is a set of unsigned 64 bit integers.
Definition: RangeSet.h:99
Pixelization.h
This file defines an interface for pixelizations of the sphere.
std::unique_ptr
STL class.
ConvexPolygon.h
This file declares a class for representing convex polygons with great circle edges on the unit spher...
lsst::sphgeom::Q3cPixelization::Q3cPixelization
Q3cPixelization(int level)
This constructor creates a Q3C pixelization of the sphere with the given subdivision level.
Definition: Q3cPixelization.cc:256