lsst.obs.base
15.0-6-g86eaddf
|
Public Member Functions | |
def | __init__ (self, datasetType, policy, registry, calibRegistry, calibRoot, dataRoot=None, kwargs) |
def | map (self, mapper, dataId, write=False) |
def | lookup (self, properties, dataId) |
def | standardize (self, mapper, item, dataId) |
def | template (self) |
def | keys (self) |
def | have (self, properties, dataId) |
def | need (self, properties, dataId) |
Public Attributes | |
reference | |
refCols | |
refRegistry | |
dataRoot | |
range | |
columns | |
setFilter | |
metadataKeys | |
datasetType | |
registry | |
rootStorage | |
keyDict | |
python | |
persistable | |
storage | |
level | |
tables | |
obsTimeName | |
recipe | |
CalibrationMapping is a Mapping subclass for calibration-type products. The difference is that data properties in the query or template can be looked up using a reference Mapping in addition to this one. CalibrationMapping Policies can contain the following: reference (string, optional) a list of tables for finding missing dataset identifier components (including the observation time, if a validity range is required) in the exposure registry; note that the "tables" entry refers to the calibration registry refCols (string, optional) a list of dataset properties required from the reference tables for lookups in the calibration registry validRange (bool) true if the calibration dataset has a validity range specified by a column in the tables of the reference dataset in the exposure registry) and two columns in the tables of this calibration dataset in the calibration registry) obsTimeName (string, optional) the name of the column in the reference dataset tables containing the observation time (default "taiObs") validStartName (string, optional) the name of the column in the calibration dataset tables containing the start of the validity range (default "validStart") validEndName (string, optional) the name of the column in the calibration dataset tables containing the end of the validity range (default "validEnd") Parameters ---------- datasetType : `str` Butler dataset type to be mapped. policy : `daf_persistence.Policy` or `pexPolicy.Policy` Mapping Policy (pexPolicy only for backward compatibility) registry : `lsst.obs.base.Registry` Registry for metadata lookups calibRegistry : `lsst.obs.base.Registry` Registry for calibration metadata lookups. calibRoot : `str` Path of calibration root directory. dataRoot : `str` Path of data root directory; used for outputs only.
Definition at line 393 of file mapping.py.
def lsst.obs.base.mapping.CalibrationMapping.__init__ | ( | self, | |
datasetType, | |||
policy, | |||
registry, | |||
calibRegistry, | |||
calibRoot, | |||
dataRoot = None , |
|||
kwargs | |||
) |
Definition at line 447 of file mapping.py.
|
inherited |
Returns whether the provided data identifier has all the properties in the provided list. Parameters ---------- properties : `list of `str` Properties required. dataId : `dict` Dataset identifier. Returns ------- bool True if all properties are present.
Definition at line 275 of file mapping.py.
|
inherited |
Return the dict of keys and value types required for this mapping.
Definition at line 139 of file mapping.py.
def lsst.obs.base.mapping.CalibrationMapping.lookup | ( | self, | |
properties, | |||
dataId | |||
) |
Look up properties for in a metadata registry given a partial dataset identifier. Parameters ---------- properties : `list` of `str` Properties to look up. dataId : `dict` Dataset identifier. Returns ------- `list` of `tuple` Values of properties.
Definition at line 472 of file mapping.py.
def lsst.obs.base.mapping.CalibrationMapping.map | ( | self, | |
mapper, | |||
dataId, | |||
write = False |
|||
) |
Definition at line 465 of file mapping.py.
|
inherited |
Ensures all properties in the provided list are present in the data identifier, looking them up as needed. This is only possible for the case where the data identifies a single exposure. Parameters ---------- properties : `list` of `str` Properties required. dataId : `dict` Partial dataset identifier Returns ------- `dict` Copy of dataset identifier with enhanced values.
Definition at line 296 of file mapping.py.
def lsst.obs.base.mapping.CalibrationMapping.standardize | ( | self, | |
mapper, | |||
item, | |||
dataId | |||
) |
Definition at line 526 of file mapping.py.
|
inherited |
Definition at line 132 of file mapping.py.
lsst.obs.base.mapping.CalibrationMapping.columns |
Definition at line 458 of file mapping.py.
lsst.obs.base.mapping.CalibrationMapping.dataRoot |
Definition at line 454 of file mapping.py.
|
inherited |
Definition at line 95 of file mapping.py.
|
inherited |
Definition at line 106 of file mapping.py.
|
inherited |
Definition at line 121 of file mapping.py.
lsst.obs.base.mapping.CalibrationMapping.metadataKeys |
Definition at line 461 of file mapping.py.
|
inherited |
Definition at line 128 of file mapping.py.
|
inherited |
Definition at line 118 of file mapping.py.
|
inherited |
Definition at line 117 of file mapping.py.
lsst.obs.base.mapping.CalibrationMapping.range |
Definition at line 456 of file mapping.py.
|
inherited |
Definition at line 129 of file mapping.py.
lsst.obs.base.mapping.CalibrationMapping.refCols |
Definition at line 452 of file mapping.py.
lsst.obs.base.mapping.CalibrationMapping.reference |
Definition at line 451 of file mapping.py.
lsst.obs.base.mapping.CalibrationMapping.refRegistry |
Definition at line 453 of file mapping.py.
|
inherited |
Definition at line 96 of file mapping.py.
|
inherited |
Definition at line 97 of file mapping.py.
lsst.obs.base.mapping.CalibrationMapping.setFilter |
Definition at line 460 of file mapping.py.
|
inherited |
Definition at line 119 of file mapping.py.
|
inherited |
Definition at line 123 of file mapping.py.