Instrument

class lsst.obs.base.Instrument(*args, **kwargs)

Bases: object

Base class for instrument-specific logic for the Gen3 Butler.

Concrete instrument subclasses should be directly constructable with no arguments.

Attributes Summary

configPaths	Paths to config files to read for specific Tasks.
filterDefinitions	FilterDefinitionCollection, defining the filters for this instrument.

Methods Summary

applyConfigOverrides(name, config)	Apply instrument-specific overrides for a task config.
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 = []

Paths to config files to read for specific Tasks.

The paths in this list should contain files of the form task.py, for each of the Tasks that requires special configuration.

filterDefinitions

FilterDefinitionCollection, defining the filters for this instrument.

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.

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.