LsstCamInstrument

class lsst.obs.lsst.LsstCamInstrument(*args, **kwargs)

Bases: lsst.daf.butler.instrument.Instrument

Gen3 Butler specialization for the LSST Main Camera.

Parameters:

camera : lsst.cameraGeom.Camera

Camera object from which to extract detector information.

filters : list of FilterDefinition

An ordered list of filters to define the set of PhysicalFilters associated with this instrument in the registry.

While both the camera geometry and the set of filters associated with a

camera are expected to change with time in general, their Butler Registry

representations defined by an Instrument do not. Instead:

• We only extract names, IDs, and purposes from the detectors in the camera, which should be static information that actually reflects detector “slots” rather than the physical sensors themselves. Because the distinction between physical sensors and slots is unimportant in the vast majority of Butler use cases, we just use “detector” even though the concept really maps better to “detector slot”. Ideally in the future this distinction between static and time-dependent information would be encoded in cameraGeom itself (e.g. by making the time-dependent Detector class inherit from a related class that only carries static content).
• The Butler Registry is expected to contain physical_filter entries for all filters an instrument has ever had, because we really only care about which filters were used for particular observations, not which filters were available at some point in the past. And changes in individual filters over time will be captured as changes in their TransmissionCurve datasets, not changes in the registry content (which is really just a label). While at present Instrument and Registry do not provide a way to add new physical_filters, they will in the future.

Attributes Summary

configPaths	Built-in mutable sequence.
filterDefinitions
instrument
policyName

Methods Summary

applyConfigOverrides(name, config)	Apply instrument-specific overrides for a task config.
extractDetectorRecord(camGeomDetector)	Create a Gen3 Detector entry dict from a cameraGeom.Detector.
getCamera()	Retrieve the cameraGeom representation of this instrument.
getName()
getRawFormatter(dataId)	Return the Formatter class that should be used to read a particular raw file.
register(registry)	Insert instrument, physical_filter, and detector entries into a Registry.
writeCuratedCalibrations(butler)	Write human-curated calibration Datasets to the given Butler with the appropriate validity ranges.

Attributes Documentation

configPaths

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

filterDefinitions = <lsst.obs.base.filters.FilterDefinitionCollection object>

instrument = 'lsstCam'

policyName = 'lsstCam'

Methods Documentation

applyConfigOverrides(name, config)

Apply instrument-specific overrides for a task config.

Parameters:

name : str

Name of the object being configured; typically the _DefaultName of a Task.

config : lsst.pex.config.Config

Config instance to which overrides should be applied.

extractDetectorRecord(camGeomDetector)

Create a Gen3 Detector entry dict from a cameraGeom.Detector.

classmethod getCamera()

Retrieve the cameraGeom representation of this instrument.

This is a temporary API that should go away once obs_ packages have a standardized approach to writing versioned cameras to a Gen3 repo.

classmethod getName()

getRawFormatter(dataId)

Return the Formatter class that should be used to read a particular raw file.

Parameters:

dataId : DataCoordinate

Dimension-based ID for the raw file or files being ingested.

Returns:

formatter : Formatter class

Class to be used that reads the file into an lsst.afw.image.Exposure instance.

register(registry)

Insert instrument, physical_filter, and detector entries into a Registry.

writeCuratedCalibrations(butler)

Write human-curated calibration Datasets to the given Butler with the appropriate validity ranges.

This is a temporary API that should go away once obs_ packages have a standardized approach to this problem.