Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

# This file is part of obs_base. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

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

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

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

# (at your option) any later version. 

# 

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

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

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

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

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

from __future__ import annotations 

 

__all__ = ["CalibRepoConverter"] 

 

import os 

import sqlite3 

from datetime import datetime, timedelta 

from typing import TYPE_CHECKING, Iterator, Tuple 

 

from .repoConverter import RepoConverter 

from .dataIdExtractor import DataIdExtractor 

from .translators import makeCalibrationLabel 

 

34 ↛ 35line 34 didn't jump to line 35, because the condition on line 34 was never trueif TYPE_CHECKING: 

from lsst.daf.butler import StorageClass 

from ..cameraMapper import CameraMapper 

from ..mapping import Mapping as CameraMapperMapping # disambiguate from collections.abc.Mapping 

from .filePathParser import FilePathParser 

 

CURATED_CALIBRATION_DATASET_TYPES = ( 

"defects", 

"camera", 

"transmission_sensor", 

"transmission_filter", 

"transmission_optics", 

"transmission_atmosphere", 

"bfKernel" 

) 

 

 

class CalibRepoConverter(RepoConverter): 

"""A specialization of `RepoConverter` for calibration repositories. 

 

Parameters 

---------- 

mapper : `CameraMapper` 

Gen2 mapper for the data repository. The root associated with the 

mapper is ignored and need not match the root of the repository. 

kwds 

Additional keyword arguments are forwarded to (and required by) 

`RepoConverter`. 

""" 

 

def __init__(self, *, mapper: CameraMapper, **kwds): 

super().__init__(**kwds) 

self.mapper = mapper 

self._datasetTypes = [] 

 

def isDatasetTypeSpecial(self, datasetTypeName: str) -> bool: 

# Docstring inherited from RepoConverter. 

return datasetTypeName in CURATED_CALIBRATION_DATASET_TYPES 

 

def isDirectorySpecial(self, subdirectory: str) -> bool: 

# Docstring inherited from RepoConverter. 

return False 

 

def iterMappings(self) -> Iterator[Tuple[str, CameraMapperMapping]]: 

# Docstring inherited from RepoConverter. 

yield from self.mapper.calibrations.items() 

 

def makeDataIdExtractor(self, datasetTypeName: str, parser: FilePathParser, 

storageClass: StorageClass) -> DataIdExtractor: 

# Docstring inherited from RepoConverter. 

extractor = DataIdExtractor( 

datasetTypeName, 

storageClass, 

filePathParser=parser, 

universe=self.task.universe, 

instrument=self.task.instrument.getName(), 

) 

self._datasetTypes.append(extractor.datasetType) 

return extractor 

 

def insertDimensionData(self): 

# Docstring inherited from RepoConverter. 

# This has only been tested on HSC, and it's not clear how general it 

# is. The catch is that it needs to generate calibration_label strings 

# consistent with those produced by the Translator system. 

db = sqlite3.connect(os.path.join(self.root, "calibRegistry.sqlite3")) 

db.row_factory = sqlite3.Row 

records = [] 

for datasetType in self._datasetTypes: 

if "calibration_label" not in datasetType.dimensions: 

continue 

fields = ["validStart", "validEnd", "calibDate"] 

if "detector" in datasetType.dimensions.names: 

fields.append(self.task.config.ccdKey) 

else: 

fields.append(f"NULL AS {self.task.config.ccdKey}") 

if "physical_filter" in datasetType.dimensions.names: 

fields.append("filter") 

else: 

fields.append("NULL AS filter") 

query = f"SELECT DISTINCT {', '.join(fields)} FROM {datasetType.name};" 

try: 

results = db.execute(query) 

except sqlite3.OperationalError: 

self.task.log.warn("Could not extract calibration ranges for %s in %s.", 

datasetType.name, self.root) 

continue 

for row in results: 

label = makeCalibrationLabel(datasetType.name, row["calibDate"], 

ccd=row[self.task.config.ccdKey], filter=row["filter"]) 

records.append({ 

"instrument": self.task.instrument.getName(), 

"name": label, 

"datetime_begin": datetime.strptime(row["validStart"], "%Y-%m-%d"), 

"datetime_end": datetime.strptime(row["validEnd"], "%Y-%m-%d") + timedelta(days=1), 

}) 

if records: 

self.task.registry.insertDimensionData("calibration_label", *records) 

 

def ingest(self): 

# Docstring inherited from RepoConverter. 

if self.task.config.doWriteCuratedCalibrations: 

for datasetTypeName in CURATED_CALIBRATION_DATASET_TYPES: 

if not self.task.isDatasetTypeIncluded(datasetTypeName): 

raise ValueError(f"doWriteCuratedCalibrations is True but " 

f"{datasetTypeName} is configured to be ignored.") 

try: 

butler3, collections = self.getButler(None) 

except LookupError as err: 

raise ValueError("Cannot ingest curated calibration into a calibration repo with no " 

"collections of its own; skipping.") from err 

# TODO: associate the curated calibrations with any other 

# collections and remove this assert. 

assert not collections, "Multiple collections for curated calibrations is not yet supported." 

self.task.instrument.writeCuratedCalibrations(butler3) 

super().ingest() 

 

# Class attributes that will be shadowed by public instance attributes; 

# defined here only for documentation purposes. 

 

mapper: CameraMapper 

"""Gen2 mapper associated with this repository. 

"""