Coverage for python/lsst/dax/apdb/pixelization.py: 25%
32 statements
« prev ^ index » next coverage.py v7.2.7, created at 2023-06-22 09:47 +0000
« prev ^ index » next coverage.py v7.2.7, created at 2023-06-22 09:47 +0000
1# This file is part of dax_apdb.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <http://www.gnu.org/licenses/>.
22from __future__ import annotations
24__all__ = ["Pixelization"]
26import logging
27from typing import List, Tuple
29from lsst import sphgeom
31_LOG = logging.getLogger(__name__)
34class Pixelization:
35 """Wrapper for pixelization classes from `sphgeom` with configurable
36 pixelization type and parameters.
38 Parameters
39 ----------
40 pixelization : `str`
41 Name of a pixelization type, one of ""htm", "q3c", or "mq3c"
42 pix_level : `int`
43 Pixelization level.
44 pix_max_ranges : `int`
45 Maximum number of ranges returned from `envelope()` method.
46 """
48 def __init__(self, pixelization: str, pix_level: int, pix_max_ranges: int):
49 if pixelization == "htm":
50 self.pixelator = sphgeom.HtmPixelization(pix_level)
51 elif pixelization == "q3c":
52 self.pixelator = sphgeom.Q3cPixelization(pix_level)
53 elif pixelization == "mq3c":
54 self.pixelator = sphgeom.Mq3cPixelization(pix_level)
55 else:
56 raise ValueError(f"unknown pixelization: {pixelization}")
57 self._pix_max_ranges = pix_max_ranges
59 def pixels(self, region: sphgeom.Region) -> List[int]:
60 """Compute set of the pixel indices for given region.
62 Parameters
63 ----------
64 region : `lsst.sphgeom.Region`
65 """
66 # we want finest set of pixels, so ask as many pixel as possible
67 ranges = self.pixelator.envelope(region, 1_000_000)
68 indices = []
69 for lower, upper in ranges:
70 indices += list(range(lower, upper))
71 return indices
73 def pixel(self, direction: sphgeom.UnitVector3d) -> int:
74 """Compute the index of the pixel for given direction.
76 Parameters
77 ----------
78 direction : `lsst.sphgeom.UnitVector3d`
79 """
80 index = self.pixelator.index(direction)
81 return index
83 def envelope(self, region: sphgeom.Region) -> List[Tuple[int, int]]:
84 """Generate a set of HTM indices covering specified region.
86 Parameters
87 ----------
88 region: `sphgeom.Region`
89 Region that needs to be indexed.
91 Returns
92 -------
93 ranges : `list` of `tuple`
94 Sequence of ranges, range is a tuple (minHtmID, maxHtmID).
95 """
96 _LOG.debug("region: %s", region)
97 indices = self.pixelator.envelope(region, self._pix_max_ranges)
99 if _LOG.isEnabledFor(logging.DEBUG):
100 for irange in indices.ranges():
101 _LOG.debug(
102 "range: %s %s",
103 self.pixelator.toString(irange[0]),
104 self.pixelator.toString(irange[1]),
105 )
107 return indices.ranges()