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

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/>.
# 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.
"""A template method class that can register itself with a `Registry.
This class should be subclassed by various implementations. Subclasses should provide all relevant attributes, as documented below.
Attributes ---------- instrument : `str` Name of the instrument. Must be provided by subclass. physicalFilters : `list` List of PhysicalFilter entries (each entry being a dict). detectors : `list` List of Detector entries (each entry being a dict). """
"""Register an instance of this `Instrument` with a `Registry`.
Creates all relevant `DataUnit` entries. """ assert self.instrument is not None self._addInstrument(registry) self._addPhysicalFilters(registry) self._addDetectors(registry)
registry.addDataUnitEntry("Instrument", {"instrument": self.instrument})
for entry in self.physicalFilters: if "instrument" not in entry: entry["instrument"] = self.instrument registry.addDataUnitEntry("PhysicalFilter", entry)
for entry in self.detectors: if 'instrument' not in entry: entry['instrument'] = self.instrument registry.addDataUnitEntry('Detector', entry)
"""Construct an Exposure DataUnit entry from `astro_metadata_translator.ObservationInfo`.
Parameters ---------- dataId : `dict` Dictionary of DataUnit primary/foreign key values for Exposure ("instrument", "exposure", optionally "visit" and "physical_filter"). obsInfo : `astro_metadata_translator.ObservationInfo` A `~astro_metadata_translator.ObservationInfo` object corresponding to the Exposure.
Returns ------- entry : `dict` A dictionary containing all fields in the Exposure table. """ result = { "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") } result.update(dataId) return result
"""Construct a Visit DataUnit entry from `astro_metadata_translator.ObservationInfo`.
Parameters ---------- dataId : `dict` Dictionary of DataUnit primary/foreign key values for Visit ("instrument", "visit", optionally "physical_filter"). obsInfo : `astro_metadata_translator.ObservationInfo` A `~astro_metadata_translator.ObservationInfo` object corresponding to the Visit.
Returns ------- entry : `dict` A dictionary containing all fields in the Visit table aside from "region". """ result = { "datetime_begin": obsInfo.datetime_begin.to_datetime(), "datetime_end": obsInfo.datetime_end.to_datetime(), "exposure_time": obsInfo.exposure_time.to_value("s"), } result.update(dataId) return result |