Coverage for python/lsst/daf/butler/dimensions/_skypix.py: 58%

73 statements  

« prev     ^ index     » next       coverage.py v7.5.0, created at 2024-05-02 03:16 -0700

1# This file is part of daf_butler. 

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 software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28from __future__ import annotations 

29 

30from lsst.daf.butler.column_spec import IntColumnSpec 

31 

32__all__ = ( 

33 "SkyPixDimension", 

34 "SkyPixSystem", 

35) 

36 

37from collections.abc import Iterator, Mapping, Set 

38from types import MappingProxyType 

39from typing import TYPE_CHECKING 

40 

41from lsst.sphgeom import PixelizationABC 

42 

43from .._named import NamedValueAbstractSet, NamedValueSet 

44from .._topology import TopologicalFamily, TopologicalSpace 

45from ._elements import Dimension, KeyColumnSpec, MetadataColumnSpec 

46 

47if TYPE_CHECKING: 

48 from ._universe import DimensionUniverse 

49 

50 

51class SkyPixSystem(TopologicalFamily): 

52 """Class for hierarchical pixelization of the sky. 

53 

54 A `TopologicalFamily` that represents a hierarchical pixelization of the 

55 sky. 

56 

57 Parameters 

58 ---------- 

59 name : `str` 

60 Name of the system. 

61 maxLevel : `int` 

62 Maximum level (inclusive) of the hierarchy. 

63 PixelizationClass : `type` (`lsst.sphgeom.PixelizationABC` subclass) 

64 Class whose instances represent a particular level of this 

65 pixelization. 

66 """ 

67 

68 def __init__( 

69 self, 

70 name: str, 

71 *, 

72 maxLevel: int, 

73 PixelizationClass: type[PixelizationABC], 

74 ): 

75 super().__init__(name, TopologicalSpace.SPATIAL) 

76 self.maxLevel = maxLevel 

77 self.PixelizationClass = PixelizationClass 

78 self._members: dict[int, SkyPixDimension] = {} 

79 for level in range(maxLevel + 1): 

80 self._members[level] = SkyPixDimension(self, level) 

81 

82 def choose(self, endpoints: Set[str], universe: DimensionUniverse) -> SkyPixDimension: 

83 # Docstring inherited from TopologicalFamily. 

84 best: SkyPixDimension | None = None 

85 for endpoint_name in endpoints: 

86 endpoint = universe[endpoint_name] 

87 if endpoint not in self: 

88 continue 

89 assert isinstance(endpoint, SkyPixDimension) 

90 if best is None or best.level < endpoint.level: 

91 best = endpoint 

92 if best is None: 

93 raise RuntimeError(f"No recognized endpoints for {self.name} in {endpoints}.") 

94 return best 

95 

96 def __getitem__(self, level: int) -> SkyPixDimension: 

97 return self._members[level] 

98 

99 def __iter__(self) -> Iterator[SkyPixDimension]: 

100 return iter(self._members.values()) 

101 

102 def __len__(self) -> int: 

103 return len(self._members) 

104 

105 

106class SkyPixDimension(Dimension): 

107 """Special dimension for sky pixelizations. 

108 

109 A special `Dimension` subclass for hierarchical pixelizations of the 

110 sky at a particular level. 

111 

112 Unlike most other dimensions, skypix dimension records are not stored in 

113 the database, as these records only contain an integer pixel ID and a 

114 region on the sky, and each of these can be computed directly from the 

115 other. 

116 

117 Parameters 

118 ---------- 

119 system : `SkyPixSystem` 

120 Pixelization system this dimension belongs to. 

121 level : `int` 

122 Integer level of this pixelization (smaller numbers are coarser grids). 

123 """ 

124 

125 def __init__(self, system: SkyPixSystem, level: int): 

126 self.system = system 

127 self.level = level 

128 self.pixelization = system.PixelizationClass(level) 

129 

130 @property 

131 def name(self) -> str: 

132 return f"{self.system.name}{self.level}" 

133 

134 @property 

135 def required(self) -> NamedValueAbstractSet[Dimension]: 

136 # Docstring inherited from DimensionElement. 

137 return NamedValueSet({self}).freeze() 

138 

139 @property 

140 def implied(self) -> NamedValueAbstractSet[Dimension]: 

141 # Docstring inherited from DimensionElement. 

142 return NamedValueSet().freeze() 

143 

144 @property 

145 def topology(self) -> Mapping[TopologicalSpace, TopologicalFamily]: 

146 # Docstring inherited from TopologicalRelationshipEndpoint 

147 return MappingProxyType({TopologicalSpace.SPATIAL: self.system}) 

148 

149 @property 

150 def metadata_columns(self) -> NamedValueAbstractSet[MetadataColumnSpec]: 

151 # Docstring inherited from DimensionElement. 

152 return NamedValueSet().freeze() 

153 

154 @property 

155 def documentation(self) -> str: 

156 # Docstring inherited from DimensionElement. 

157 return f"Level {self.level} of the {self.system.name!r} sky pixelization system." 

158 

159 def hasTable(self) -> bool: 

160 # Docstring inherited from DimensionElement.hasTable. 

161 return False 

162 

163 @property 

164 def has_own_table(self) -> bool: 

165 # Docstring inherited from DimensionElement. 

166 return False 

167 

168 @property 

169 def unique_keys(self) -> NamedValueAbstractSet[KeyColumnSpec]: 

170 # Docstring inherited from DimensionElement. 

171 return NamedValueSet([IntColumnSpec(name="id", nullable=False)]).freeze() 

172 

173 # Class attributes below are shadowed by instance attributes, and are 

174 # present just to hold the docstrings for those instance attributes. 

175 

176 system: SkyPixSystem 

177 """Pixelization system this dimension belongs to (`SkyPixSystem`). 

178 """ 

179 

180 level: int 

181 """Integer level of this pixelization (smaller numbers are coarser grids). 

182 """ 

183 

184 pixelization: PixelizationABC 

185 """Pixelization instance that can compute regions from IDs and IDs from 

186 points (`sphgeom.PixelizationABC`). 

187 """