lsst.obs.base
19.0.0-72-g37abf38
|
Public Member Functions | |
def | filterDefinitions (self) |
def | __init__ (self) |
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) |
TranslatorFactory | makeDataIdTranslatorFactory (self) |
Static Public Member Functions | |
Instrument | fromName (str name, Registry registry) |
None | importAll (Registry registry) |
Static Public Attributes | |
tuple | configPaths = () |
policyName = None | |
obsDataPackage = None | |
standardCuratedDatasetTypes = tuple(StandardCuratedCalibrationDatasetTypes) | |
Base class for instrument-specific logic for the Gen3 Butler. Concrete instrument subclasses should be directly constructable with no arguments.
Definition at line 49 of file _instrument.py.
def lsst.obs.base._instrument.Instrument.__init__ | ( | self | ) |
Definition at line 89 of file _instrument.py.
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 254 of file _instrument.py.
def lsst.obs.base._instrument.Instrument.filterDefinitions | ( | self | ) |
`~lsst.obs.base.FilterDefinitionCollection`, defining the filters for this instrument.
Definition at line 83 of file _instrument.py.
|
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 135 of file _instrument.py.
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 106 of file _instrument.py.
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 96 of file _instrument.py.
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 220 of file _instrument.py.
|
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 173 of file _instrument.py.
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 382 of file _instrument.py.
def lsst.obs.base._instrument.Instrument.obsDataPackageDir | ( | self | ) |
The root of the obs package that provides specializations for this instrument (`str`).
Definition at line 122 of file _instrument.py.
def lsst.obs.base._instrument.Instrument.register | ( | self, | |
registry | |||
) |
Insert instrument, physical_filter, and detector entries into a `Registry`.
Definition at line 115 of file _instrument.py.
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 270 of file _instrument.py.
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 237 of file _instrument.py.
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 287 of file _instrument.py.
|
static |
Definition at line 56 of file _instrument.py.
|
static |
Definition at line 67 of file _instrument.py.
|
static |
Definition at line 63 of file _instrument.py.
|
static |
Definition at line 72 of file _instrument.py.