LsstComCamInstrument

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

Bases: lsst.obs.lsst.LsstCamInstrument

Gen3 Butler specialization for ComCam data.

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 = 'LSST-ComCam'
policyName = 'comCam'

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.