lsst.obs.base._instrument Namespace Reference

Classes
class	Instrument

Functions
def	makeExposureRecordFromObsInfo (obsInfo, universe)
Tuple[Camera, bool]	loadCamera (Butler butler, DataId dataId, *Any collections=None)

Variables
dictionary	StandardCuratedCalibrationDatasetTypes

Function Documentation

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 757 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)
    try:
        cameraRef = butler.get("camera", dataId=dataId, collections=collections)
        return cameraRef, True
    except LookupError:
        pass
    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 702 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"]
 
    ra, dec, sky_angle, zenith_angle = (None, None, None, None)
    if obsInfo.tracking_radec is not None:
        icrs = obsInfo.tracking_radec.icrs
        ra = icrs.ra.degree
        dec = icrs.dec.degree
        if obsInfo.boresight_rotation_coord == "sky":
            sky_angle = obsInfo.boresight_rotation_angle.degree
    if obsInfo.altaz_begin is not None:
        zenith_angle = obsInfo.altaz_begin.zen.degree
 
    return dimension.RecordClass(
        instrument=obsInfo.instrument,
        id=obsInfo.exposure_id,
        obs_id=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"),
        # we are not mandating that dark_time be calculable
        dark_time=obsInfo.dark_time.to_value("s") if obsInfo.dark_time is not None else None,
        observation_type=obsInfo.observation_type,
        observation_reason=obsInfo.observation_reason,
        day_obs=obsInfo.observing_day,
        seq_num=obsInfo.observation_counter,
        physical_filter=obsInfo.physical_filter,
        science_program=obsInfo.science_program,
        target_name=obsInfo.object,
        tracking_ra=ra,
        tracking_dec=dec,
        sky_angle=sky_angle,
        zenith_angle=zenith_angle,
    )
 
 

Variable Documentation

StandardCuratedCalibrationDatasetTypes

dictionary lsst.obs.base._instrument.StandardCuratedCalibrationDatasetTypes

Initial value:

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

Definition at line 51 of file _instrument.py.