lsst.obs.base  20.0.0-39-g75a4215+e59a56a058
Public Member Functions | Static Public Member Functions | 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)
 
def getName (cls)
 
Set[str] getCuratedCalibrationNames (cls)
 
def getCamera (self)
 
def register (self, registry)
 
def getObsDataPackageDir (cls)
 
def getRawFormatter (self, dataId)
 
def writeCuratedCalibrations (self, butler, run=None)
 
def writeAdditionalCuratedCalibrations (self, butler, run=None)
 
def applyConfigOverrides (self, name, config)
 
def writeCameraGeom (self, butler, run=None)
 
def writeStandardTextCuratedCalibrations (self, butler, run=None)
 
TranslatorFactory makeDataIdTranslatorFactory (self)
 
str makeDefaultRawIngestRunName (cls)
 
str makeCollectionName (cls, str label)
 

Static Public Member Functions

Instrument fromName (str name, Registry registry)
 
None importAll (Registry registry)
 

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 59 of file _instrument.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.obs.base._instrument.Instrument.__init__ (   self)

Definition at line 109 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 337 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 103 of file _instrument.py.

◆ fromName()

Instrument lsst.obs.base._instrument.Instrument.fromName ( str  name,
Registry  registry 
)
static
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 189 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 158 of file _instrument.py.

◆ getCuratedCalibrationNames()

Set[str] lsst.obs.base._instrument.Instrument.getCuratedCalibrationNames (   cls)
Return the names of all the curated calibration dataset types.

Returns
-------
names : `set` of `str`
    The dataset type names of all curated calibrations. This will
    include the standard curated calibrations even if the particular
    instrument does not support them.

Notes
-----
The returned list does not indicate whether a particular dataset
is present in the Butler repository, simply that these are the
dataset types that are handled by ``writeCuratedCalibrations``.

Definition at line 126 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 115 of file _instrument.py.

◆ getObsDataPackageDir()

def lsst.obs.base._instrument.Instrument.getObsDataPackageDir (   cls)
The root of the obs data package that provides specializations for
this instrument.

returns
-------
dir : `str`
    The root of the relevat obs data package.

Definition at line 175 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 276 of file _instrument.py.

◆ importAll()

None lsst.obs.base._instrument.Instrument.importAll ( Registry  registry)
static
Import all the instruments known to this registry.

This will ensure that all metadata translators have been registered.

Parameters
----------
registry : `lsst.daf.butler.Registry`
    Butler registry to query to find the information.

Notes
-----
It is allowed for a particular instrument class to fail on import.
This might simply indicate that a particular obs package has
not been setup.

Definition at line 229 of file _instrument.py.

◆ makeCollectionName()

str lsst.obs.base._instrument.Instrument.makeCollectionName (   cls,
str  label 
)
Get the instrument-specific collection string to use as derived
from the supplied label.

Parameters
----------
label : `str`
    String to be combined with the instrument name to form a
    collection name.

Returns
-------
name : `str`
    Collection name to use that includes the instrument name.

Definition at line 525 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 494 of file _instrument.py.

◆ makeDefaultRawIngestRunName()

str lsst.obs.base._instrument.Instrument.makeDefaultRawIngestRunName (   cls)
Make the default instrument-specific run collection string for raw
data ingest.

Returns
-------
coll : `str`
    Run collection name to be used as the default for ingestion of
    raws.

Definition at line 512 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 167 of file _instrument.py.

◆ writeAdditionalCuratedCalibrations()

def lsst.obs.base._instrument.Instrument.writeAdditionalCuratedCalibrations (   self,
  butler,
  run = None 
)
Write additional curated calibrations that might be instrument
specific and are not part of the standard set.

Default implementation does nothing.

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler to use to store these calibrations.
run : `str`, optional
    Name of the run to use to override the default run associated
    with this Butler.

Definition at line 321 of file _instrument.py.

◆ writeCameraGeom()

def lsst.obs.base._instrument.Instrument.writeCameraGeom (   self,
  butler,
  run = None 
)
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.
run : `str`, optional
    Name of the run to use to override the default run associated
    with this Butler.

Definition at line 353 of file _instrument.py.

◆ writeCuratedCalibrations()

def lsst.obs.base._instrument.Instrument.writeCuratedCalibrations (   self,
  butler,
  run = None 
)
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.
run : `str`
    Run to use for this collection of calibrations. If `None` the
    collection name is worked out automatically from the instrument
    name and other metadata.

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

Definition at line 293 of file _instrument.py.

◆ writeStandardTextCuratedCalibrations()

def lsst.obs.base._instrument.Instrument.writeStandardTextCuratedCalibrations (   self,
  butler,
  run = None 
)
Write the set of standardized curated text calibrations to
the repository.

Parameters
----------
butler : `lsst.daf.butler.Butler`
    Butler to receive these calibration datasets.
run : `str`, optional
    Name of the run to use to override the default run associated
    with this Butler.

Definition at line 373 of file _instrument.py.


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