LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
rawFormatter.py
Go to the documentation of this file.
1 # This file is part of obs_decam.
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 """Gen3 Butler Formatters for Dark Energy Camera raw data.
23 """
24 
25 import logging
26 import astro_metadata_translator
27 
28 import lsst.afw.fits
29 import lsst.afw.image
30 from lsst.obs.base import FitsRawFormatterBase
31 
32 from . import DarkEnergyCamera
33 
34 __all__ = ("DarkEnergyCameraRawFormatter", "DarkEnergyCameraCPCalibFormatter")
35 
36 
37 # The mapping of detector id to HDU in raw files for "most" DECam data.
38 # We try this first before scaning the HDUs manually.
39 detector_to_hdu = {25: 1, 26: 2, 27: 3, 32: 4, 33: 5, 34: 6, 19: 7, 20: 8, 13: 9,
40  14: 10, 8: 11, 4: 12, 39: 13, 40: 14, 45: 15, 46: 16, 51: 17, 56: 18, 21: 19,
41  22: 20, 23: 21, 24: 22, 17: 23, 18: 24, 15: 25, 16: 26, 9: 27, 10: 28, 11: 29,
42  12: 30, 5: 31, 6: 32, 7: 33, 1: 34, 2: 35, 3: 36, 35: 37, 36: 38, 37: 39,
43  38: 40, 28: 41, 29: 42, 30: 43, 31: 44, 41: 45, 42: 46, 43: 47, 44: 48, 49: 49,
44  50: 50, 47: 51, 48: 52, 52: 53, 53: 54, 54: 55, 55: 56, 57: 57, 58: 58, 59: 59,
45  60: 60, 61: 61, 62: 62, 72: 63, 71: 64, 64: 65, 63: 66, 73: 67, 74: 68, 70: 69,
46  69: 70
47  }
48 
49 
50 class DarkEnergyCameraRawFormatter(FitsRawFormatterBase):
51  translatorClass = astro_metadata_translator.DecamTranslator
52  filterDefinitions = DarkEnergyCamera.filterDefinitions
53 
54  # DECam has a coordinate system flipped on X with respect to our
55  # VisitInfo definition of the field angle orientation.
56  # We have to specify the flip explicitly until DM-20746 is implemented.
57  wcsFlipX = True
58 
59  def getDetector(self, id):
60  return DarkEnergyCamera().getCamera()[id]
61 
62  def _scanHdus(self, filename, detectorId):
63  """Scan through a file for the HDU containing data from one detector.
64 
65  Parameters
66  ----------
67  filename : `str`
68  The file to search through.
69  detectorId : `int`
70  The detector id to search for.
71 
72  Returns
73  -------
74  index : `int`
75  The index of the HDU with the requested data.
76  metadata: `lsst.daf.base.PropertyList`
77  The metadata read from the header for that detector id.
78 
79  Raises
80  ------
81  ValueError
82  Raised if detectorId is not found in any of the file HDUs
83  """
84  log = logging.getLogger("lsst.obs.decam.DarkEnergyCameraRawFormatter")
85  log.debug("Did not find detector=%s at expected HDU=%s in %s: scanning through all HDUs.",
86  detectorId, detector_to_hdu[detectorId], filename)
87 
88  fitsData = lsst.afw.fits.Fits(filename, 'r')
89  # NOTE: The primary header (HDU=0) does not contain detector data.
90  for i in range(1, fitsData.countHdus()):
91  fitsData.setHdu(i)
92  metadata = fitsData.readMetadata()
93  if metadata['CCDNUM'] == detectorId:
94  return i, metadata
95  else:
96  raise ValueError(f"Did not find detectorId={detectorId} as CCDNUM in any HDU of {filename}.")
97 
98  def _determineHDU(self, detectorId):
99  """Determine the correct HDU number for a given detector id.
100 
101  Parameters
102  ----------
103  detectorId : `int`
104  The detector id to search for.
105 
106  Returns
107  -------
108  index : `int`
109  The index of the HDU with the requested data.
110  metadata : `lsst.daf.base.PropertyList`
111  The metadata read from the header for that detector id.
112 
113  Raises
114  ------
115  ValueError
116  Raised if detectorId is not found in any of the file HDUs
117  """
118  filename = self.fileDescriptor.location.path
119  try:
120  index = detector_to_hdu[detectorId]
121  metadata = lsst.afw.fits.readMetadata(filename, index)
122  if metadata['CCDNUM'] != detectorId:
123  # the detector->HDU mapping is different in this file: try scanning
124  return self._scanHdus_scanHdus(filename, detectorId)
125  else:
126  fitsData = lsst.afw.fits.Fits(filename, 'r')
127  fitsData.setHdu(index)
128  return index, metadata
130  # if the file doesn't contain all the HDUs of "normal" files, try scanning
131  return self._scanHdus_scanHdus(filename, detectorId)
132 
133  def readMetadata(self):
134  index, metadata = self._determineHDU_determineHDU(self.dataId['detector'])
135  astro_metadata_translator.fix_header(metadata)
136  return metadata
137 
138  def readImage(self):
139  index, metadata = self._determineHDU_determineHDU(self.dataId['detector'])
140  return lsst.afw.image.ImageI(self.fileDescriptor.location.path, index)
141 
142 
144  """DECam Community Pipeline calibrations (bias, dark, flat, fringe) are
145  multi-extension FITS files with detector=index+1.
146  """
147 
148  def _determineHDU(self, detectorId):
149  """The HDU to read is the same as the detector number."""
150  filename = self.fileDescriptor.location.path
151  metadata = lsst.afw.fits.readMetadata(filename, detectorId)
152  if metadata['CCDNUM'] != detectorId:
153  msg = f"Found CCDNUM={metadata['CCDNUM']} instead of {detectorId} in {filename} HDU={detectorId}."
154  raise ValueError(msg)
155  return detectorId, metadata
156 
157  def readImage(self):
158  index, metadata = self._determineHDU_determineHDU_determineHDU(self.dataId['detector'])
159  return lsst.afw.image.ImageF(self.fileDescriptor.location.path, index)
An exception thrown when problems are found when reading or writing FITS files.
Definition: fits.h:36
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
std::shared_ptr< daf::base::PropertyList > readMetadata(std::string const &fileName, int hdu=DEFAULT_HDU, bool strip=false)
Read FITS header.
Definition: fits.cc:1657
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.