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

# This file is part of daf_butler. 

# 

# 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/>. 

 

__all__ = ("Instrument", "updateExposureEntryFromObsInfo", "updateVisitEntryFromObsInfo") 

 

from inspect import isabstract 

from abc import ABCMeta, abstractmethod 

from lsst.daf.butler import DataId 

 

 

# TODO: all code in this module probably needs to be moved to a higher-level 

# package (perhaps obs_base), but it is needed by the gen2convert subpackage. 

# We should probably move that as well. 

 

 

class Instrument(metaclass=ABCMeta): 

"""Base class for Instrument-specific logic for the Gen3 Butler. 

 

Concrete instrument subclasses should either be directly constructable 

with no arguments or provide a 'factory' `staticmethod`, `classmethod`, or 

other callable class attribute that takes no arguments and returns a new 

`Instrument` instance. 

""" 

 

factories = {} 

"""Global dictionary that maps instrument name used in the registry to 

a no-argument callable that can be used to construct a Python instance. 

""" 

 

def __init_subclass__(cls, **kwargs): 

super().__init_subclass__(**kwargs) 

50 ↛ exitline 50 didn't return from function '__init_subclass__', because the condition on line 50 was never false if not isabstract(cls): 

factory = getattr(cls, "factory", cls) 

Instrument.factories[cls.getName()] = factory 

 

@classmethod 

@abstractmethod 

def getName(cls): 

raise NotImplementedError() 

 

@abstractmethod 

def register(self, registry): 

"""Insert Instrument, PhysicalFilter, and Detector entries into a 

`Registry`. 

""" 

raise NotImplementedError() 

 

@abstractmethod 

def getRawFormatter(self, dataId): 

"""Return the Formatter class that should be used to read a particular 

raw file. 

 

Parameters 

---------- 

dataId : `DataId` 

Dimension-link identifier for the raw file or files being ingested. 

 

Returns 

------- 

formatter : `Formatter` 

Object that reads the file into an `lsst.afw.image.Exposure` 

instance. 

""" 

raise NotImplementedError() 

 

 

def updateExposureEntryFromObsInfo(dataId, obsInfo): 

"""Construct an Exposure Dimension entry from 

`astro_metadata_translator.ObservationInfo`. 

 

Parameters 

---------- 

dataId : `dict` or `DataId` 

Dictionary of Dimension primary/foreign key values for (at least) 

Exposure. If a true `DataId`, this object will be modified and 

returned. 

obsInfo : `astro_metadata_translator.ObservationInfo` 

A `~astro_metadata_translator.ObservationInfo` object corresponding to 

the Exposure. 

 

Returns 

------- 

dataId : `DataId` 

A data ID with the entry for the Exposure dimension updated. 

""" 

dataId = DataId(dataId) 

dataId.entries[dataId.dimensions["Exposure"]].update( 

datetime_begin=obsInfo.datetime_begin.to_datetime(), 

datetime_end=obsInfo.datetime_end.to_datetime(), 

exposure_time=obsInfo.exposure_time.to_value("s"), 

dark_time=obsInfo.dark_time.to_value("s") 

) 

return dataId 

 

 

def updateVisitEntryFromObsInfo(dataId, obsInfo): 

"""Construct a Visit Dimension entry from 

`astro_metadata_translator.ObservationInfo`. 

 

Parameters 

---------- 

dataId : `dict` or `DataId` 

Dictionary of Dimension primary/foreign key values for (at least) 

Visit. If a true `DataId`, this object will be modified and returned. 

obsInfo : `astro_metadata_translator.ObservationInfo` 

A `~astro_metadata_translator.ObservationInfo` object corresponding to 

the Exposure. 

 

Returns 

------- 

dataId : `DataId` 

A data ID with the entry for the Visit dimension updated. 

""" 

dataId = DataId(dataId) 

dataId.entries[dataId.dimensions["Exposure"]].update( 

datetime_begin=obsInfo.datetime_begin.to_datetime(), 

datetime_end=obsInfo.datetime_end.to_datetime(), 

exposure_time=obsInfo.exposure_time.to_value("s"), 

) 

return dataId