|
lsst.obs.base
20.0.0-69-g8f355a9+701c885a11
|
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`
Mapping Policy.
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 389 of file mapping.py.
| def lsst.obs.base.mapping.CalibrationMapping.__init__ | ( | self, | |
| datasetType, | |||
| policy, | |||
| registry, | |||
| calibRegistry, | |||
| calibRoot, | |||
dataRoot = None, |
|||
| ** | kwargs | ||
| ) |
Definition at line 443 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 135 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.
Reimplemented from lsst.obs.base.mapping.Mapping.
Definition at line 466 of file mapping.py.
| def lsst.obs.base.mapping.CalibrationMapping.map | ( | self, | |
| mapper, | |||
| dataId, | |||
write = False |
|||
| ) |
Standard implementation of map function.
Parameters
----------
mapper: `lsst.daf.persistence.Mapper`
Object to be mapped.
dataId: `dict`
Dataset identifier.
Returns
-------
lsst.daf.persistence.ButlerLocation
Location of object that was mapped.
Reimplemented from lsst.obs.base.mapping.Mapping.
Definition at line 459 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 | |||
| ) |
Default standardization function for calibration datasets.
If the item is of a type that should be standardized, the base class
``standardizeExposure`` method is called, otherwise the item is
returned unmodified.
Parameters
----------
mapping : `lsst.obs.base.Mapping`
Mapping object to pass through.
item : object
Will be standardized if of type lsst.afw.image.Exposure,
lsst.afw.image.DecoratedImage, lsst.afw.image.Image
or lsst.afw.image.MaskedImage
dataId : `dict`
Dataset identifier
Returns
-------
`lsst.afw.image.Exposure` or item
The standardized object.
Definition at line 521 of file mapping.py.
|
inherited |
Definition at line 128 of file mapping.py.
| lsst.obs.base.mapping.CalibrationMapping.columns |
Definition at line 452 of file mapping.py.
| lsst.obs.base.mapping.CalibrationMapping.dataRoot |
Definition at line 448 of file mapping.py.
|
inherited |
Definition at line 89 of file mapping.py.
|
inherited |
Definition at line 102 of file mapping.py.
|
inherited |
Definition at line 117 of file mapping.py.
| lsst.obs.base.mapping.CalibrationMapping.metadataKeys |
Definition at line 455 of file mapping.py.
|
inherited |
Definition at line 124 of file mapping.py.
|
inherited |
Definition at line 114 of file mapping.py.
|
inherited |
Definition at line 113 of file mapping.py.
| lsst.obs.base.mapping.CalibrationMapping.range |
Definition at line 450 of file mapping.py.
|
inherited |
Definition at line 125 of file mapping.py.
| lsst.obs.base.mapping.CalibrationMapping.refCols |
Definition at line 446 of file mapping.py.
| lsst.obs.base.mapping.CalibrationMapping.reference |
Definition at line 445 of file mapping.py.
| lsst.obs.base.mapping.CalibrationMapping.refRegistry |
Definition at line 447 of file mapping.py.
|
inherited |
Definition at line 90 of file mapping.py.
|
inherited |
Definition at line 91 of file mapping.py.
| lsst.obs.base.mapping.CalibrationMapping.setFilter |
Definition at line 454 of file mapping.py.
|
inherited |
Definition at line 115 of file mapping.py.
|
inherited |
Definition at line 119 of file mapping.py.
1.8.18