LSSTApplications  20.0.0
LSSTDataManagementBasePackage
HtmPixelization.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_HTMPIXELIZATION_H_
24 #define LSST_SPHGEOM_HTMPIXELIZATION_H_
25 
29 
30 #include <cstdint>
31 #include <stdexcept>
32 
33 #include "ConvexPolygon.h"
34 #include "Pixelization.h"
35 
36 
37 namespace lsst {
38 namespace sphgeom {
39 
50 class HtmPixelization : public Pixelization {
51 public:
53  static constexpr int MAX_LEVEL = 24;
54 
58  static int level(uint64_t i);
59 
63  static ConvexPolygon triangle(uint64_t i);
64 
76  static std::string asString(uint64_t i);
77 
81  explicit HtmPixelization(int level);
82 
84  int getLevel() const { return _level; }
85 
86  RangeSet universe() const override {
87  return RangeSet(static_cast<uint64_t>(8) << 2 * _level,
88  static_cast<uint64_t>(16) << 2 * _level);
89  }
90 
91  std::unique_ptr<Region> pixel(uint64_t i) const override {
93  }
94 
95  uint64_t index(UnitVector3d const &) const override;
96 
97  std::string toString(uint64_t i) const override { return asString(i); }
98 
99 private:
100  int _level;
101 
102  RangeSet _envelope(Region const &, size_t) const override;
103  RangeSet _interior(Region const &, size_t) const override;
104 };
105 
106 }} // namespace lsst::sphgeom
107 
108 #endif // LSST_SPHGEOM_HTMPIXELIZATION_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
std::string
STL class.
lsst::sphgeom::Region
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition: Region.h:79
lsst::sphgeom::HtmPixelization::universe
RangeSet universe() const override
universe returns the set of all pixel indexes for this pixelization.
Definition: HtmPixelization.h:86
lsst::sphgeom::HtmPixelization::level
static int level(uint64_t i)
level returns the subdivision level of the given HTM index.
Definition: HtmPixelization.cc:110
lsst::sphgeom::HtmPixelization::index
uint64_t index(UnitVector3d const &) const override
index computes the index of the pixel for v.
Definition: HtmPixelization.cc:170
lsst::sphgeom::HtmPixelization::toString
std::string toString(uint64_t i) const override
toString converts the given pixel index to a human-readable string.
Definition: HtmPixelization.h:97
lsst::sphgeom::HtmPixelization
HtmPixelization provides HTM indexing of points and regions.
Definition: HtmPixelization.h:50
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::HtmPixelization::getLevel
int getLevel() const
getLevel returns the subdivision level of this pixelization.
Definition: HtmPixelization.h:84
lsst::sphgeom::HtmPixelization::asString
static std::string asString(uint64_t i)
asString converts the given HTM index to a human readable string.
Definition: HtmPixelization.cc:148
lsst::sphgeom::HtmPixelization::triangle
static ConvexPolygon triangle(uint64_t i)
triangle returns the triangle corresponding to the given HTM index.
Definition: HtmPixelization.cc:123
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::sphgeom::HtmPixelization::pixel
std::unique_ptr< Region > pixel(uint64_t i) const override
pixel returns the spherical region corresponding to the pixel with index i.
Definition: HtmPixelization.h:91
lsst::sphgeom::HtmPixelization::HtmPixelization
HtmPixelization(int level)
This constructor creates an HTM pixelization of the sphere with the given subdivision level.
Definition: HtmPixelization.cc:164
lsst::sphgeom::HtmPixelization::MAX_LEVEL
static constexpr int MAX_LEVEL
MAX_LEVEL is the maximum supported HTM subdivision level.
Definition: HtmPixelization.h:53
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...