lsst.obs.base.instrument.Instrument Class Reference

Inheritance diagram for lsst.obs.base.instrument.Instrument:

Public Member Functions
def	filterDefinitions (self)
def	__init__ (self, args, kwargs)
def	getName (cls)
def	getCamera (self)
def	register (self, registry)
def	obsDataPackageDir (self)
def	getRawFormatter (self, dataId)
def	writeCuratedCalibrations (self, butler)
def	applyConfigOverrides (self, name, config)
def	writeCameraGeom (self, butler)
def	writeStandardTextCuratedCalibrations (self, butler)

Static Public Attributes
tuple	configPaths = ()
	policyName = None
	obsDataPackage = None
	standardCuratedDatasetTypes = tuple(StandardCuratedCalibrationDatasetTypes)

Detailed Description

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

Concrete instrument subclasses should be directly constructable with no
arguments.

Definition at line 42 of file instrument.py.

Constructor & Destructor Documentation

__init__()

def lsst.obs.base.instrument.Instrument.__init__	(		self,
			args,
			kwargs
	)

Definition at line 82 of file instrument.py.

Member Function Documentation

applyConfigOverrides()

def lsst.obs.base.instrument.Instrument.applyConfigOverrides	(		self,
			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.

Definition at line 175 of file instrument.py.

filterDefinitions()

def lsst.obs.base.instrument.Instrument.filterDefinitions

(

self

)

`~lsst.obs.base.FilterDefinitionCollection`, defining the filters
for this instrument.

Definition at line 76 of file instrument.py.

getCamera()

def lsst.obs.base.instrument.Instrument.getCamera

(

self

)

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.

Definition at line 93 of file instrument.py.

getName()

def lsst.obs.base.instrument.Instrument.getName

(

cls

)

Definition at line 89 of file instrument.py.

getRawFormatter()

def lsst.obs.base.instrument.Instrument.getRawFormatter	(		self,
			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.

Definition at line 141 of file instrument.py.

obsDataPackageDir()

def lsst.obs.base.instrument.Instrument.obsDataPackageDir

(

self

)

Definition at line 109 of file instrument.py.

register()

def lsst.obs.base.instrument.Instrument.register	(		self,
			registry
	)

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

Definition at line 102 of file instrument.py.

writeCameraGeom()

def lsst.obs.base.instrument.Instrument.writeCameraGeom	(		self,
			butler
	)

Write the default camera geometry to the butler repository
with an infinite validity range.

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler to receive these calibration datasets.

Definition at line 191 of file instrument.py.

writeCuratedCalibrations()

def lsst.obs.base.instrument.Instrument.writeCuratedCalibrations	(		self,
			butler
	)

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

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler to use to store these calibrations.

Notes
-----
Expected to be called from subclasses.  The base method calls
``writeCameraGeom`` and ``writeStandardTextCuratedCalibrations``.

Definition at line 158 of file instrument.py.

writeStandardTextCuratedCalibrations()

def lsst.obs.base.instrument.Instrument.writeStandardTextCuratedCalibrations	(		self,
			butler
	)

Write the set of standardized curated text calibrations to
the repository.

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler to receive these calibration datasets.

Definition at line 208 of file instrument.py.

Member Data Documentation

configPaths

tuple lsst.obs.base.instrument.Instrument.configPaths = ()

static

Definition at line 49 of file instrument.py.

obsDataPackage

lsst.obs.base.instrument.Instrument.obsDataPackage = None

static

Definition at line 60 of file instrument.py.

policyName

lsst.obs.base.instrument.Instrument.policyName = None

static

Definition at line 56 of file instrument.py.

standardCuratedDatasetTypes

lsst.obs.base.instrument.Instrument.standardCuratedDatasetTypes = tuple(StandardCuratedCalibrationDatasetTypes)

static

Definition at line 65 of file instrument.py.

---

The documentation for this class was generated from the following file:

• python/lsst/obs/base/instrument.py