IsrProvenance¶
- class lsst.ip.isr.IsrProvenance(calibType='unknown', **kwargs)¶
Bases:
IsrCalib
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:
Attributes Summary
Methods Summary
apply
(target)Method to apply the calibration to the target object.
calibInfoFromDict
(dictionary)Handle common keywords.
determineCalibClass
(metadata, message)Attempt to find calibration class in metadata.
fromDataIds
(dataIdList)Update provenance from dataId List.
fromDetector
(detector)Modify the calibration parameters to match the supplied detector.
fromDict
(dictionary)Construct provenance from a dictionary.
fromTable
(tableList)Construct provenance from table list.
Retrieve metadata associated with this calibration.
readFits
(filename, **kwargs)Read calibration data from a FITS file.
readText
(filename, **kwargs)Read calibration representation from a yaml/ecsv file.
setMetadata
(metadata)Store a copy of the supplied metadata with this calibration.
toDict
()Return a dictionary containing the provenance information.
toTable
()Return a list of tables containing the provenance.
updateMetadata
([setDate])Update calibration metadata.
updateMetadataFromExposures
(exposures)Extract and unify metadata information.
validate
([other])Validate that this calibration is defined and can be used.
writeFits
(filename)Write calibration data to a FITS file.
writeText
(filename[, format])Write the calibration data to a text file.
Attributes Documentation
- requiredAttributes¶
Methods Documentation
- apply(target)¶
Method to apply the calibration to the target object.
- calibInfoFromDict(dictionary)¶
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
orlsst.daf.base.PropertyList
Source for the common keywords.
- dictionary
- Raises:
- RuntimeError
Raised if the dictionary does not match the expected OBSTYPE.
- classmethod determineCalibClass(metadata, message)¶
Attempt to find calibration class in metadata.
- Parameters:
- Returns:
- calibClass
object
The class to use to read the file contents. Should be an
lsst.ip.isr.IsrCalib
subclass.
- calibClass
- Raises:
- ValueError
Raised if the resulting calibClass is the base
lsst.ip.isr.IsrClass
(which does not implement the content methods).
- fromDataIds(dataIdList)¶
Update provenance from dataId List.
- Parameters:
- dataIdList
list
[lsst.daf.butler.DataId
] List of dataIds used in generating this calibration.
- dataIdList
- fromDetector(detector)¶
Modify the calibration parameters to match the supplied detector.
- Parameters:
- detector
lsst.afw.cameraGeom.Detector
Detector to use to set parameters from.
- detector
- Raises:
- NotImplementedError
Raised if not implemented by a subclass. This needs to be implemented by subclasses for each calibration type.
- classmethod fromDict(dictionary)¶
Construct provenance from a dictionary.
- Parameters:
- dictionary
dict
Dictionary of provenance parameters.
- dictionary
- Returns:
- provenance
lsst.ip.isr.IsrProvenance
The provenance defined in the tables.
- provenance
- classmethod fromTable(tableList)¶
Construct provenance from table list.
- Parameters:
- tableList
list
[lsst.afw.table.Table
] List of tables to construct the provenance from.
- tableList
- Returns:
- provenance
lsst.ip.isr.IsrProvenance
The provenance defined in the tables.
- provenance
- getMetadata()¶
Retrieve metadata associated with this calibration.
- Returns:
- meta
lsst.daf.base.PropertyList
Metadata. The returned
PropertyList
can be modified by the caller and the changes will be written to external files.
- meta
- classmethod readFits(filename, **kwargs)¶
Read calibration data from a FITS file.
- Parameters:
- Returns:
- calib
lsst.ip.isr.IsrCalib
Calibration contained within the file.
- calib
- classmethod readText(filename, **kwargs)¶
Read calibration representation from a yaml/ecsv file.
- Parameters:
- Returns:
- calib
IsrCalibType
Calibration class.
- calib
- Raises:
- RuntimeError
Raised if the filename does not end in “.ecsv” or “.yaml”.
- setMetadata(metadata)¶
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.
- metadata
- toDict()¶
Return a dictionary containing the provenance information.
- Returns:
- dictionary
dict
Dictionary of provenance.
- dictionary
- toTable()¶
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
- tableList
- updateMetadata(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
orcollections.abc.Mapping
, optional Other keyword parameters to set in the metadata.
- setDate
- updateMetadataFromExposures(exposures)¶
Extract and unify metadata information.
- Parameters:
- exposures
list
Exposures or other calibrations to scan.
- exposures
- validate(other=None)¶
Validate that this calibration is defined and can be used.
- writeFits(filename)¶
Write calibration data to a FITS file.
- writeText(filename, format='auto')¶
Write the calibration data to a text file.
- Parameters:
- 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.
- used
- 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.