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.

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"] = datetime.min
    entry["datetime_end"] = datetime.max
    registry.insertDimensionData("calibration_label", entry)
    return registry.expandDataId(d)

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.

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,
        "datetime_begin": obsInfo.datetime_begin.to_datetime(),
        "datetime_end": obsInfo.datetime_end.to_datetime(),
        "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,
        "visit": obsInfo.visit_id,
    })

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.

def 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`.
    """
    dimension = universe["visit"]
    return dimension.RecordClass.fromDict({
        "instrument": obsInfo.instrument,
        "id": obsInfo.visit_id,
        "name": obsInfo.observation_id,
        "datetime_begin": obsInfo.datetime_begin.to_datetime(),
        "datetime_end": obsInfo.datetime_end.to_datetime(),
        "exposure_time": obsInfo.exposure_time.to_value("s"),
        "physical_filter": obsInfo.physical_filter,
        "region": region,
    })

---

Generated on Sat Nov 16 2019 09:15:47 for LSSTApplications by   1.8.13