22 __all__ = (
"FitsRawFormatterBase",)
24 from abc
import ABCMeta, abstractmethod
26 from astro_metadata_translator
import ObservationInfo
31 from lsst.daf.butler
import FileDescriptor
34 from .formatters.fitsExposure
import FitsExposureFormatter
35 from .makeRawVisitInfoViaObsInfo
import MakeRawVisitInfoViaObsInfo
36 from .utils
import createInitialSkyWcsFromBoresight, InitialSkyWcsError
40 """Abstract base class for reading and writing raw data to and from
50 def fromMetadata(cls, metadata, obsInfo=None, storageClass=None, location=None):
51 """Construct a possibly-limited formatter from known metadata.
55 metadata : `lsst.daf.base.PropertyList`
56 Raw header metadata, with any fixes (see
57 `astro_metadata_translator.fix_header`) applied but nothing
59 obsInfo : `astro_metadata_translator.ObservationInfo`, optional
60 Structured information already extracted from ``metadata``.
61 If not provided, will be read from ``metadata`` on first use.
62 storageClass : `lsst.daf.butler.StorageClass`, optional
63 StorageClass for this file. If not provided, the formatter will
64 only support `makeWcs`, `makeVisitInfo`, `makeFilter`, and other
65 operations that operate purely on metadata and not the actual file.
66 location : `lsst.daf.butler.Location`, optional.
67 Location of the file. If not provided, the formatter will only
68 support `makeWcs`, `makeVisitInfo`, `makeFilter`, and other
69 operations that operate purely on metadata and not the actual file.
73 formatter : `FitsRawFormatterBase`
74 An instance of ``cls``.
76 self = cls(FileDescriptor(location, storageClass))
84 """`~astro_metadata_translator.MetadataTranslator` to translate
85 metadata header to `~astro_metadata_translator.ObservationInfo`.
89 _observationInfo =
None
94 """`~lsst.obs.base.FilterDefinitions`, defining the filters for this
100 """Read just the image component of the Exposure.
104 image : `~lsst.afw.image.Image`
105 In-memory image component.
107 return lsst.afw.image.ImageU(self.fileDescriptor.location.path)
110 """Read just the mask component of the Exposure.
112 May return None (as the default implementation does) to indicate that
113 there is no mask information to be extracted (at least not trivially)
114 from the raw data. This will prohibit direct reading of just the mask,
115 and set the mask of the full Exposure to zeros.
119 mask : `~lsst.afw.image.Mask`
120 In-memory mask component.
125 """Read just the variance component of the Exposure.
127 May return None (as the default implementation does) to indicate that
128 there is no variance information to be extracted (at least not
129 trivially) from the raw data. This will prohibit direct reading of
130 just the variance, and set the variance of the full Exposure to zeros.
134 image : `~lsst.afw.image.Image`
135 In-memory variance component.
140 """Boolean to determine if the exposure is thought to be on the sky.
145 Returns `True` if the observation looks like it was taken on the
146 sky. Returns `False` if this observation looks like a calibration
151 If there is tracking RA/Dec information associated with the
152 observation it is assumed that the observation is on sky.
153 Currently the observation type is not checked.
160 """Remove metadata entries that are parsed into components.
169 """Construct a VisitInfo from metadata.
173 visitInfo : `~lsst.afw.image.VisitInfo`
174 Structured metadata about the observation.
176 return MakeRawVisitInfoViaObsInfo.observationInfo2visitInfo(self.
observationInfo)
180 """Return the detector that acquired this raw exposure.
185 The identifying number of the detector to get.
189 detector : `~lsst.afw.cameraGeom.Detector`
190 The detector associated with that ``id``.
192 raise NotImplementedError(
"Must be implemented by subclasses.")
195 """Create a SkyWcs from information about the exposure.
197 If VisitInfo is not None, use it and the detector to create a SkyWcs,
198 otherwise return the metadata-based SkyWcs (always created, so that
199 the relevant metadata keywords are stripped).
203 visitInfo : `~lsst.afw.image.VisitInfo`
204 The information about the telescope boresight and camera
205 orientation angle for this exposure.
206 detector : `~lsst.afw.cameraGeom.Detector`
207 The detector used to acquire this exposure.
211 skyWcs : `~lsst.afw.geom.SkyWcs`
212 Reversible mapping from pixel coordinates to sky coordinates.
217 Raised if there is an error generating the SkyWcs, chained from the
218 lower-level exception if available.
226 log = lsst.log.Log.getLogger(
"fitsRawFormatter")
227 if visitInfo
is None:
228 msg =
"No VisitInfo; cannot access boresight information. Defaulting to metadata-based SkyWcs."
232 "See warnings in log messages for details.")
236 visitInfo.getBoresightRotAngle(),
241 """Class method to make a raw sky WCS from boresight and detector.
245 boresight : `lsst.geom.SpherePoint`
246 The ICRS boresight RA/Dec
247 orientation : `lsst.geom.Angle`
248 The rotation angle of the focal plane on the sky.
249 detector : `lsst.afw.cameraGeom.Detector`
250 Where to get the camera geomtry from.
254 skyWcs : `~lsst.afw.geom.SkyWcs`
255 Reversible mapping from pixel coordinates to sky coordinates.
259 def _createSkyWcsFromMetadata(self):
260 """Create a SkyWcs from the FITS header metadata in an Exposure.
264 skyWcs: `lsst.afw.geom.SkyWcs`, or None
265 The WCS that was created from ``self.metadata``, or None if that
266 creation fails due to invalid metadata.
273 return lsst.afw.geom.makeSkyWcs(self.
metadata, strip=
True)
274 except TypeError
as e:
275 log = lsst.log.Log.getLogger(
"fitsRawFormatter")
276 log.warn(
"Cannot create a valid WCS from metadata: %s", e.args[0])
280 """Construct a Filter from metadata.
284 filter : `~lsst.afw.image.Filter`
285 Object that identifies the filter for this image.
290 Raised if the physical filter was not registered via
291 `~lsst.afw.image.utils.defineFilter`.
296 """Read a component held by the Exposure.
300 component : `str`, optional
301 Component to read from the file.
302 parameters : `dict`, optional
303 If specified, a dictionary of slicing parameters that
304 overrides those in ``fileDescriptor``.
308 obj : component-dependent
309 In-memory component object.
314 Raised if the requested component cannot be handled.
316 if component ==
"image":
318 elif component ==
"mask":
320 elif component ==
"variance":
322 elif component ==
"filter":
324 elif component ==
"visitInfo":
326 elif component ==
"wcs":
329 return self.
makeWcs(visitInfo, detector)
333 """Read the full Exposure object.
337 parameters : `dict`, optional
338 If specified, a dictionary of slicing parameters that overrides
339 those in the `fileDescriptor` attribute.
343 exposure : `~lsst.afw.image.Exposure`
344 Complete in-memory exposure.
346 from lsst.afw.image
import makeExposure, makeMaskedImage
347 full = makeExposure(makeMaskedImage(self.
readImage()))
352 if variance
is not None:
353 full.setVariance(variance)
355 info = full.getInfo()
358 info.setWcs(self.
makeWcs(info.getVisitInfo(), info.getDetector()))
365 """Read the SkyWcs stored in the un-modified raw FITS WCS header keys.
367 return lsst.afw.geom.makeSkyWcs(lsst.afw.fits.readMetadata(self.fileDescriptor))
370 """Write a Python object to a file.
374 inMemoryDataset : `object`
375 The Python object to store.
380 The `URI` where the primary file is stored.
382 raise NotImplementedError(
"Raw data cannot be `put`.")
386 """The `~astro_metadata_translator.ObservationInfo` extracted from
387 this file's metadata (`~astro_metadata_translator.ObservationInfo`,