lsst.obs.base  19.0.0-32-g3b6bf2d
Classes | Functions | Variables
lsst.obs.base.instrument Namespace Reference

Classes

class  Instrument
 

Functions

def makeExposureRecordFromObsInfo (obsInfo, universe)
 
def makeVisitRecordFromObsInfo (obsInfo, universe, region=None)
 
def addUnboundedCalibrationLabel (registry, instrumentName)
 

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 370 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 303 of file instrument.py.

◆ makeVisitRecordFromObsInfo()

def lsst.obs.base.instrument.makeVisitRecordFromObsInfo (   obsInfo,
  universe,
  region = None 
)
Construct a visit `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.
region : `lsst.sphgeom.Region`, optional
    Spatial region for the visit.

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

Definition at line 337 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 }

Definition at line 34 of file instrument.py.