Coverage for python/lsst/daf/butler/instrument.py : 48%

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
# 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/>.
"ObservationDataIdPacker")
# 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.
"""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. """
"""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 getName(cls): raise NotImplementedError()
def register(self, registry): """Insert Instrument, PhysicalFilter, and Detector entries into a `Registry`. """ raise NotImplementedError()
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()
"""A `DataIdPacker` for Visit+Detector or Exposure+Detector, given an Instrument.
Parameters ---------- dimensions : `DataIdPackerDimensions` Struct defining the "given" (at contructoin) and "required" (for packing) dimensions of this packer. instrument : `str` Name of the Instrument for which this packer packs IDs. obsMax : `int` Maximum (exclusive) value for either Visit or Exposure IDs for this Instrument, depending on which of those is present in ``dimensions.required``. detectorMax : `int Maximum (exclusive) value for Detectors for this Instrument. """
self._instrumentName = instrument if dimensions.required == ("Instrument", "Visit", "Detector"): self._observationLink = "visit" elif dimensions.required == ("Instrument", "Exposure", "Detector"): self._observationLink = "exposure" else: raise ValueError(f"Invalid dimensions for ObservationDataIdPacker: {dimensions.required}") self._detectorMax = detectorMax self._maxBits = (obsMax*self._detectorMax).bit_length()
def maxBits(self): # Docstring inherited from DataIdPacker.maxBits return self._maxBits
# Docstring inherited from DataIdPacker._pack return dataId["detector"] + self._detectorMax*dataId[self._observationLink]
# Docstring inherited from DataIdPacker.unpack return DataId({"instrument": self._instrumentName, "detector": packedId % self._detectorMax, self._observationLink: packedId // self._detectorMax}, dimensions=self.dimensions.required)
"""Construct an Exposure Dimension entry from `astro_metadata_translator.ObservationInfo`.
Parameters ---------- dataId : `dict` or `DataId` Dictionary of Dimension link fields 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
"""Construct a Visit Dimension entry from `astro_metadata_translator.ObservationInfo`.
Parameters ---------- dataId : `dict` or `DataId` Dictionary of Dimension link fields 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()["Visit"]].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 |