LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Public Member Functions | |
def | __init__ (self, calibType="unknown", **kwargs) |
def | __str__ (self) |
def | __eq__ (self, other) |
def | updateMetadata (self, setDate=False, **kwargs) |
def | fromDataIds (self, dataIdList) |
def | fromTable (cls, tableList) |
def | fromDict (cls, dictionary) |
def | toDict (self) |
def | toTable (self) |
def | requiredAttributes (self) |
def | requiredAttributes (self, value) |
def | getMetadata (self) |
def | setMetadata (self, metadata) |
def | updateMetadata (self, camera=None, detector=None, filterName=None, setCalibId=False, setCalibInfo=False, setDate=False, **kwargs) |
def | calibInfoFromDict (self, dictionary) |
def | determineCalibClass (cls, metadata, message) |
def | readText (cls, filename, **kwargs) |
def | writeText (self, filename, format="auto") |
def | readFits (cls, filename, **kwargs) |
def | writeFits (self, filename) |
def | fromDetector (self, detector) |
def | fromDict (cls, dictionary, **kwargs) |
def | fromTable (cls, tableList, **kwargs) |
def | validate (self, other=None) |
def | apply (self, target) |
Public Attributes | |
calibType | |
dimensions | |
dataIdList | |
requiredAttributes | |
log | |
Class for the provenance of data used to construct calibration. Provenance is not really a calibration, but we would like to record this when constructing the calibration, and it provides an example of the base calibration class. Parameters ---------- instrument : `str`, optional Name of the instrument the data was taken with. calibType : `str`, optional Type of calibration this provenance was generated for. detectorName : `str`, optional Name of the detector this calibration is for. detectorSerial : `str`, optional Identifier for the detector.
Definition at line 633 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.__init__ | ( | self, | |
calibType = "unknown" , |
|||
** | kwargs | ||
) |
Definition at line 654 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.__eq__ | ( | self, | |
other | |||
) |
Calibration equivalence. Running ``calib.log.setLevel(0)`` enables debug statements to identify problematic fields.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 667 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.__str__ | ( | self | ) |
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 664 of file calibType.py.
|
inherited |
Method to apply the calibration to the target object. Parameters ---------- target : `object` Thing to validate against. Returns ------- valid : `bool` Returns true if the calibration was applied correctly. Raises ------ NotImplementedError : Raised if not implemented.
Definition at line 612 of file calibType.py.
|
inherited |
Handle common keywords. This isn't an ideal solution, but until all calibrations expect to find everything in the metadata, they still need to search through dictionaries. Parameters ---------- dictionary : `dict` or `lsst.daf.base.PropertyList` Source for the common keywords. Raises ------ RuntimeError : Raised if the dictionary does not match the expected OBSTYPE.
Definition at line 261 of file calibType.py.
|
inherited |
Attempt to find calibration class in metadata. Parameters ---------- metadata : `dict` or `lsst.daf.base.PropertyList` Metadata possibly containing a calibration class entry. message : `str` Message to include in any errors. Returns ------- calibClass : `object` The class to use to read the file contents. Should be an `lsst.ip.isr.IsrCalib` subclass. Raises ------ ValueError : Raised if the resulting calibClass is the base `lsst.ip.isr.IsrClass` (which does not implement the content methods).
Definition at line 316 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.fromDataIds | ( | self, | |
dataIdList | |||
) |
Update provenance from dataId List. Parameters ---------- dataIdList : `list` [`lsst.daf.butler.DataId`] List of dataIds used in generating this calibration.
Definition at line 684 of file calibType.py.
|
inherited |
Modify the calibration parameters to match the supplied detector. Parameters ---------- detector : `lsst.afw.cameraGeom.Detector` Detector to use to set parameters from. Raises ------ NotImplementedError This needs to be implemented by subclasses for each calibration type.
Reimplemented in lsst.ip.isr.linearize.Linearizer.
Definition at line 495 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.fromDict | ( | cls, | |
dictionary | |||
) |
Construct provenance from a dictionary. Parameters ---------- dictionary : `dict` Dictionary of provenance parameters. Returns ------- provenance : `lsst.ip.isr.IsrProvenance` The provenance defined in the tables.
Definition at line 735 of file calibType.py.
|
inherited |
Construct a calibration from a dictionary of properties. Must be implemented by the specific calibration subclasses. Parameters ---------- dictionary : `dict` Dictionary of properties. kwargs : `dict` or collections.abc.Mapping`, optional Set of key=value options. Returns ------ calib : `lsst.ip.isr.CalibType` Constructed calibration. Raises ------ NotImplementedError : Raised if not implemented.
Definition at line 512 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.fromTable | ( | cls, | |
tableList | |||
) |
Construct provenance from table list. Parameters ---------- tableList : `list` [`lsst.afw.table.Table`] List of tables to construct the provenance from. Returns ------- provenance : `lsst.ip.isr.IsrProvenance` The provenance defined in the tables.
Definition at line 699 of file calibType.py.
|
inherited |
Construct a calibration from a dictionary of properties. Must be implemented by the specific calibration subclasses. Parameters ---------- tableList : `list` [`lsst.afw.table.Table`] List of tables of properties. kwargs : `dict` or collections.abc.Mapping`, optional Set of key=value options. Returns ------ calib : `lsst.ip.isr.CalibType` Constructed calibration. Raises ------ NotImplementedError : Raised if not implemented.
Definition at line 555 of file calibType.py.
|
inherited |
Retrieve metadata associated with this calibration. Returns ------- meta : `lsst.daf.base.PropertyList` Metadata. The returned `~lsst.daf.base.PropertyList` can be modified by the caller and the changes will be written to external files.
Definition at line 145 of file calibType.py.
|
inherited |
Read calibration data from a FITS file. Parameters ---------- filename : `str` Filename to read data from. kwargs : `dict` or collections.abc.Mapping`, optional Set of key=value pairs to pass to the ``fromTable`` method. Returns ------- calib : `lsst.ip.isr.IsrCalib` Calibration contained within the file.
Definition at line 432 of file calibType.py.
|
inherited |
Read calibration representation from a yaml/ecsv file. Parameters ---------- filename : `str` Name of the file containing the calibration definition. kwargs : `dict` or collections.abc.Mapping`, optional Set of key=value pairs to pass to the ``fromDict`` or ``fromTable`` methods. Returns ------- calib : `~lsst.ip.isr.IsrCalibType` Calibration class. Raises ------ RuntimeError : Raised if the filename does not end in ".ecsv" or ".yaml".
Definition at line 346 of file calibType.py.
|
inherited |
Definition at line 138 of file calibType.py.
|
inherited |
Definition at line 142 of file calibType.py.
|
inherited |
Store a copy of the supplied metadata with this calibration. Parameters ---------- metadata : `lsst.daf.base.PropertyList` Metadata to associate with the calibration. Will be copied and overwrite existing metadata.
Definition at line 157 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.toDict | ( | self | ) |
Return a dictionary containing the provenance information. Returns ------- dictionary : `dict` Dictionary of provenance.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 764 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.toTable | ( | self | ) |
Return a list of tables containing the provenance. This seems inefficient and slow, so this may not be the best way to store the data. Returns ------- tableList : `list` [`lsst.afw.table.Table`] List of tables containing the provenance information
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 788 of file calibType.py.
|
inherited |
Update metadata keywords with new values. Parameters ---------- camera : `lsst.afw.cameraGeom.Camera`, optional Reference camera to use to set _instrument field. detector : `lsst.afw.cameraGeom.Detector`, optional Reference detector to use to set _detector* fields. filterName : `str`, optional Filter name to assign to this calibration. setCalibId : `bool`, optional Construct the _calibId field from other fields. setCalibInfo : `bool`, optional Set calibration parameters from metadata. setDate : `bool`, optional Ensure the metadata CALIBDATE fields are set to the current datetime. kwargs : `dict` or `collections.abc.Mapping`, optional Set of key=value pairs to assign to the metadata.
Definition at line 179 of file calibType.py.
def lsst.ip.isr.calibType.IsrProvenance.updateMetadata | ( | self, | |
setDate = False , |
|||
** | kwargs | ||
) |
Update calibration metadata. Parameters ---------- setDate : `bool, optional Update the CALIBDATE fields in the metadata to the current time. Defaults to False. kwargs : `dict` or `collections.abc.Mapping`, optional Other keyword parameters to set in the metadata.
Definition at line 670 of file calibType.py.
|
inherited |
Validate that this calibration is defined and can be used. Parameters ---------- other : `object`, optional Thing to validate against. Returns ------- valid : `bool` Returns true if the calibration is valid and appropriate.
Definition at line 597 of file calibType.py.
|
inherited |
Write calibration data to a FITS file. Parameters ---------- filename : `str` Filename to write data to. Returns ------- used : `str` The name of the file used to write the data.
Definition at line 471 of file calibType.py.
|
inherited |
Write the calibration data to a text file. Parameters ---------- filename : `str` Name of the file to write. format : `str` Format to write the file as. Supported values are: ``"auto"`` : Determine filetype from filename. ``"yaml"`` : Write as yaml. ``"ecsv"`` : Write as ecsv. Returns ------- used : `str` The name of the file used to write the data. This may differ from the input if the format is explicitly chosen. Raises ------ RuntimeError : Raised if filename does not end in a known extension, or if all information cannot be written. Notes ----- The file is written to YAML/ECSV format and will include any associated metadata.
Definition at line 379 of file calibType.py.
lsst.ip.isr.calibType.IsrProvenance.calibType |
Definition at line 656 of file calibType.py.
lsst.ip.isr.calibType.IsrProvenance.dataIdList |
Definition at line 658 of file calibType.py.
lsst.ip.isr.calibType.IsrProvenance.dimensions |
Definition at line 657 of file calibType.py.
|
inherited |
Definition at line 86 of file calibType.py.
|
inherited |
Definition at line 81 of file calibType.py.