lsst.obs.base  19.0.0-56-g64d9981+3
Public Member Functions | Static Public Attributes | List of all members
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 fromName (cls, name, registry)
 
def getRawFormatter (self, dataId)
 
def writeCuratedCalibrations (self, butler)
 
def applyConfigOverrides (self, name, config)
 
def writeCameraGeom (self, butler)
 
def writeStandardTextCuratedCalibrations (self, butler)
 
TranslatorFactory makeDataIdTranslatorFactory (self)
 

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 48 of file instrument.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 88 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 228 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 82 of file instrument.py.

◆ fromName()

def lsst.obs.base.instrument.Instrument.fromName (   cls,
  name,
  registry 
)
Given an instrument name and a butler, retrieve a corresponding
instantiated instrument object.

Parameters
----------
name : `str`
    Name of the instrument (must match the return value of `getName`).
registry : `lsst.daf.butler.Registry`
    Butler registry to query to find the information.

Returns
-------
instrument : `Instrument`
    An instance of the relevant `Instrument`.

Notes
-----
The instrument must be registered in the corresponding butler.

Raises
------
LookupError
    Raised if the instrument is not known to the supplied registry.
ModuleNotFoundError
    Raised if the class could not be imported.  This could mean
    that the relevant obs package has not been setup.
TypeError
    Raised if the class name retrieved is not a string.

Definition at line 134 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 105 of file instrument.py.

◆ getName()

def lsst.obs.base.instrument.Instrument.getName (   cls)
Return the short (dimension) name for this instrument.

This is not (in general) the same as the class name - it's what is used
as the value of the "instrument" field in data IDs, and is usually an
abbreviation of the full name.

Definition at line 95 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 194 of file instrument.py.

◆ makeDataIdTranslatorFactory()

TranslatorFactory lsst.obs.base.instrument.Instrument.makeDataIdTranslatorFactory (   self)
Return a factory for creating Gen2->Gen3 data ID translators,
specialized for this instrument.

Derived class implementations should generally call
`TranslatorFactory.addGenericInstrumentRules` with appropriate
arguments, but are not required to (and may not be able to if their
Gen2 raw data IDs are sufficiently different from the HSC/DECam/CFHT
norm).

Returns
-------
factory : `TranslatorFactory`.
    Factory for `Translator` objects.

Definition at line 356 of file instrument.py.

◆ obsDataPackageDir()

def lsst.obs.base.instrument.Instrument.obsDataPackageDir (   self)
The root of the obs package that provides specializations for
this instrument (`str`).

Definition at line 121 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 114 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 244 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 211 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 261 of file instrument.py.

Member Data Documentation

◆ configPaths

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

Definition at line 55 of file instrument.py.

◆ obsDataPackage

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

Definition at line 66 of file instrument.py.

◆ policyName

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

Definition at line 62 of file instrument.py.

◆ standardCuratedDatasetTypes

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

Definition at line 71 of file instrument.py.


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