Coverage for python/lsst/dax/apdb/pixelization.py: 23%

31 statements  

« prev     ^ index     » next       coverage.py v7.3.3, created at 2023-12-20 17:15 +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/>. 

21 

22from __future__ import annotations 

23 

24__all__ = ["Pixelization"] 

25 

26import logging 

27 

28from lsst import sphgeom 

29 

30_LOG = logging.getLogger(__name__) 

31 

32 

33class Pixelization: 

34 """Wrapper for pixelization classes from `sphgeom` with configurable 

35 pixelization type and parameters. 

36 

37 Parameters 

38 ---------- 

39 pixelization : `str` 

40 Name of a pixelization type, one of ""htm", "q3c", or "mq3c" 

41 pix_level : `int` 

42 Pixelization level. 

43 pix_max_ranges : `int` 

44 Maximum number of ranges returned from `envelope()` method. 

45 """ 

46 

47 def __init__(self, pixelization: str, pix_level: int, pix_max_ranges: int): 

48 if pixelization == "htm": 

49 self.pixelator = sphgeom.HtmPixelization(pix_level) 

50 elif pixelization == "q3c": 

51 self.pixelator = sphgeom.Q3cPixelization(pix_level) 

52 elif pixelization == "mq3c": 

53 self.pixelator = sphgeom.Mq3cPixelization(pix_level) 

54 else: 

55 raise ValueError(f"unknown pixelization: {pixelization}") 

56 self._pix_max_ranges = pix_max_ranges 

57 

58 def pixels(self, region: sphgeom.Region) -> list[int]: 

59 """Compute set of the pixel indices for given region. 

60 

61 Parameters 

62 ---------- 

63 region : `lsst.sphgeom.Region` 

64 """ 

65 # we want finest set of pixels, so ask as many pixel as possible 

66 ranges = self.pixelator.envelope(region, 1_000_000) 

67 indices = [] 

68 for lower, upper in ranges: 

69 indices += list(range(lower, upper)) 

70 return indices 

71 

72 def pixel(self, direction: sphgeom.UnitVector3d) -> int: 

73 """Compute the index of the pixel for given direction. 

74 

75 Parameters 

76 ---------- 

77 direction : `lsst.sphgeom.UnitVector3d` 

78 """ 

79 index = self.pixelator.index(direction) 

80 return index 

81 

82 def envelope(self, region: sphgeom.Region) -> list[tuple[int, int]]: 

83 """Generate a set of HTM indices covering specified region. 

84 

85 Parameters 

86 ---------- 

87 region: `sphgeom.Region` 

88 Region that needs to be indexed. 

89 

90 Returns 

91 ------- 

92 ranges : `list` of `tuple` 

93 Sequence of ranges, range is a tuple (minHtmID, maxHtmID). 

94 """ 

95 _LOG.debug("region: %s", region) 

96 indices = self.pixelator.envelope(region, self._pix_max_ranges) 

97 

98 if _LOG.isEnabledFor(logging.DEBUG): 

99 for irange in indices.ranges(): 

100 _LOG.debug( 

101 "range: %s %s", 

102 self.pixelator.toString(irange[0]), 

103 self.pixelator.toString(irange[1]), 

104 ) 

105 

106 return indices.ranges()