lsst.obs.base  19.0.0-78-g248c58d
Classes | Functions | Variables
lsst.obs.base._instrument Namespace Reference

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 436 of file _instrument.py.

◆ 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 467 of file _instrument.py.

◆ 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 402 of file _instrument.py.

Variable Documentation

◆ StandardCuratedCalibrationDatasetTypes

dictionary lsst.obs.base._instrument.StandardCuratedCalibrationDatasetTypes
Initial value:
1 = {
2  "defects": {"dimensions": ("instrument", "detector", "calibration_label"),
3  "storageClass": "Defects"},
4  "qe_curve": {"dimensions": ("instrument", "detector", "calibration_label"),
5  "storageClass": "QECurve"},
6  "crosstalk": {"dimensions": ("instrument", "detector", "calibration_label"),
7  "storageClass": "CrosstalkCalib"},
8 }

Definition at line 41 of file _instrument.py.