ElectrostaticBrighterFatterDistortionMatrix

class lsst.ip.isr.ElectrostaticBrighterFatterDistortionMatrix(camera=None, inputRange=1, fitRange=None, **kwargs)

Bases: IsrCalib

Calibration of brighter-fatter kernels for an instrument.

ampKernels are the kernels for each amplifier in a detector, as generated by having level == 'AMP'.

detectorKernel is the kernel generated for a detector as a whole, as generated by having level == 'DETECTOR'.

makeDetectorKernelFromAmpwiseKernels is a method to generate the kernel for a detector, constructed by averaging together the ampwise kernels in the detector. The existing application code is only defined for kernels with level == 'DETECTOR', so this method is used if the supplied kernel was built with level == 'AMP'.

Parameters

cameralsst.afw.cameraGeom.Camera

Camera describing detector geometry.

levelstr

Level the kernels will be generated for.

loglogging.Logger, optional

Log to write messages to.

**kwargs :

Parameters to pass to parent constructor.

Notes

Version 1.1 adds the expIdMask property, and substitutes means and variances for rawMeans and rawVariances from the PTC dataset.

inputRangeint

The size of the input aMatrix shape in each dimension.

fitRangeint

The size of the input aMatrix shape in each dimension that is used for fitting the electrostatic model. Must be less than or equal to inputRange.

badAmpslist, [str]

List of bad amplifiers names.

gaindict, [str,`float`]

Dictionary keyed by amp names containing the gains inherited from the inputPTC.

aMatrixnumpy.ndarray

The average aMatrix inherited from the inputPTC’s good amplifiers.

aMatrixSigmanumpy.ndarray

The uncertainty matrix used to weight the fit.

aMatrixModelnumpy.ndarray

The modeled aMatrix based on the electrostatic fit parameters.

aMatrixSumfloat

The sum of the symmetrized aMatrix.

aMatrixModelSumfloat

The sum of the symmetrized aMatrixModel.

modelNormalizationlist

A two element array of the multiplicative and additive normalization to the aMatrixModel.

usedPixelsnumpy.ndarray, [bool]

Array of shape like aMatrix containing the mask indicating which elements of the input aMatrix were used to fit the electrostatic model.

fitParamNameslist, [str]

List of all the parameter names in the electrostatic fit.

freeFitParamNameslist, [str]

List of the parameter names that were allowed to vary during the electrostatic fit.

fitParamsdict, [str, float]

Dictionary containing each named parameter and its final fitted value.

fitParamErrorsdict, [str, float]

Dictionary containing each named parameter and its estimated fitting error.

fitChi2float

The computed chi squared between the data and the final model.

fitReducedChi2float

The computed reduced chi squared between the data and the final model.

fitParamCovMatrixnumpy.ndarray

The estimated covariance matrix between all fit parameters.

athnumpy.ndarray

something…

athMinusBetanumpy.ndarray

something…

aNnumpy.ndarray

Array of shape (fitRange, fitRange) containing the computed North component of the pixel boundary shift.

aSnumpy.ndarray

Array of shape (fitRange, fitRange) containing the computed South component of the pixel boundary shift.

aEnumpy.ndarray

Array of shape (fitRange, fitRange) containing the computed East component of the pixel boundary shift.

aWnumpy.ndarray

Array of shape (fitRange, fitRange) containing the computed West component of the pixel boundary shift.

Methods Summary

fromDict(dictionary)	Construct a calibration from a dictionary of properties.
fromTable(tableList)	Construct calibration from a list of tables.
initFromCamera(camera[, detectorId])	Initialize kernel structure from camera.
toDict()	Return a dictionary containing the calibration properties.
toTable()	Construct a list of tables containing the information in this calibration.
updateMetadata([setDate])	Update calibration metadata.

Methods Documentation

classmethod fromDict(dictionary)

Construct a calibration from a dictionary of properties.

Parameters

dictionarydict

Dictionary of properties.

Returns

caliblsst.ip.isr.BrighterFatterKernel

Constructed calibration.

Raises

RuntimeError

Raised if the supplied dictionary is for a different calibration. Raised if the version of the supplied dictionary is 1.0.

classmethod fromTable(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

tableListlist [astropy.table.Table]

List of tables to use to construct the brighter-fatter calibration.

Returns

caliblsst.ip.isr.BrighterFatterKernel

The calibration defined in the tables.

initFromCamera(camera, detectorId=None)

Initialize kernel structure from camera.

Parameters

cameralsst.afw.cameraGeom.Camera

Camera to use to define geometry.

detectorIdint, optional

Index of the detector to generate.

Returns

caliblsst.ip.isr.BrighterFatterKernel

The initialized calibration.

Raises

RuntimeError

Raised if no detectorId is supplied for a calibration with level='AMP'.

toDict()

Return a dictionary containing the calibration properties.

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

Returns

dictionarydict

Dictionary of properties.

toTable()

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

tableListlist [lsst.afw.table.Table]

List of tables containing the crosstalk calibration information.

updateMetadata(setDate=False, **kwargs)

Update calibration metadata.

This calls the base class’s method after ensuring the required calibration keywords will be saved.

Parameters

setDatebool, optional

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

kwargs :

Other keyword parameters to set in the metadata.