LSSTApplications  16.0-10-g0ee56ad+5,16.0-11-ga33d1f2+5,16.0-12-g3ef5c14+3,16.0-12-g71e5ef5+18,16.0-12-gbdf3636+3,16.0-13-g118c103+3,16.0-13-g8f68b0a+3,16.0-15-gbf5c1cb+4,16.0-16-gfd17674+3,16.0-17-g7c01f5c+3,16.0-18-g0a50484+1,16.0-20-ga20f992+8,16.0-21-g0e05fd4+6,16.0-21-g15e2d33+4,16.0-22-g62d8060+4,16.0-22-g847a80f+4,16.0-25-gf00d9b8+1,16.0-28-g3990c221+4,16.0-3-gf928089+3,16.0-32-g88a4f23+5,16.0-34-gd7987ad+3,16.0-37-gc7333cb+2,16.0-4-g10fc685+2,16.0-4-g18f3627+26,16.0-4-g5f3a788+26,16.0-5-gaf5c3d7+4,16.0-5-gcc1f4bb+1,16.0-6-g3b92700+4,16.0-6-g4412fcd+3,16.0-6-g7235603+4,16.0-69-g2562ce1b+2,16.0-8-g14ebd58+4,16.0-8-g2df868b+1,16.0-8-g4cec79c+6,16.0-8-gadf6c7a+1,16.0-8-gfc7ad86,16.0-82-g59ec2a54a+1,16.0-9-g5400cdc+2,16.0-9-ge6233d7+5,master-g2880f2d8cf+3,v17.0.rc1
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.