Inheritance diagram for lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset:

Public Member Functions
def	__init__ (self, ampNames=[], ptcFitType=None, covMatrixSide=1, **kwargs)

def	setAmpValues (self, ampName, inputExpIdPair=[(np.nan, np.nan)], expIdMask=[np.nan], rawExpTime=[np.nan], rawMean=[np.nan], rawVar=[np.nan], photoCharge=[np.nan], gain=np.nan, gainErr=np.nan, noise=np.nan, noiseErr=np.nan, ptcFitPars=[np.nan], ptcFitParsError=[np.nan], ptcFitChiSq=np.nan, covArray=[], covArrayModel=[], covSqrtWeights=[], aMatrix=[], bMatrix=[], covArrayModelNoB=[], aMatrixNoB=[], finalVar=[np.nan], finalModelVar=[np.nan], finalMean=[np.nan])

def	updateMetadata (self, setDate=False, **kwargs)

def	fromDict (cls, dictionary)

def	toDict (self)

def	fromTable (cls, tableList)

def	toTable (self)

def	getExpIdsUsed (self, ampName)

def	getGoodAmps (self)

def	requiredAttributes (self)

def	requiredAttributes (self, value)

def	__str__ (self)

def	__eq__ (self, other)

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)

Detailed Description

A simple class to hold the output data from the PTC task.
The dataset is made up of a dictionary for each item, keyed by the
amplifiers' names, which much be supplied at construction time.
New items cannot be added to the class to save accidentally saving to the
wrong property, and the class can be frozen if desired.
inputExpIdPairs records the exposures used to produce the data.
When fitPtc() or fitCovariancesAstier() is run, a mask is built up, which
is by definition always the same length as inputExpIdPairs, rawExpTimes,
rawMeans and rawVars, and is a list of bools, which are incrementally set
to False as points are discarded from the fits.
PTC fit parameters for polynomials are stored in a list in ascending order
of polynomial term, i.e. par[0]*x^0 + par[1]*x + par[2]*x^2 etc
with the length of the list corresponding to the order of the polynomial
plus one.

Parameters
----------
ampNames : `list`
    List with the names of the amplifiers of the detector at hand.

ptcFitType : `str`
    Type of model fitted to the PTC: "POLYNOMIAL", "EXPAPPROXIMATION",
    or "FULLCOVARIANCE".

covMatrixSide : `int`
    Maximum lag of covariances (size of square covariance matrices).

kwargs : `dict`, optional
    Other keyword arguments to pass to the parent init.

Notes
-----
The stored attributes are:
badAmps : `list`
    List with bad amplifiers names.
inputExpIdPairs : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the input exposures IDs.
expIdMask : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the mask produced after
    outlier rejection. The mask produced by the "FULLCOVARIANCE"
    option may differ from the one produced in the other two PTC
    fit types.
rawExpTimes : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the unmasked exposure times.
rawMeans : `dict`, [`str`, `list`]
    Dictionary keyed by amp namescontaining the unmasked average of the
    means of the exposures in each flat pair.
rawVars : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the variance of the
    difference image of the exposures in each flat pair.
gain : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the fitted gains.
gainErr : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the errors on the
    fitted gains.
noise : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the fitted noise.
noiseErr : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the errors on the fitted noise.
ptcFitPars : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the fitted parameters of the
    PTC model for ptcFitTye in ["POLYNOMIAL", "EXPAPPROXIMATION"].
ptcFitParsError : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the errors on the fitted
    parameters of the PTC model for ptcFitTye in
    ["POLYNOMIAL", "EXPAPPROXIMATION"].
ptcFitChiSq : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the reduced chi squared
    of the fit for ptcFitTye in ["POLYNOMIAL", "EXPAPPROXIMATION"].
covariances : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing a list of measured
    covariances per mean flux.
covariancesModel : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containinging covariances model
    (Eq. 20 of Astier+19) per mean flux.
covariancesSqrtWeights : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containinging sqrt. of covariances
    weights.
aMatrix : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the "a" parameters from
    the model in Eq. 20 of Astier+19.
bMatrix : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the "b" parameters from
    the model in Eq. 20 of Astier+19.
covariancesModelNoB : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing covariances model
    (with 'b'=0 in Eq. 20 of Astier+19)
    per mean flux.
aMatrixNoB : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the "a" parameters from the
    model in Eq. 20 of Astier+19
    (and 'b' = 0).
finalVars : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the masked variance of the
    difference image of each flat
    pair. If needed, each array will be right-padded with
    np.nan to match the length of rawExpTimes.
finalModelVars : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the masked modeled
    variance of the difference image of each flat pair. If needed, each
    array will be right-padded with np.nan to match the length of
    rawExpTimes.
finalMeans : `dict`, [`str`, `list`]
    Dictionary keyed by amp names containing the masked average of the
    means of the exposures in each flat pair. If needed, each array
    will be right-padded with np.nan to match the length of
    rawExpTimes.
photoCharge : `dict`, [`str`, `list`]
     Dictionary keyed by amp names containing the integrated photocharge
     for linearity calibration.

Returns
-------
`lsst.cp.pipe.ptc.PhotonTransferCurveDataset`
    Output dataset from MeasurePhotonTransferCurveTask.

Definition at line 33 of file ptcDataset.py.

Constructor & Destructor Documentation

◆ init()

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.__init__	(		self,
			ampNames = `[]`,
			ptcFitType = `None`,
			covMatrixSide = `1`,
		**	kwargs
	)

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 155 of file ptcDataset.py.

     def __init__(self, ampNames=[], ptcFitType=None, covMatrixSide=1, **kwargs):
  
         self.ptcFitType = ptcFitType
         self.ampNames = ampNames
         self.covMatrixSide = covMatrixSide
  
         self.badAmps = [np.nan]
  
         self.inputExpIdPairs = {ampName: [] for ampName in ampNames}
         self.expIdMask = {ampName: [] for ampName in ampNames}
         self.rawExpTimes = {ampName: [] for ampName in ampNames}
         self.rawMeans = {ampName: [] for ampName in ampNames}
         self.rawVars = {ampName: [] for ampName in ampNames}
         self.photoCharge = {ampName: [] for ampName in ampNames}
  
         self.gain = {ampName: np.nan for ampName in ampNames}
         self.gainErr = {ampName: np.nan for ampName in ampNames}
         self.noise = {ampName: np.nan for ampName in ampNames}
         self.noiseErr = {ampName: np.nan for ampName in ampNames}
  
         self.ptcFitPars = {ampName: [] for ampName in ampNames}
         self.ptcFitParsError = {ampName: [] for ampName in ampNames}
         self.ptcFitChiSq = {ampName: np.nan for ampName in ampNames}
  
         self.covariances = {ampName: [] for ampName in ampNames}
         self.covariancesModel = {ampName: [] for ampName in ampNames}
         self.covariancesSqrtWeights = {ampName: [] for ampName in ampNames}
         self.aMatrix = {ampName: np.nan for ampName in ampNames}
         self.bMatrix = {ampName: np.nan for ampName in ampNames}
         self.covariancesModelNoB = {ampName: [] for ampName in ampNames}
         self.aMatrixNoB = {ampName: np.nan for ampName in ampNames}
  
         self.finalVars = {ampName: [] for ampName in ampNames}
         self.finalModelVars = {ampName: [] for ampName in ampNames}
         self.finalMeans = {ampName: [] for ampName in ampNames}
  
         super().__init__(**kwargs)
         self.requiredAttributes.update(['badAmps', 'inputExpIdPairs', 'expIdMask', 'rawExpTimes',
                                         'rawMeans', 'rawVars', 'gain', 'gainErr', 'noise', 'noiseErr',
                                         'ptcFitPars', 'ptcFitParsError', 'ptcFitChiSq', 'aMatrixNoB',
                                         'covariances', 'covariancesModel', 'covariancesSqrtWeights',
                                         'covariancesModelNoB',
                                         'aMatrix', 'bMatrix', 'finalVars', 'finalModelVars', 'finalMeans',
                                         'photoCharge'])
  

Member Function Documentation

◆ eq()

def lsst.ip.isr.calibType.IsrCalib.__eq__	(	self,
		other
	)

inherited

Calibration equivalence.

Running ``calib.log.setLevel(0)`` enables debug statements to
identify problematic fields.

Reimplemented in lsst.ip.isr.defects.Defects, and lsst.ip.isr.calibType.IsrProvenance.

Definition at line 95 of file calibType.py.

     def __eq__(self, other):
         """Calibration equivalence.
  
         Running ``calib.log.setLevel(0)`` enables debug statements to
         identify problematic fields.
         """
         if not isinstance(other, self.__class__):
             self.log.debug("Incorrect class type: %s %s", self.__class__, other.__class__)
             return False
  
         for attr in self._requiredAttributes:
             attrSelf = getattr(self, attr)
             attrOther = getattr(other, attr)
  
             if isinstance(attrSelf, dict):
                 # Dictionary of arrays.
                 if attrSelf.keys() != attrOther.keys():
                     self.log.debug("Dict Key Failure: %s %s %s", attr, attrSelf.keys(), attrOther.keys())
                     return False
                 for key in attrSelf:
                     if not np.allclose(attrSelf[key], attrOther[key], equal_nan=True):
                         self.log.debug("Array Failure: %s %s %s", key, attrSelf[key], attrOther[key])
                         return False
             elif isinstance(attrSelf, np.ndarray):
                 # Bare array.
                 if not np.allclose(attrSelf, attrOther, equal_nan=True):
                     self.log.debug("Array Failure: %s %s %s", attr, attrSelf, attrOther)
                     return False
             elif type(attrSelf) != type(attrOther):
                 if set([attrSelf, attrOther]) == set([None, ""]):
                     # Fits converts None to "", but None is not "".
                     continue
                 self.log.debug("Type Failure: %s %s %s %s %s", attr, type(attrSelf), type(attrOther),
                                attrSelf, attrOther)
                 return False
             else:
                 if attrSelf != attrOther:
                     self.log.debug("Value Failure: %s %s %s", attr, attrSelf, attrOther)
                     return False
  
         return True
  

◆ str()

def lsst.ip.isr.calibType.IsrCalib.__str__ ( self )

inherited

Reimplemented in lsst.ip.isr.defects.Defects, and lsst.ip.isr.calibType.IsrProvenance.

Definition at line 92 of file calibType.py.

     def __str__(self):
         return f"{self.__class__.__name__}(obstype={self._OBSTYPE}, detector={self._detectorName}, )"
  

◆ apply()

def lsst.ip.isr.calibType.IsrCalib.apply	(	self,
		target
	)

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.

     def apply(self, 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.
         """
         raise NotImplementedError("Must be implemented by subclass.")
  
  

◆ calibInfoFromDict()

def lsst.ip.isr.calibType.IsrCalib.calibInfoFromDict	(	self,
		dictionary
	)

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.

     def calibInfoFromDict(self, 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.
  
         """
  
         def search(haystack, needles):
             """Search dictionary 'haystack' for an entry in 'needles'
             """
             test = [haystack.get(x) for x in needles]
             test = set([x for x in test if x is not None])
             if len(test) == 0:
                 if "metadata" in haystack:
                     return search(haystack["metadata"], needles)
                 else:
                     return None
             elif len(test) == 1:
                 value = list(test)[0]
                 if value == "":
                     return None
                 else:
                     return value
             else:
                 raise ValueError(f"Too many values found: {len(test)} {test} {needles}")
  
         if "metadata" in dictionary:
             metadata = dictionary["metadata"]
  
             if self._OBSTYPE != metadata["OBSTYPE"]:
                 raise RuntimeError(f"Incorrect calibration supplied.  Expected {self._OBSTYPE}, "
                                    f"found {metadata['OBSTYPE']}")
  
         self._instrument = search(dictionary, ["INSTRUME", "instrument"])
         self._raftName = search(dictionary, ["RAFTNAME"])
         self._slotName = search(dictionary, ["SLOTNAME"])
         self._detectorId = search(dictionary, ["DETECTOR", "detectorId"])
         self._detectorName = search(dictionary, ["DET_NAME", "DETECTOR_NAME", "detectorName"])
         self._detectorSerial = search(dictionary, ["DET_SER", "DETECTOR_SERIAL", "detectorSerial"])
         self._filter = search(dictionary, ["FILTER", "filterName"])
         self._calibId = search(dictionary, ["CALIB_ID"])
  

◆ determineCalibClass()

def lsst.ip.isr.calibType.IsrCalib.determineCalibClass	(	cls,
		metadata,
		message
	)

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 determineCalibClass(cls, 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).
         """
         calibClassName = metadata.get("CALIBCLS")
         calibClass = doImport(calibClassName) if calibClassName is not None else cls
         if calibClass is IsrCalib:
             raise ValueError(f"Cannot use base class to read calibration data: {msg}")
         return calibClass
  

◆ fromDetector()

def lsst.ip.isr.calibType.IsrCalib.fromDetector	(	self,
		detector
	)

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 fromDetector(self, 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
             This needs to be implemented by subclasses for each
             calibration type.
         """
         raise NotImplementedError("Must be implemented by subclass.")
  

◆ fromDict() [1/2]

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.fromDict	(	cls,
		dictionary
	)

Construct a calibration from a dictionary of properties.
Must be implemented by the specific calibration subclasses.
Parameters
----------
dictionary : `dict`
    Dictionary of properties.
Returns
-------
calib : `lsst.ip.isr.CalibType`
    Constructed calibration.
Raises
------
RuntimeError :
    Raised if the supplied dictionary is for a different
    calibration.

Definition at line 272 of file ptcDataset.py.

     def fromDict(cls, dictionary):
         """Construct a calibration from a dictionary of properties.
         Must be implemented by the specific calibration subclasses.
         Parameters
         ----------
         dictionary : `dict`
             Dictionary of properties.
         Returns
         -------
         calib : `lsst.ip.isr.CalibType`
             Constructed calibration.
         Raises
         ------
         RuntimeError :
             Raised if the supplied dictionary is for a different
             calibration.
         """
         calib = cls()
         if calib._OBSTYPE != dictionary['metadata']['OBSTYPE']:
             raise RuntimeError(f"Incorrect Photon Transfer Curve dataset  supplied. "
                                f"Expected {calib._OBSTYPE}, found {dictionary['metadata']['OBSTYPE']}")
         calib.setMetadata(dictionary['metadata'])
         calib.ptcFitType = dictionary['ptcFitType']
         calib.covMatrixSide = dictionary['covMatrixSide']
         calib.badAmps = np.array(dictionary['badAmps'], 'str').tolist()
         # The cov matrices are square
         covMatrixSide = calib.covMatrixSide
         # Number of final signal levels
         covDimensionsProduct = len(np.array(list(dictionary['covariances'].values())[0]).ravel())
         nSignalPoints = int(covDimensionsProduct/(covMatrixSide*covMatrixSide))
  
         for ampName in dictionary['ampNames']:
             calib.ampNames.append(ampName)
             calib.inputExpIdPairs[ampName] = np.array(dictionary['inputExpIdPairs'][ampName]).tolist()
             calib.expIdMask[ampName] = np.array(dictionary['expIdMask'][ampName]).tolist()
             calib.rawExpTimes[ampName] = np.array(dictionary['rawExpTimes'][ampName]).tolist()
             calib.rawMeans[ampName] = np.array(dictionary['rawMeans'][ampName]).tolist()
             calib.rawVars[ampName] = np.array(dictionary['rawVars'][ampName]).tolist()
             calib.gain[ampName] = np.array(dictionary['gain'][ampName]).tolist()
             calib.gainErr[ampName] = np.array(dictionary['gainErr'][ampName]).tolist()
             calib.noise[ampName] = np.array(dictionary['noise'][ampName]).tolist()
             calib.noiseErr[ampName] = np.array(dictionary['noiseErr'][ampName]).tolist()
             calib.ptcFitPars[ampName] = np.array(dictionary['ptcFitPars'][ampName]).tolist()
             calib.ptcFitParsError[ampName] = np.array(dictionary['ptcFitParsError'][ampName]).tolist()
             calib.ptcFitChiSq[ampName] = np.array(dictionary['ptcFitChiSq'][ampName]).tolist()
             calib.covariances[ampName] = np.array(dictionary['covariances'][ampName]).reshape(
                 (nSignalPoints, covMatrixSide, covMatrixSide)).tolist()
             calib.covariancesModel[ampName] = np.array(
                 dictionary['covariancesModel'][ampName]).reshape(
                     (nSignalPoints, covMatrixSide, covMatrixSide)).tolist()
             calib.covariancesSqrtWeights[ampName] = np.array(
                 dictionary['covariancesSqrtWeights'][ampName]).reshape(
                     (nSignalPoints, covMatrixSide, covMatrixSide)).tolist()
             calib.aMatrix[ampName] = np.array(dictionary['aMatrix'][ampName]).reshape(
                 (covMatrixSide, covMatrixSide)).tolist()
             calib.bMatrix[ampName] = np.array(dictionary['bMatrix'][ampName]).reshape(
                 (covMatrixSide, covMatrixSide)).tolist()
             calib.covariancesModelNoB[ampName] = np.array(
                 dictionary['covariancesModelNoB'][ampName]).reshape(
                     (nSignalPoints, covMatrixSide, covMatrixSide)).tolist()
             calib.aMatrixNoB[ampName] = np.array(
                 dictionary['aMatrixNoB'][ampName]).reshape((covMatrixSide, covMatrixSide)).tolist()
             calib.finalVars[ampName] = np.array(dictionary['finalVars'][ampName]).tolist()
             calib.finalModelVars[ampName] = np.array(dictionary['finalModelVars'][ampName]).tolist()
             calib.finalMeans[ampName] = np.array(dictionary['finalMeans'][ampName]).tolist()
             calib.photoCharge[ampName] = np.array(dictionary['photoCharge'][ampName]).tolist()
         calib.updateMetadata()
         return calib
  

◆ fromDict() [2/2]

def lsst.ip.isr.calibType.IsrCalib.fromDict	(		cls,
			dictionary,
		**	kwargs
	)

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 fromDict(cls, 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.
         """
         raise NotImplementedError("Must be implemented by subclass.")
  

◆ fromTable() [1/2]

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.fromTable	(	cls,
		tableList
	)

Construct calibration from a list of tables.
This method uses the `fromDict` method to create the
calibration, after constructing an appropriate dictionary from
the input tables.
Parameters
----------
tableList : `list` [`lsst.afw.table.Table`]
    List of tables to use to construct the datasetPtc.
Returns
-------
calib : `lsst.cp.pipe.`
    The calibration defined in the tables.

Definition at line 387 of file ptcDataset.py.

     def fromTable(cls, tableList):
         """Construct calibration from a list of tables.
         This method uses the `fromDict` method to create the
         calibration, after constructing an appropriate dictionary from
         the input tables.
         Parameters
         ----------
         tableList : `list` [`lsst.afw.table.Table`]
             List of tables to use to construct the datasetPtc.
         Returns
         -------
         calib : `lsst.cp.pipe.`
             The calibration defined in the tables.
         """
         ptcTable = tableList[0]
  
         metadata = ptcTable.meta
         inDict = dict()
         inDict['metadata'] = metadata
         inDict['ampNames'] = []
         inDict['ptcFitType'] = []
         inDict['covMatrixSide'] = []
         inDict['inputExpIdPairs'] = dict()
         inDict['expIdMask'] = dict()
         inDict['rawExpTimes'] = dict()
         inDict['rawMeans'] = dict()
         inDict['rawVars'] = dict()
         inDict['gain'] = dict()
         inDict['gainErr'] = dict()
         inDict['noise'] = dict()
         inDict['noiseErr'] = dict()
         inDict['ptcFitPars'] = dict()
         inDict['ptcFitParsError'] = dict()
         inDict['ptcFitChiSq'] = dict()
         inDict['covariances'] = dict()
         inDict['covariancesModel'] = dict()
         inDict['covariancesSqrtWeights'] = dict()
         inDict['aMatrix'] = dict()
         inDict['bMatrix'] = dict()
         inDict['covariancesModelNoB'] = dict()
         inDict['aMatrixNoB'] = dict()
         inDict['finalVars'] = dict()
         inDict['finalModelVars'] = dict()
         inDict['finalMeans'] = dict()
         inDict['badAmps'] = []
         inDict['photoCharge'] = dict()
  
         for record in ptcTable:
             ampName = record['AMPLIFIER_NAME']
  
             inDict['ptcFitType'] = record['PTC_FIT_TYPE']
             inDict['covMatrixSide'] = record['COV_MATRIX_SIDE']
             inDict['ampNames'].append(ampName)
             inDict['inputExpIdPairs'][ampName] = record['INPUT_EXP_ID_PAIRS']
             inDict['expIdMask'][ampName] = record['EXP_ID_MASK']
             inDict['rawExpTimes'][ampName] = record['RAW_EXP_TIMES']
             inDict['rawMeans'][ampName] = record['RAW_MEANS']
             inDict['rawVars'][ampName] = record['RAW_VARS']
             inDict['gain'][ampName] = record['GAIN']
             inDict['gainErr'][ampName] = record['GAIN_ERR']
             inDict['noise'][ampName] = record['NOISE']
             inDict['noiseErr'][ampName] = record['NOISE_ERR']
             inDict['ptcFitPars'][ampName] = record['PTC_FIT_PARS']
             inDict['ptcFitParsError'][ampName] = record['PTC_FIT_PARS_ERROR']
             inDict['ptcFitChiSq'][ampName] = record['PTC_FIT_CHI_SQ']
             inDict['covariances'][ampName] = record['COVARIANCES']
             inDict['covariancesModel'][ampName] = record['COVARIANCES_MODEL']
             inDict['covariancesSqrtWeights'][ampName] = record['COVARIANCES_SQRT_WEIGHTS']
             inDict['aMatrix'][ampName] = record['A_MATRIX']
             inDict['bMatrix'][ampName] = record['B_MATRIX']
             inDict['covariancesModelNoB'][ampName] = record['COVARIANCES_MODEL_NO_B']
             inDict['aMatrixNoB'][ampName] = record['A_MATRIX_NO_B']
             inDict['finalVars'][ampName] = record['FINAL_VARS']
             inDict['finalModelVars'][ampName] = record['FINAL_MODEL_VARS']
             inDict['finalMeans'][ampName] = record['FINAL_MEANS']
             inDict['badAmps'] = record['BAD_AMPS']
             inDict['photoCharge'][ampName] = record['PHOTO_CHARGE']
         return cls().fromDict(inDict)
  

◆ fromTable() [2/2]

def lsst.ip.isr.calibType.IsrCalib.fromTable	(		cls,
			tableList,
		**	kwargs
	)

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.

     def fromTable(cls, 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.
         """
         raise NotImplementedError("Must be implemented by subclass.")
  

◆ getExpIdsUsed()

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.getExpIdsUsed	(	self,
		ampName
	)

Get the exposures used, i.e. not discarded, for a given amp.
If no mask has been created yet, all exposures are returned.

Definition at line 549 of file ptcDataset.py.

     def getExpIdsUsed(self, ampName):
         """Get the exposures used, i.e. not discarded, for a given amp.
         If no mask has been created yet, all exposures are returned.
         """
         if len(self.expIdMask[ampName]) == 0:
             return self.inputExpIdPairs[ampName]
  
         # if the mask exists it had better be the same length as the expIdPairs
         assert len(self.expIdMask[ampName]) == len(self.inputExpIdPairs[ampName])
  
         pairs = self.inputExpIdPairs[ampName]
         mask = self.expIdMask[ampName]
         # cast to bool required because numpy
         return [(exp1, exp2) for ((exp1, exp2), m) in zip(pairs, mask) if bool(m) is True]
  

◆ getGoodAmps()

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.getGoodAmps ( self )

Definition at line 564 of file ptcDataset.py.

564 def getGoodAmps(self):

565 return [amp for amp in self.ampNames if amp not in self.badAmps]

◆ getMetadata()

def lsst.ip.isr.calibType.IsrCalib.getMetadata ( self )

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.

     def getMetadata(self):
         """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.
         """
         return self._metadata
  

◆ readFits()

def lsst.ip.isr.calibType.IsrCalib.readFits	(		cls,
			filename,
		**	kwargs
	)

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.

     def readFits(cls, 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.
         """
         tableList = []
         tableList.append(Table.read(filename, hdu=1))
         extNum = 2  # Fits indices start at 1, we've read one already.
         keepTrying = True
  
         while keepTrying:
             with warnings.catch_warnings():
                 warnings.simplefilter("error")
                 try:
                     newTable = Table.read(filename, hdu=extNum)
                     tableList.append(newTable)
                     extNum += 1
                 except Exception:
                     keepTrying = False
  
         for table in tableList:
             for k, v in table.meta.items():
                 if isinstance(v, fits.card.Undefined):
                     table.meta[k] = None
  
         calibClass = cls.determineCalibClass(tableList[0].meta, "readFits")
         return calibClass.fromTable(tableList, **kwargs)
  

◆ readText()

def lsst.ip.isr.calibType.IsrCalib.readText	(		cls,
			filename,
		**	kwargs
	)

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.

     def readText(cls, 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 : `~lsst.ip.isr.IsrCalibType`
             Calibration class.
  
         Raises
         ------
         RuntimeError :
             Raised if the filename does not end in ".ecsv" or ".yaml".
         """
         if filename.endswith((".ecsv", ".ECSV")):
             data = Table.read(filename, format="ascii.ecsv")
             calibClass = cls.determineCalibClass(data.meta, "readText/ECSV")
             return calibClass.fromTable([data], **kwargs)
         elif filename.endswith((".yaml", ".YAML")):
             with open(filename, "r") as f:
                 data = yaml.load(f, Loader=yaml.CLoader)
             calibClass = cls.determineCalibClass(data["metadata"], "readText/YAML")
             return calibClass.fromDict(data, **kwargs)
         else:
             raise RuntimeError(f"Unknown filename extension: {filename}")
  

◆ requiredAttributes() [1/2]

def lsst.ip.isr.calibType.IsrCalib.requiredAttributes ( self )

inherited

Definition at line 138 of file calibType.py.

     def requiredAttributes(self):
         return self._requiredAttributes
  

◆ requiredAttributes() [2/2]

def lsst.ip.isr.calibType.IsrCalib.requiredAttributes	(	self,
		value
	)

inherited

Definition at line 142 of file calibType.py.

     def requiredAttributes(self, value):
         self._requiredAttributes = value
  

◆ setAmpValues()

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.setAmpValues	(	self,
		ampName,
		inputExpIdPair = `[(np.nan, np.nan)]`,
		expIdMask = `[np.nan]`,
		rawExpTime = `[np.nan]`,
		rawMean = `[np.nan]`,
		rawVar = `[np.nan]`,
		photoCharge = `[np.nan]`,
		gain = `np.nan`,
		gainErr = `np.nan`,
		noise = `np.nan`,
		noiseErr = `np.nan`,
		ptcFitPars = `[np.nan]`,
		ptcFitParsError = `[np.nan]`,
		ptcFitChiSq = `np.nan`,
		covArray = `[]`,
		covArrayModel = `[]`,
		covSqrtWeights = `[]`,
		aMatrix = `[]`,
		bMatrix = `[]`,
		covArrayModelNoB = `[]`,
		aMatrixNoB = `[]`,
		finalVar = `[np.nan]`,
		finalModelVar = `[np.nan]`,
		finalMean = `[np.nan]`
	)

Function to initialize an amp of a PhotonTransferCurveDataset.

Notes
-----
The parameters are all documented in `init`.

Definition at line 200 of file ptcDataset.py.

                      finalVar=[np.nan], finalModelVar=[np.nan], finalMean=[np.nan]):
         """Function to initialize an amp of a PhotonTransferCurveDataset.
  
         Notes
         -----
         The parameters are all documented in `init`.
         """
         nanMatrix = np.full((self.covMatrixSide, self.covMatrixSide), np.nan)
         if len(covArray) == 0:
             covArray = [nanMatrix]
         if len(covArrayModel) == 0:
             covArrayModel = [nanMatrix]
         if len(covSqrtWeights) == 0:
             covSqrtWeights = [nanMatrix]
         if len(covArrayModelNoB) == 0:
             covArrayModelNoB = [nanMatrix]
         if len(aMatrix) == 0:
             aMatrix = nanMatrix
         if len(bMatrix) == 0:
             bMatrix = nanMatrix
         if len(aMatrixNoB) == 0:
             aMatrixNoB = nanMatrix
  
         self.inputExpIdPairs[ampName] = inputExpIdPair
         self.expIdMask[ampName] = expIdMask
         self.rawExpTimes[ampName] = rawExpTime
         self.rawMeans[ampName] = rawMean
         self.rawVars[ampName] = rawVar
         self.photoCharge[ampName] = photoCharge
         self.gain[ampName] = gain
         self.gainErr[ampName] = gainErr
         self.noise[ampName] = noise
         self.noiseErr[ampName] = noiseErr
         self.ptcFitPars[ampName] = ptcFitPars
         self.ptcFitParsError[ampName] = ptcFitParsError
         self.ptcFitChiSq[ampName]
         self.covariances[ampName] = covArray
         self.covariancesSqrtWeights[ampName] = covSqrtWeights
         self.covariancesModel[ampName] = covArrayModel
         self.covariancesModelNoB[ampName] = covArrayModelNoB
         self.aMatrix[ampName] = aMatrix
         self.bMatrix[ampName] = bMatrix
         self.aMatrixNoB[ampName] = aMatrixNoB
         self.ptcFitPars[ampName] = ptcFitPars
         self.ptcFitParsError[ampName] = ptcFitParsError
         self.ptcFitChiSq[ampName] = ptcFitChiSq
         self.finalVars[ampName] = finalVar
         self.finalModelVars[ampName] = finalModelVar
         self.finalMeans[ampName] = finalMean
  

◆ setMetadata()

def lsst.ip.isr.calibType.IsrCalib.setMetadata	(	self,
		metadata
	)

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 setMetadata(self, 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.
         """
         if metadata is not None:
             self._metadata.update(metadata)
  
         # Ensure that we have the obs type required by calibration ingest
         self._metadata["OBSTYPE"] = self._OBSTYPE
         self._metadata[self._OBSTYPE + "_SCHEMA"] = self._SCHEMA
         self._metadata[self._OBSTYPE + "_VERSION"] = self._VERSION
  
         if isinstance(metadata, dict):
             self.calibInfoFromDict(metadata)
         elif isinstance(metadata, PropertyList):
             self.calibInfoFromDict(metadata.toDict())
  

◆ toDict()

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.toDict ( self )

Return a dictionary containing the calibration properties.
The dictionary should be able to be round-tripped through
`fromDict`.
Returns
-------
dictionary : `dict`
    Dictionary of properties.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 341 of file ptcDataset.py.

     def toDict(self):
         """Return a dictionary containing the calibration properties.
         The dictionary should be able to be round-tripped through
         `fromDict`.
         Returns
         -------
         dictionary : `dict`
             Dictionary of properties.
         """
         self.updateMetadata()
  
         outDict = dict()
         metadata = self.getMetadata()
         outDict['metadata'] = metadata
  
         outDict['ptcFitType'] = self.ptcFitType
         outDict['covMatrixSide'] = self.covMatrixSide
         outDict['ampNames'] = self.ampNames
         outDict['badAmps'] = self.badAmps
         outDict['inputExpIdPairs'] = self.inputExpIdPairs
         outDict['expIdMask'] = self.expIdMask
         outDict['rawExpTimes'] = self.rawExpTimes
         outDict['rawMeans'] = self.rawMeans
         outDict['rawVars'] = self.rawVars
         outDict['gain'] = self.gain
         outDict['gainErr'] = self.gainErr
         outDict['noise'] = self.noise
         outDict['noiseErr'] = self.noiseErr
         outDict['ptcFitPars'] = self.ptcFitPars
         outDict['ptcFitParsError'] = self.ptcFitParsError
         outDict['ptcFitChiSq'] = self.ptcFitChiSq
         outDict['covariances'] = self.covariances
         outDict['covariancesModel'] = self.covariancesModel
         outDict['covariancesSqrtWeights'] = self.covariancesSqrtWeights
         outDict['aMatrix'] = self.aMatrix
         outDict['bMatrix'] = self.bMatrix
         outDict['covariancesModelNoB'] = self.covariancesModelNoB
         outDict['aMatrixNoB'] = self.aMatrixNoB
         outDict['finalVars'] = self.finalVars
         outDict['finalModelVars'] = self.finalModelVars
         outDict['finalMeans'] = self.finalMeans
         outDict['photoCharge'] = self.photoCharge
  
         return outDict
  

◆ toTable()

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.toTable ( self )

Construct a list of tables containing the information in this
calibration.

The list of tables should create an identical calibration
after being passed to this class's fromTable method.
Returns
-------
tableList : `list` [`astropy.table.Table`]
    List of tables containing the linearity calibration
    information.

Reimplemented from lsst.ip.isr.calibType.IsrCalib.

Definition at line 466 of file ptcDataset.py.

     def toTable(self):
         """Construct a list of tables containing the information in this
         calibration.
  
         The list of tables should create an identical calibration
         after being passed to this class's fromTable method.
         Returns
         -------
         tableList : `list` [`astropy.table.Table`]
             List of tables containing the linearity calibration
             information.
         """
         tableList = []
         self.updateMetadata()
         nPoints = []
         for i, ampName in enumerate(self.ampNames):
             nPoints.append(len(list(self.covariances.values())[i]))
         nSignalPoints = max(nPoints)
         nPadPoints = {}
         for i, ampName in enumerate(self.ampNames):
             nPadPoints[ampName] = nSignalPoints - len(list(self.covariances.values())[i])
         covMatrixSide = self.covMatrixSide
  
         catalog = Table([{'AMPLIFIER_NAME': ampName,
                           'PTC_FIT_TYPE': self.ptcFitType,
                           'COV_MATRIX_SIDE': self.covMatrixSide,
                           'INPUT_EXP_ID_PAIRS': self.inputExpIdPairs[ampName]
                          if len(self.expIdMask[ampName]) else np.nan,
                           'EXP_ID_MASK': self.expIdMask[ampName]
                          if len(self.expIdMask[ampName]) else np.nan,
                           'RAW_EXP_TIMES': np.array(self.rawExpTimes[ampName]).tolist()
                          if len(self.rawExpTimes[ampName]) else np.nan,
                           'RAW_MEANS': np.array(self.rawMeans[ampName]).tolist()
                          if len(self.rawMeans[ampName]) else np.nan,
                           'RAW_VARS': np.array(self.rawVars[ampName]).tolist()
                          if len(self.rawVars[ampName]) else np.nan,
                           'GAIN': self.gain[ampName],
                           'GAIN_ERR': self.gainErr[ampName],
                           'NOISE': self.noise[ampName],
                           'NOISE_ERR': self.noiseErr[ampName],
                           'PTC_FIT_PARS': np.array(self.ptcFitPars[ampName]).tolist(),
                           'PTC_FIT_PARS_ERROR': np.array(self.ptcFitParsError[ampName]).tolist(),
                           'PTC_FIT_CHI_SQ': self.ptcFitChiSq[ampName],
                           'COVARIANCES': np.pad(np.array(self.covariances[ampName]),
                                                 ((0, nPadPoints[ampName]), (0, 0), (0, 0)),
                                                 'constant', constant_values=np.nan).reshape(
                               nSignalPoints*covMatrixSide**2).tolist(),
                           'COVARIANCES_MODEL': np.pad(np.array(self.covariancesModel[ampName]),
                                                       ((0, nPadPoints[ampName]), (0, 0), (0, 0)),
                                                       'constant', constant_values=np.nan).reshape(
                               nSignalPoints*covMatrixSide**2).tolist(),
                           'COVARIANCES_SQRT_WEIGHTS': np.pad(np.array(self.covariancesSqrtWeights[ampName]),
                                                              ((0, nPadPoints[ampName]), (0, 0), (0, 0)),
                                                              'constant', constant_values=0.0).reshape(
                               nSignalPoints*covMatrixSide**2).tolist(),
                           'A_MATRIX': np.array(self.aMatrix[ampName]).reshape(covMatrixSide**2).tolist(),
                           'B_MATRIX': np.array(self.bMatrix[ampName]).reshape(covMatrixSide**2).tolist(),
                           'COVARIANCES_MODEL_NO_B':
                               np.pad(np.array(self.covariancesModelNoB[ampName]),
                                      ((0, nPadPoints[ampName]), (0, 0), (0, 0)),
                                      'constant', constant_values=np.nan).reshape(
                               nSignalPoints*covMatrixSide**2).tolist(),
                           'A_MATRIX_NO_B': np.array(self.aMatrixNoB[ampName]).reshape(
                               covMatrixSide**2).tolist(),
                           'FINAL_VARS': np.pad(np.array(self.finalVars[ampName]), (0, nPadPoints[ampName]),
                                                'constant', constant_values=np.nan).tolist(),
                           'FINAL_MODEL_VARS': np.pad(np.array(self.finalModelVars[ampName]),
                                                      (0, nPadPoints[ampName]),
                                                      'constant', constant_values=np.nan).tolist(),
                           'FINAL_MEANS': np.pad(np.array(self.finalMeans[ampName]),
                                                 (0, nPadPoints[ampName]),
                                                 'constant', constant_values=np.nan).tolist(),
                           'BAD_AMPS': np.array(self.badAmps).tolist() if len(self.badAmps) else np.nan,
                           'PHOTO_CHARGE': np.array(self.photoCharge[ampName]).tolist(),
                           } for ampName in self.ampNames])
         inMeta = self.getMetadata().toDict()
         outMeta = {k: v for k, v in inMeta.items() if v is not None}
         outMeta.update({k: "" for k, v in inMeta.items() if v is None})
         catalog.meta = outMeta
         tableList.append(catalog)
  
         return(tableList)
  

◆ updateMetadata() [1/2]

def lsst.ip.isr.calibType.IsrCalib.updateMetadata	(		self,
			camera = `None`,
			detector = `None`,
			filterName = `None`,
			setCalibId = `False`,
			setCalibInfo = `False`,
			setDate = `False`,
		**	kwargs
	)

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.

                        **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.
         """
         mdOriginal = self.getMetadata()
         mdSupplemental = dict()
  
         for k, v in kwargs.items():
             if isinstance(v, fits.card.Undefined):
                 kwargs[k] = None
  
         if setCalibInfo:
             self.calibInfoFromDict(kwargs)
  
         if camera:
             self._instrument = camera.getName()
  
         if detector:
             self._detectorName = detector.getName()
             self._detectorSerial = detector.getSerial()
             self._detectorId = detector.getId()
             if "_" in self._detectorName:
                 (self._raftName, self._slotName) = self._detectorName.split("_")
  
         if filterName:
             # TOD0 DM-28093: I think this whole comment can go away, if we
             # always use physicalLabel everywhere in ip_isr.
             # If set via:
             # exposure.getInfo().getFilter().getName()
             # then this will hold the abstract filter.
             self._filter = filterName
  
         if setDate:
             date = datetime.datetime.now()
             mdSupplemental["CALIBDATE"] = date.isoformat()
             mdSupplemental["CALIB_CREATION_DATE"] = date.date().isoformat()
             mdSupplemental["CALIB_CREATION_TIME"] = date.time().isoformat()
  
         if setCalibId:
             values = []
             values.append(f"instrument={self._instrument}") if self._instrument else None
             values.append(f"raftName={self._raftName}") if self._raftName else None
             values.append(f"detectorName={self._detectorName}") if self._detectorName else None
             values.append(f"detector={self._detectorId}") if self._detectorId else None
             values.append(f"filter={self._filter}") if self._filter else None
  
             calibDate = mdOriginal.get("CALIBDATE", mdSupplemental.get("CALIBDATE", None))
             values.append(f"calibDate={calibDate}") if calibDate else None
  
             self._calibId = " ".join(values)
  
         self._metadata["INSTRUME"] = self._instrument if self._instrument else None
         self._metadata["RAFTNAME"] = self._raftName if self._raftName else None
         self._metadata["SLOTNAME"] = self._slotName if self._slotName else None
         self._metadata["DETECTOR"] = self._detectorId
         self._metadata["DET_NAME"] = self._detectorName if self._detectorName else None
         self._metadata["DET_SER"] = self._detectorSerial if self._detectorSerial else None
         self._metadata["FILTER"] = self._filter if self._filter else None
         self._metadata["CALIB_ID"] = self._calibId if self._calibId else None
         self._metadata["CALIBCLS"] = get_full_type_name(self)
  
         mdSupplemental.update(kwargs)
         mdOriginal.update(mdSupplemental)
  

◆ updateMetadata() [2/2]

def lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.updateMetadata	(		self,
			setDate = `False`,
		**	kwargs
	)

Update calibration metadata.
This calls the base class's method after ensuring the required
calibration keywords will be saved.
Parameters
----------
setDate : `bool`, optional
    Update the CALIBDATE fields in the metadata to the current
    time. Defaults to False.
kwargs :
    Other keyword parameters to set in the metadata.

Definition at line 255 of file ptcDataset.py.

     def updateMetadata(self, setDate=False, **kwargs):
         """Update calibration metadata.
         This calls the base class's method after ensuring the required
         calibration keywords will be saved.
         Parameters
         ----------
         setDate : `bool`, optional
             Update the CALIBDATE fields in the metadata to the current
             time. Defaults to False.
         kwargs :
             Other keyword parameters to set in the metadata.
         """
         kwargs['PTC_FIT_TYPE'] = self.ptcFitType
  
         super().updateMetadata(setDate=setDate, **kwargs)
  

◆ validate()

def lsst.ip.isr.calibType.IsrCalib.validate	(	self,
		other = `None`
	)

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.

     def validate(self, 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.
         """
         return False
  

◆ writeFits()

def lsst.ip.isr.calibType.IsrCalib.writeFits	(	self,
		filename
	)

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.

     def writeFits(self, 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.
  
         """
         tableList = self.toTable()
         with warnings.catch_warnings():
             warnings.filterwarnings("ignore", category=Warning, module="astropy.io")
             astropyList = [fits.table_to_hdu(table) for table in tableList]
             astropyList.insert(0, fits.PrimaryHDU())
  
             writer = fits.HDUList(astropyList)
             writer.writeto(filename, overwrite=True)
         return filename
  

◆ writeText()

def lsst.ip.isr.calibType.IsrCalib.writeText	(	self,
		filename,
		format = `"auto"`
	)

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.

     def writeText(self, 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.
         """
         if format == "yaml" or (format == "auto" and filename.lower().endswith((".yaml", ".YAML"))):
             outDict = self.toDict()
             path, ext = os.path.splitext(filename)
             filename = path + ".yaml"
             with open(filename, "w") as f:
                 yaml.dump(outDict, f)
         elif format == "ecsv" or (format == "auto" and filename.lower().endswith((".ecsv", ".ECSV"))):
             tableList = self.toTable()
             if len(tableList) > 1:
                 # ECSV doesn't support multiple tables per file, so we
                 # can only write the first table.
                 raise RuntimeError(f"Unable to persist {len(tableList)}tables in ECSV format.")
  
             table = tableList[0]
             path, ext = os.path.splitext(filename)
             filename = path + ".ecsv"
             table.write(filename, format="ascii.ecsv")
         else:
             raise RuntimeError(f"Attempt to write to a file {filename} "
                                "that does not end in '.yaml' or '.ecsv'")
  
         return filename
  

Member Data Documentation

◆ aMatrix

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.aMatrix

Definition at line 182 of file ptcDataset.py.

◆ aMatrixNoB

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.aMatrixNoB

Definition at line 185 of file ptcDataset.py.

◆ ampNames

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.ampNames

Definition at line 158 of file ptcDataset.py.

◆ badAmps

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.badAmps

Definition at line 161 of file ptcDataset.py.

◆ bMatrix

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.bMatrix

Definition at line 183 of file ptcDataset.py.

◆ covariances

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.covariances

Definition at line 179 of file ptcDataset.py.

◆ covariancesModel

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.covariancesModel

Definition at line 180 of file ptcDataset.py.

◆ covariancesModelNoB

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.covariancesModelNoB

Definition at line 184 of file ptcDataset.py.

◆ covariancesSqrtWeights

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.covariancesSqrtWeights

Definition at line 181 of file ptcDataset.py.

◆ covMatrixSide

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.covMatrixSide

Definition at line 159 of file ptcDataset.py.

◆ expIdMask

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.expIdMask

Definition at line 164 of file ptcDataset.py.

◆ finalMeans

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.finalMeans

Definition at line 189 of file ptcDataset.py.

◆ finalModelVars

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.finalModelVars

Definition at line 188 of file ptcDataset.py.

◆ finalVars

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.finalVars

Definition at line 187 of file ptcDataset.py.

◆ gain

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.gain

Definition at line 170 of file ptcDataset.py.

◆ gainErr

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.gainErr

Definition at line 171 of file ptcDataset.py.

◆ inputExpIdPairs

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.inputExpIdPairs

Definition at line 163 of file ptcDataset.py.

◆ log

lsst.ip.isr.calibType.IsrCalib.log

inherited

Definition at line 86 of file calibType.py.

◆ noise

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.noise

Definition at line 172 of file ptcDataset.py.

◆ noiseErr

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.noiseErr

Definition at line 173 of file ptcDataset.py.

◆ photoCharge

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.photoCharge

Definition at line 168 of file ptcDataset.py.

◆ ptcFitChiSq

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.ptcFitChiSq

Definition at line 177 of file ptcDataset.py.

◆ ptcFitPars

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.ptcFitPars

Definition at line 175 of file ptcDataset.py.

◆ ptcFitParsError

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.ptcFitParsError

Definition at line 176 of file ptcDataset.py.

◆ ptcFitType

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.ptcFitType

Definition at line 157 of file ptcDataset.py.

◆ rawExpTimes

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.rawExpTimes

Definition at line 165 of file ptcDataset.py.

◆ rawMeans

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.rawMeans

Definition at line 166 of file ptcDataset.py.

◆ rawVars

lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.rawVars

Definition at line 167 of file ptcDataset.py.

◆ requiredAttributes

lsst.ip.isr.calibType.IsrCalib.requiredAttributes

inherited

Definition at line 81 of file calibType.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_isr/22.0.1-27-g97737f7+2a20fdde0d/python/lsst/ip/isr/ptcDataset.py

Public Attributes
	ptcFitType

	ampNames

	covMatrixSide

	badAmps

	inputExpIdPairs

	expIdMask

	rawExpTimes

	rawMeans

	rawVars

	photoCharge

	gain

	gainErr

	noise

	noiseErr

	ptcFitPars

	ptcFitParsError

	ptcFitChiSq

	covariances

	covariancesModel

	covariancesSqrtWeights

	aMatrix

	bMatrix

	covariancesModelNoB

	aMatrixNoB

	finalVars

	finalModelVars

	finalMeans

	requiredAttributes

	log

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __str__()

◆ apply()

◆ calibInfoFromDict()

◆ determineCalibClass()

◆ fromDetector()

◆ fromDict() [1/2]

◆ fromDict() [2/2]

◆ fromTable() [1/2]

◆ fromTable() [2/2]

◆ getExpIdsUsed()

◆ getGoodAmps()

◆ getMetadata()

◆ readFits()

◆ readText()

◆ requiredAttributes() [1/2]

◆ requiredAttributes() [2/2]

◆ setAmpValues()

◆ setMetadata()

◆ toDict()

◆ toTable()

◆ updateMetadata() [1/2]

◆ updateMetadata() [2/2]

◆ validate()

◆ writeFits()

◆ writeText()

Member Data Documentation

◆ aMatrix

◆ aMatrixNoB

◆ ampNames

◆ badAmps

◆ bMatrix

◆ covariances

◆ covariancesModel

◆ covariancesModelNoB

◆ covariancesSqrtWeights

◆ covMatrixSide

◆ expIdMask

◆ finalMeans

◆ finalModelVars

◆ finalVars

◆ gain

◆ gainErr

◆ inputExpIdPairs

◆ log

◆ noise

◆ noiseErr

◆ photoCharge

◆ ptcFitChiSq

◆ ptcFitPars

◆ ptcFitParsError

◆ ptcFitType

◆ rawExpTimes

◆ rawMeans

◆ rawVars

◆ requiredAttributes

◆ init()

◆ eq()

◆ str()