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:

instrumentstr, optional

Name of the instrument the data was taken with.

calibTypestr, optional

Type of calibration this provenance was generated for.

detectorNamestr, optional

Name of the detector this calibration is for.

detectorSerialstr, optional

Identifier for the detector.

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.
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.
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 provenance information.
toTable()	Return a list of tables containing the provenance.
updateMetadata([setDate])	Update calibration metadata.
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:

targetobject

Thing to validate against.

Returns:

validbool

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:

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

metadatadict or lsst.daf.base.PropertyList

Metadata possibly containing a calibration class entry.

messagestr

Message to include in any errors.

Returns:

calibClassobject

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).

fromDataIds(dataIdList)

Update provenance from dataId List.

Parameters:

dataIdListlist [lsst.daf.butler.DataId]

List of dataIds used in generating this calibration.

fromDetector(detector)

Modify the calibration parameters to match the supplied detector.

Parameters:

detectorlsst.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)

Construct provenance from a dictionary.

Parameters:

dictionarydict

Dictionary of provenance parameters.

Returns:

provenancelsst.ip.isr.IsrProvenance

The provenance defined in the tables.

classmethod fromTable(tableList)

Construct provenance from table list.

Parameters:

tableListlist [lsst.afw.table.Table]

List of tables to construct the provenance from.

Returns:

provenancelsst.ip.isr.IsrProvenance

The provenance defined in the tables.

getMetadata()

Retrieve metadata associated with this calibration.

Returns:

metalsst.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:

filenamestr

Filename to read data from.

kwargsdict or collections.abc.Mapping`, optional

Set of key=value pairs to pass to the fromTable method.

Returns:

caliblsst.ip.isr.IsrCalib

Calibration contained within the file.

classmethod readText(filename, **kwargs)

Read calibration representation from a yaml/ecsv file.

Parameters:

filenamestr

Name of the file containing the calibration definition.

kwargsdict or collections.abc.Mapping`, optional

Set of key=value pairs to pass to the fromDict or fromTable methods.

Returns:

calibIsrCalibType

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:

metadatalsst.daf.base.PropertyList

Metadata to associate with the calibration. Will be copied and overwrite existing metadata.

toDict()

Return a dictionary containing the provenance information.

Returns:

dictionarydict

Dictionary of provenance.

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:

tableListlist [lsst.afw.table.Table]

List of tables containing the provenance information

updateMetadata(setDate=False, **kwargs)

Update calibration metadata.

Parameters:

setDatebool, optional

Update the CALIBDATE fields in the metadata to the current time. Defaults to False.

kwargsdict or collections.abc.Mapping, optional

Other keyword parameters to set in the metadata.

validate(other=None)

Validate that this calibration is defined and can be used.

Parameters:

otherobject, optional

Thing to validate against.

Returns:

validbool

Returns true if the calibration is valid and appropriate.

writeFits(filename)

Write calibration data to a FITS file.

Parameters:

filenamestr

Filename to write data to.

Returns:

usedstr

The name of the file used to write the data.

writeText(filename, format='auto')

Write the calibration data to a text file.

Parameters:

filenamestr

Name of the file to write.

formatstr

Format to write the file as. Supported values are:

"auto" : Determine filetype from filename. "yaml" : Write as yaml. "ecsv" : Write as ecsv.

Returns:

usedstr

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.