IsrCalib

class lsst.ip.isr.IsrCalib(camera=None, detector=None, log=None, **kwargs)

Bases: abc.ABC

Generic calibration type.

Subclasses must implement the toDict, fromDict, toTable, fromTable methods that allow the calibration information to be converted from dictionaries and afw tables. This will allow the calibration to be persisted using the base class read/write methods.

The validate method is intended to provide a common way to check that the calibration is valid (internally consistent) and appropriate (usable with the intended data). The apply method is intended to allow the calibration to be applied in a consistent manner.

Parameters:
camera : lsst.afw.cameraGeom.Camera, optional

Camera to extract metadata from.

detector : lsst.afw.cameraGeom.Detector, optional

Detector to extract metadata from.

log : logging.Logger, optional

Log for messages.

Attributes Summary

requiredAttributes

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.
fromDetector(detector) Modify the calibration parameters to match the supplied detector.
fromDict(dictionary, **kwargs) Construct a calibration from a dictionary of properties.
fromTable(tableList, **kwargs) Construct a calibration from a dictionary of properties.
getMetadata() 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 calibration properties.
toTable() Return a list of tables containing the calibration properties.
updateMetadata([camera, detector, …]) Update metadata keywords with new values.
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.

Parameters:
target : object

Thing to validate against.
Returns:
valid : bool

Returns true if the calibration was applied correctly.
Raises:
NotImplementedError

Raised if not implemented.
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 or lsst.daf.base.PropertyList

Source for the common keywords.
Raises:
RuntimeError

Raised if the dictionary does not match the expected OBSTYPE.
classmethod determineCalibClass(metadata, message)

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).
fromDetector(detector)

Modify the calibration parameters to match the supplied detector.

Parameters:
detector : lsst.afw.cameraGeom.Detector

Detector to use to set parameters from.
Raises:
NotImplementedError

Raised if not implemented by a subclass. This needs to be implemented by subclasses for each calibration type.
classmethod fromDict(dictionary, **kwargs)

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.
classmethod fromTable(tableList, **kwargs)

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.
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.
classmethod readFits(filename, **kwargs)

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.
classmethod readText(filename, **kwargs)

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 : IsrCalibType

Calibration class.
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.
toDict()

Return a dictionary containing the calibration properties.

The dictionary should be able to be round-tripped through fromDict.

Returns:
dictionary : dict

Dictionary of properties.
Raises:
NotImplementedError

Raised if not implemented.
toTable()

Return a list of tables containing the calibration properties.

The table list should be able to be round-tripped through fromDict.

Returns:
tableList : list [lsst.afw.table.Table]

List of tables of properties.
Raises:
NotImplementedError

Raised if not implemented.
updateMetadata(camera=None, detector=None, filterName=None, setCalibId=False, setCalibInfo=False, setDate=False, **kwargs)

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.
validate(other=None)

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.
writeFits(filename)

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.
writeText(filename, format='auto')

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.