lsst.obs.base
19.0.0-51-gb87bce2
|
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) |
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 43 of file instrument.py.
def lsst.obs.base.instrument.Instrument.__init__ | ( | self, | |
* | args, | ||
** | kwargs | ||
) |
Definition at line 83 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 215 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 77 of file instrument.py.
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 name property of an instrument class). 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 120 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 94 of file instrument.py.
def lsst.obs.base.instrument.Instrument.getName | ( | cls | ) |
Definition at line 90 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 181 of file instrument.py.
def lsst.obs.base.instrument.Instrument.obsDataPackageDir | ( | self | ) |
Definition at line 110 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 103 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 231 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 198 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 248 of file instrument.py.
|
static |
Definition at line 50 of file instrument.py.
|
static |
Definition at line 61 of file instrument.py.
|
static |
Definition at line 57 of file instrument.py.
|
static |
Definition at line 66 of file instrument.py.