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

32 statements  

« prev     ^ index     » next       coverage.py v6.4.4, created at 2022-09-16 08:30 +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 

27from typing import List, Tuple 

28 

29from lsst import sphgeom 

30 

31 

32_LOG = logging.getLogger(__name__) 

33 

34 

35class Pixelization: 

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

37 pixelization type and parameters. 

38 

39 Parameters 

40 ---------- 

41 pixelization : `str` 

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

43 pix_level : `int` 

44 Pixelization level. 

45 pix_max_ranges : `int` 

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

47 """ 

48 

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

50 if pixelization == "htm": 

51 self.pixelator = sphgeom.HtmPixelization(pix_level) 

52 elif pixelization == "q3c": 

53 self.pixelator = sphgeom.Q3cPixelization(pix_level) 

54 elif pixelization == "mq3c": 

55 self.pixelator = sphgeom.Mq3cPixelization(pix_level) 

56 else: 

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

58 self._pix_max_ranges = pix_max_ranges 

59 

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

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

62 

63 Parameters 

64 ---------- 

65 region : `lsst.sphgeom.Region` 

66 """ 

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

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

69 indices = [] 

70 for lower, upper in ranges: 

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

72 return indices 

73 

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

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

76 

77 Parameters 

78 ---------- 

79 direction : `lsst.sphgeom.UnitVector3d` 

80 """ 

81 index = self.pixelator.index(direction) 

82 return index 

83 

84 def envelope(self, region: sphgeom.Region) -> List[Tuple[int, int]]: 

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

86 

87 Parameters 

88 ---------- 

89 region: `sphgeom.Region` 

90 Region that needs to be indexed. 

91 

92 Returns 

93 ------- 

94 ranges : `list` of `tuple` 

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

96 """ 

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

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

99 

100 if _LOG.isEnabledFor(logging.DEBUG): 

101 for irange in indices.ranges(): 

102 _LOG.debug( 

103 "range: %s %s", 

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

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

106 ) 

107 

108 return indices.ranges()