Coverage for python/lsst/skymap/packers.py: 32%

52 statements  

« prev     ^ index     » next       coverage.py v6.5.0, created at 2023-01-07 02:11 -0800

1# This file is part of skymap. 

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 

22__all__ = ("SkyMapDimensionPacker",) 

23 

24from lsst.daf.butler import DimensionPacker, DimensionGraph, DataCoordinate 

25 

26 

27class SkyMapDimensionPacker(DimensionPacker): 

28 """A `DimensionPacker` for tract, patch and optionally band, 

29 given a SkyMap. 

30 

31 Parameters 

32 ---------- 

33 fixed : `lsst.daf.butler.DataCoordinate` 

34 Expanded data ID that must include at least the skymap dimension. 

35 dimensions : `lsst.daf.butler.DimensionGraph` 

36 The dimensions of data IDs packed by this instance. Must include 

37 skymap, tract, and patch, and may include band. 

38 """ 

39 

40 SUPPORTED_FILTERS = ( 

41 [None] 

42 + list("ugrizyUBGVRIZYJHK") # split string into single chars 

43 + [f"N{d}" for d in (387, 515, 656, 816, 921, 1010)] # HSC narrow-bands 

44 + [f"N{d}" for d in (419, 540, 708, 964)] # DECam narrow-bands 

45 ) 

46 """band names supported by this packer. 

47 

48 New filters should be added to the end of the list to maximize 

49 compatibility with existing IDs. 

50 """ 

51 

52 @classmethod 

53 def getIntFromFilter(cls, name): 

54 """Return an integer that represents the band with the given 

55 name. 

56 """ 

57 try: 

58 return cls.SUPPORTED_FILTERS.index(name) 

59 except ValueError: 

60 raise NotImplementedError(f"band '{name}' not supported by this ID packer.") 

61 

62 @classmethod 

63 def getFilterNameFromInt(cls, num): 

64 """Return an band name from its integer representation. 

65 """ 

66 return cls.SUPPORTED_FILTERS[num] 

67 

68 @classmethod 

69 def getMaxIntForFilters(cls): 

70 return len(cls.SUPPORTED_FILTERS) 

71 

72 @classmethod 

73 def configure(cls, dimensions): 

74 # Docstring inherited from DataIdPacker.configure 

75 assert dimensions.given == ["skymap"] 

76 assert dimensions.required.issuperset(["tract", "patch"]) 

77 metadata = {"skymap": ["tract_max", "patch_nx_max", "patch_ny_max"]} 

78 kwds = {} 

79 return metadata, kwds 

80 

81 def __init__(self, fixed: DataCoordinate, dimensions: DimensionGraph): 

82 super().__init__(fixed, dimensions) 

83 record = fixed.records["skymap"] 

84 self._skyMapName = record.name 

85 self._patchMax = record.patch_nx_max * record.patch_ny_max 

86 self._tractPatchMax = self._patchMax*record.tract_max 

87 if "band" in dimensions: 

88 self._filterMax = self.getMaxIntForFilters() 

89 else: 

90 self._filterMax = None 

91 

92 @property 

93 def maxBits(self) -> int: 

94 # Docstring inherited from DataIdPacker.maxBits 

95 packedMax = self._tractPatchMax 

96 if self._filterMax is not None: 

97 packedMax *= self._filterMax 

98 return packedMax.bit_length() 

99 

100 def _pack(self, dataId: DataCoordinate) -> int: 

101 # Docstring inherited from DataIdPacker.pack 

102 packed = dataId["patch"] + self._patchMax*dataId["tract"] 

103 if self._filterMax is not None: 

104 packed += self.getIntFromFilter(dataId["band"])*self._tractPatchMax 

105 return packed 

106 

107 def unpack(self, packedId: int) -> DataCoordinate: 

108 # Docstring inherited from DataIdPacker.unpack 

109 d = {"skymap": self._skyMapName} 

110 if self._filterMax is not None: 

111 d["band"] = self.getFilterNameFromInt(packedId // self._tractPatchMax) 

112 packedId %= self._tractPatchMax 

113 d["tract"] = packedId // self._patchMax 

114 d["patch"] = packedId % self._patchMax 

115 return DataCoordinate.standardize(d, graph=self.dimensions)