lsst.obs.base  19.0.0-30-gf788142
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 getRawFormatter (self, dataId)
 
def writeCuratedCalibrations (self, butler)
 
def applyConfigOverrides (self, name, config)
 

Static Public Attributes

list configPaths = []
 

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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 52 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 127 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 46 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 62 of file instrument.py.

◆ getName()

def lsst.obs.base.instrument.Instrument.getName (   cls)

Definition at line 58 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 100 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 71 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.

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

Definition at line 118 of file instrument.py.

Member Data Documentation

◆ configPaths

list lsst.obs.base.instrument.Instrument.configPaths = []
static

Definition at line 37 of file instrument.py.


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