lsst.obs.base.instrument Namespace Reference

Classes
class	Instrument

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

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 208 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 142 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 175 of file instrument.py.