Coverage for python/lsst/obs/cfht/_instrument.py: 48%

46 statements  

« prev     ^ index     » next       coverage.py v6.4.2, created at 2022-07-20 13:30 +0000

1# This file is part of obs_cfht. 

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"""Butler instrument description for the CFHT MegaCam camera. 

23""" 

24 

25__all__ = ("MegaPrime",) 

26 

27import os 

28from functools import lru_cache 

29 

30from lsst.afw.cameraGeom import makeCameraFromPath, CameraConfig 

31from lsst.obs.base import Instrument, VisitSystem 

32from lsst.obs.base.gen2to3 import TranslatorFactory, BandToPhysicalFilterKeyHandler 

33from .cfhtFilters import MEGAPRIME_FILTER_DEFINITIONS 

34 

35from lsst.utils.introspection import get_full_type_name 

36from lsst.utils import getPackageDir 

37 

38 

39class MegaPrime(Instrument): 

40 filterDefinitions = MEGAPRIME_FILTER_DEFINITIONS 

41 policyName = "megacam" 

42 obsDataPackage = None 

43 

44 def __init__(self, **kwargs): 

45 super().__init__(**kwargs) 

46 packageDir = getPackageDir("obs_cfht") 

47 self.configPaths = [os.path.join(packageDir, "config")] 

48 

49 @classmethod 

50 def getName(cls): 

51 return "MegaPrime" 

52 

53 def getCamera(self): 

54 path = os.path.join(getPackageDir("obs_cfht"), self.policyName, "camera") 

55 return self._getCameraFromPath(path) 

56 

57 @staticmethod 

58 @lru_cache() 

59 def _getCameraFromPath(path): 

60 """Return the camera geometry given solely the path to the location 

61 of that definition.""" 

62 config = CameraConfig() 

63 config.load(os.path.join(path, "camera.py")) 

64 return makeCameraFromPath( 

65 cameraConfig=config, 

66 ampInfoPath=path, 

67 shortNameFunc=lambda name: name.replace(" ", "_"), 

68 ) 

69 

70 def register(self, registry, update=False): 

71 camera = self.getCamera() 

72 obsMax = 2**31 

73 with registry.transaction(): 

74 registry.syncDimensionData( 

75 "instrument", 

76 { 

77 "name": self.getName(), "detector_max": 36, "visit_max": obsMax, "exposure_max": obsMax, 

78 "class_name": get_full_type_name(self), 

79 # Some schemas support default visit_system 

80 "visit_system": VisitSystem.ONE_TO_ONE.value, 

81 }, 

82 update=update 

83 ) 

84 

85 for detector in camera: 

86 registry.syncDimensionData( 

87 "detector", 

88 { 

89 "instrument": self.getName(), 

90 "id": detector.getId(), 

91 "full_name": detector.getName(), 

92 "name_in_raft": detector.getName(), 

93 "raft": None, # MegaPrime does not have rafts 

94 "purpose": str(detector.getType()).split(".")[-1], 

95 }, 

96 update=update 

97 ) 

98 

99 self._registerFilters(registry, update=update) 

100 

101 def getRawFormatter(self, dataId): 

102 # local import to prevent circular dependency 

103 from .rawFormatter import MegaPrimeRawFormatter 

104 return MegaPrimeRawFormatter 

105 

106 def makeDataIdTranslatorFactory(self) -> TranslatorFactory: 

107 # Docstring inherited from lsst.obs.base.Instrument. 

108 factory = TranslatorFactory() 

109 factory.addGenericInstrumentRules(self.getName(), calibFilterType="band") 

110 

111 # calibRegistry entries are bands, but we need 

112 # physical_filter in the gen3 registry. 

113 factory.addRule(BandToPhysicalFilterKeyHandler(self.filterDefinitions), 

114 instrument=self.getName(), 

115 gen2keys=("filter",), 

116 consume=("filter",)) 

117 return factory