LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Q3cPixelization
provides Q3C indexing of points and regions.
More...
#include <Q3cPixelization.h>
Public Member Functions | |
Q3cPixelization (int level) | |
This constructor creates a Q3C pixelization of the sphere with the given subdivision level. More... | |
int | getLevel () const |
getLevel returns the subdivision level of this pixelization. More... | |
ConvexPolygon | quad (uint64_t i) const |
quad returns the quadrilateral corresponding to the Q3C pixel with index i . More... | |
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). More... | |
RangeSet | universe () const override |
universe returns the set of all pixel indexes for this pixelization. More... | |
std::unique_ptr< Region > | pixel (uint64_t i) const override |
pixel returns the spherical region corresponding to the pixel with index i. More... | |
uint64_t | index (UnitVector3d const &v) const override |
index computes the index of the pixel for v. More... | |
std::string | toString (uint64_t i) const override |
toString converts the given Q3C index to a human readable string. More... | |
RangeSet | envelope (Region const &r, size_t maxRanges=0) const |
envelope returns the indexes of the pixels intersecting the spherical region r. More... | |
RangeSet | interior (Region const &r, size_t maxRanges=0) const |
interior returns the indexes of the pixels within the spherical region r. More... | |
Static Public Attributes | |
static constexpr int | MAX_LEVEL = 30 |
The maximum supported cube-face grid resolution is 2^30 by 2^30. More... | |
Q3cPixelization
provides Q3C indexing of points and regions.
Instances of this class are immutable and very cheap to copy.
maxRanges
argument for envelope() or interior() to a non-zero value below 4 can result in very poor region pixelizations regardless of region size. For instance, if maxRanges
is 1, a non-empty circle centered on an axis will be approximated by the indexes for an entire cube face, even as the circle radius tends to 0. Definition at line 50 of file Q3cPixelization.h.
|
explicit |
This constructor creates a Q3C pixelization of the sphere with the given subdivision level.
If level
∉ [0, MAX_LEVEL], a std::invalid_argument is thrown.
Definition at line 256 of file Q3cPixelization.cc.
|
inlineinherited |
envelope
returns the indexes of the pixels intersecting the spherical region r.
For hierarchical pixelizations, a good way to implement this is by top down tree traversal. Starting with the root pixels (e.g. Q3C cube faces, or HTM root triangles), a pixel P is tested for intersection with the region r. If P is already at the desired subdivision level and intersects r, its index is added to the output. If r contains P, the indexes of all children of P at the target subdivision level are output. Finally, if P intersects r, then P is subdivided and the algorithm recurses on its child pixels.
Using higher subdivision levels allows a region to be more closely approximated by smaller pixels, but for large input regions the cost of computing and storing their indexes can quickly become prohibitive.
The maxRanges
parameter can be used to limit both these costs - setting it to a non-zero value sets a cap on the number of ranges returned by this method. To meet this constraint, implementations are allowed to return pixels that do not intersect r along with those that do. This allows two ranges [a, b) and [c, d), a < b < c < d, to be merged into one range [a, d) (by adding in the pixels [b, c)). Since simplification proceeds by adding pixels, the return value will always be a superset of the intersecting pixels.
In practice, the implementation of this method for a hierarchical pixelization like Q3C or HTM will lower the subdivision level when too many ranges have been found. Each coarse pixel I at level L - n corresponds to pixels [I*4ⁿ, (I + 1)*4ⁿ) at level L.
Definition at line 131 of file Pixelization.h.
|
inline |
getLevel
returns the subdivision level of this pixelization.
Definition at line 61 of file Q3cPixelization.h.
|
overridevirtual |
index
computes the index of the pixel for v.
Implements lsst::sphgeom::Pixelization.
Definition at line 312 of file Q3cPixelization.cc.
|
inlineinherited |
interior
returns the indexes of the pixels within the spherical region r.
The maxRanges
argument is analogous to the identically named envelope() argument. The only difference is that implementations must remove interior pixels to keep the number of ranges at or below the maximum. The return value is therefore always a subset of the interior pixels.
Definition at line 143 of file Pixelization.h.
std::vector< uint64_t > lsst::sphgeom::Q3cPixelization::neighborhood | ( | uint64_t | i | ) | const |
neighborhood
returns the indexes of all pixels that share a vertex with pixel i
(including i
itself).
A Q3C pixel has 8 - k adjacent pixels, where k is the number of vertices that are also root pixel vertices (0, 1, or 4).
If i
is not a valid Q3C index, a std::invalid_argument is thrown.
Definition at line 271 of file Q3cPixelization.cc.
|
overridevirtual |
pixel
returns the spherical region corresponding to the pixel with index i.
This region will contain all unit vectors v with index(v) == i
. But it may also contain points with index not equal to i. To see why, consider a point that lies on the edge of a polygonal pixel - it is inside the polygons for both pixels sharing the edge, but must be assigned to exactly one pixel by the pixelization.
If i is not a valid pixel index, a std::invalid_argument is thrown.
Implements lsst::sphgeom::Pixelization.
Definition at line 301 of file Q3cPixelization.cc.
ConvexPolygon lsst::sphgeom::Q3cPixelization::quad | ( | uint64_t | i | ) | const |
quad
returns the quadrilateral corresponding to the Q3C pixel with index i
.
If i
is not a valid Q3C index, a std::invalid_argument is thrown.
Definition at line 262 of file Q3cPixelization.cc.
|
overridevirtual |
toString
converts the given Q3C index to a human readable string.
The first two characters in the return value are always '+X', '+Y', '+Z', '-X', '-Y', or '-Z'. They give the normal vector of the cube face F containing i
. Each subsequent character is a digit in [0-3] corresponding to a child pixel index, so that reading the string from left to right corresponds to descent of the quad-tree overlaid on F.
If i is not a valid Q3C index, a std::invalid_argument is thrown.
Implements lsst::sphgeom::Pixelization.
Definition at line 280 of file Q3cPixelization.cc.
|
inlineoverridevirtual |
universe
returns the set of all pixel indexes for this pixelization.
Implements lsst::sphgeom::Pixelization.
Definition at line 77 of file Q3cPixelization.h.
|
staticconstexpr |
The maximum supported cube-face grid resolution is 2^30 by 2^30.
Definition at line 53 of file Q3cPixelization.h.