Classes
class	Instrument

Functions
def	makeExposureRecordFromObsInfo (obsInfo, universe)

def	addUnboundedCalibrationLabel (registry, instrumentName)

Tuple[Camera, bool]	loadCamera (Butler butler, DataId dataId, *Any collections=None)

Variables
dictionary	StandardCuratedCalibrationDatasetTypes

Function Documentation

◆ addUnboundedCalibrationLabel()

def lsst.obs.base.instrument.addUnboundedCalibrationLabel	(	registry,
		instrumentName
	)

Add a special 'unbounded' calibration_label dimension entry for the
given camera that is valid for any exposure.

If such an entry already exists, this function just returns a `DataId`
for the existing entry.

Parameters
----------
registry : `Registry`
    Registry object in which to insert the dimension entry.
instrumentName : `str`
    Name of the instrument this calibration label is associated with.

Returns
-------
dataId : `DataId`
    New or existing data ID for the unbounded calibration.

Definition at line 408 of file instrument.py.

 def addUnboundedCalibrationLabel(registry, instrumentName):
     """Add a special 'unbounded' calibration_label dimension entry for the
     given camera that is valid for any exposure.
  
     If such an entry already exists, this function just returns a `DataId`
     for the existing entry.
  
     Parameters
     ----------
     registry : `Registry`
         Registry object in which to insert the dimension entry.
     instrumentName : `str`
         Name of the instrument this calibration label is associated with.
  
     Returns
     -------
     dataId : `DataId`
         New or existing data ID for the unbounded calibration.
     """
     d = dict(instrument=instrumentName, calibration_label="unbounded")
     try:
         return registry.expandDataId(d)
     except LookupError:
         pass
     entry = d.copy()
     entry["datetime_begin"] = TIMESPAN_MIN
     entry["datetime_end"] = TIMESPAN_MAX
     registry.insertDimensionData("calibration_label", entry)
     return registry.expandDataId(d)
  
  

◆ loadCamera()

Tuple[Camera, bool] lsst.obs.base.instrument.loadCamera	(	Butler	butler,
		DataId	dataId,
		*Any	collections = `None`
	)

Attempt to load versioned camera geometry from a butler, but fall back
to obtaining a nominal camera from the `Instrument` class if that fails.

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler instance to attempt to query for and load a ``camera`` dataset
    from.
dataId : `dict` or `DataCoordinate`
    Data ID that identifies at least the ``instrument`` and ``exposure``
    dimensions.
collections : Any, optional
    Collections to be searched, overriding ``self.butler.collections``.
    Can be any of the types supported by the ``collections`` argument
    to butler construction.

Returns
-------
camera : `lsst.afw.cameraGeom.Camera`
    Camera object.
versioned : `bool`
    If `True`, the camera was obtained from the butler and should represent
    a versioned camera from a calibration repository.  If `False`, no
    camera datasets were found, and the returned camera was produced by
    instantiating the appropriate `Instrument` class and calling
    `Instrument.getCamera`.

Definition at line 439 of file instrument.py.

 def loadCamera(butler: Butler, dataId: DataId, *, collections: Any = None) -> Tuple[Camera, bool]:
     """Attempt to load versioned camera geometry from a butler, but fall back
     to obtaining a nominal camera from the `Instrument` class if that fails.
  
     Parameters
     ----------
     butler : `lsst.daf.butler.Butler`
         Butler instance to attempt to query for and load a ``camera`` dataset
         from.
     dataId : `dict` or `DataCoordinate`
         Data ID that identifies at least the ``instrument`` and ``exposure``
         dimensions.
     collections : Any, optional
         Collections to be searched, overriding ``self.butler.collections``.
         Can be any of the types supported by the ``collections`` argument
         to butler construction.
  
     Returns
     -------
     camera : `lsst.afw.cameraGeom.Camera`
         Camera object.
     versioned : `bool`
         If `True`, the camera was obtained from the butler and should represent
         a versioned camera from a calibration repository.  If `False`, no
         camera datasets were found, and the returned camera was produced by
         instantiating the appropriate `Instrument` class and calling
         `Instrument.getCamera`.
     """
     if collections is None:
         collections = butler.collections
     # Registry would do data ID expansion internally if we didn't do it first,
     # but we might want an expanded data ID ourselves later, so we do it here
     # to ensure it only happens once.
     # This will also catch problems with the data ID not having keys we need.
     dataId = butler.registry.expandDataId(dataId, graph=butler.registry.dimensions["exposure"].graph)
     cameraRefs = list(butler.registry.queryDatasets("camera", dataId=dataId, collections=collections,
                                                     deduplicate=True))
     if cameraRefs:
         assert len(cameraRefs) == 1, "Should be guaranteed by deduplicate=True above."
         return butler.getDirect(cameraRefs[0]), True
     instrument = Instrument.fromName(dataId["instrument"], butler.registry)
     return instrument.getCamera(), False

◆ makeExposureRecordFromObsInfo()

def lsst.obs.base.instrument.makeExposureRecordFromObsInfo	(	obsInfo,
		universe
	)

Construct an exposure DimensionRecord from
`astro_metadata_translator.ObservationInfo`.

Parameters
----------
obsInfo : `astro_metadata_translator.ObservationInfo`
    A `~astro_metadata_translator.ObservationInfo` object corresponding to
    the exposure.
universe : `DimensionUniverse`
    Set of all known dimensions.

Returns
-------
record : `DimensionRecord`
    A record containing exposure metadata, suitable for insertion into
    a `Registry`.

Definition at line 374 of file instrument.py.

 def makeExposureRecordFromObsInfo(obsInfo, universe):
     """Construct an exposure DimensionRecord from
     `astro_metadata_translator.ObservationInfo`.
  
     Parameters
     ----------
     obsInfo : `astro_metadata_translator.ObservationInfo`
         A `~astro_metadata_translator.ObservationInfo` object corresponding to
         the exposure.
     universe : `DimensionUniverse`
         Set of all known dimensions.
  
     Returns
     -------
     record : `DimensionRecord`
         A record containing exposure metadata, suitable for insertion into
         a `Registry`.
     """
     dimension = universe["exposure"]
     return dimension.RecordClass.fromDict({
         "instrument": obsInfo.instrument,
         "id": obsInfo.exposure_id,
         "name": obsInfo.observation_id,
         "group_name": obsInfo.exposure_group,
         "group_id": obsInfo.visit_id,
         "datetime_begin": obsInfo.datetime_begin,
         "datetime_end": obsInfo.datetime_end,
         "exposure_time": obsInfo.exposure_time.to_value("s"),
         "dark_time": obsInfo.dark_time.to_value("s"),
         "observation_type": obsInfo.observation_type,
         "physical_filter": obsInfo.physical_filter,
     })
  
  

Variable Documentation

◆ StandardCuratedCalibrationDatasetTypes

dictionary lsst.obs.base.instrument.StandardCuratedCalibrationDatasetTypes

Initial value:

 =  {
     "defects": {"dimensions": ("instrument", "detector", "calibration_label"),
                 "storageClass": "Defects"},
     "qe_curve": {"dimensions": ("instrument", "detector", "calibration_label"),
                  "storageClass": "QECurve"},
 }

Definition at line 40 of file instrument.py.

Classes