LSSTApplications  18.1.0
LSSTDataManagementBasePackage
Pixelization.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_PIXELIZATION_H_
24 #define LSST_SPHGEOM_PIXELIZATION_H_
25 
28 
29 #include <string>
30 
31 #include "RangeSet.h"
32 
33 
34 namespace lsst {
35 namespace sphgeom {
36 
37 class Region;
38 class UnitVector3d;
39 
40 
77 class Pixelization {
78 public:
79  virtual ~Pixelization() {}
80 
82  virtual RangeSet universe() const = 0;
83 
94  virtual std::unique_ptr<Region> pixel(uint64_t i) const = 0;
95 
97  virtual uint64_t index(UnitVector3d const & v) const = 0;
98 
100  virtual std::string toString(uint64_t i) const = 0;
101 
131  RangeSet envelope(Region const & r, size_t maxRanges = 0) const {
132  return _envelope(r, maxRanges);
133  }
134 
143  RangeSet interior(Region const & r, size_t maxRanges = 0) const {
144  return _interior(r, maxRanges);
145  }
146 
147 private:
148  virtual RangeSet _envelope(Region const & r, size_t maxRanges) const = 0;
149  virtual RangeSet _interior(Region const & r, size_t maxRanges) const = 0;
150 };
151 
152 }} // namespace lsst::sphgeom
153 
154 #endif // LSST_SPHGEOM_PIXELIZATION_H_
RangeSet envelope(Region const &r, size_t maxRanges=0) const
envelope returns the indexes of the pixels intersecting the spherical region r.
Definition: Pixelization.h:131
STL class.
virtual uint64_t index(UnitVector3d const &v) const =0
index computes the index of the pixel for v.
A base class for image defects.
This file provides a type for representing integer sets.
virtual RangeSet universe() const =0
universe returns the set of all pixel indexes for this pixelization.
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition: Region.h:79
virtual std::unique_ptr< Region > pixel(uint64_t i) const =0
pixel returns the spherical region corresponding to the pixel with index i.
RangeSet interior(Region const &r, size_t maxRanges=0) const
interior returns the indexes of the pixels within the spherical region r.
Definition: Pixelization.h:143
A Pixelization (or partitioning) of the sphere is a mapping between points on the sphere and a set of...
Definition: Pixelization.h:77
STL class.
A RangeSet is a set of unsigned 64 bit integers.
Definition: RangeSet.h:99
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
Definition: UnitVector3d.h:55
virtual std::string toString(uint64_t i) const =0
toString converts the given pixel index to a human-readable string.