lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel Class Reference

Inheritance diagram for lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel:

Public Member Functions
def	__init__ (self, camera=None, level=None, **kwargs)
def	updateMetadata (self, setDate=False, **kwargs)
def	initFromCamera (self, camera, detectorId=None)
def	getLengths (self)
def	fromDict (cls, dictionary)
def	toDict (self)
def	fromTable (cls, tableList)
def	toTable (self)
def	makeDetectorKernelFromAmpwiseKernels (self, detectorName, ampsToExclude=[])
def	replaceDetectorKernelWithAmpKernel (self, ampName, detectorName)

Public Attributes
	level
	means
	variances
	rawXcorrs
	badAmps
	shape
	gain
	noise
	meanXcorrs
	valid
	ampKernels
	detKernels

Detailed Description

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
----------
level : `str`
    Level the kernels will be generated for.
log : `logging.Logger`, optional
    Log to write messages to.
**kwargs :
    Parameters to pass to parent constructor.

Definition at line 34 of file brighterFatterKernel.py.

Constructor & Destructor Documentation

__init__()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.__init__	(		self,
			camera = None,
			level = None,
		**	kwargs
	)

Definition at line 63 of file brighterFatterKernel.py.

    def __init__(self, camera=None, level=None, **kwargs):
        self.level = level
 
        # Things inherited from the PTC
        self.means = dict()
        self.variances = dict()
        self.rawXcorrs = dict()
        self.badAmps = list()
        self.shape = (17, 17)
        self.gain = dict()
        self.noise = dict()
 
        # Things calculated from the PTC
        self.meanXcorrs = dict()
        self.valid = dict()
 
        # Things that are used downstream
        self.ampKernels = dict()
        self.detKernels = dict()
 
        super().__init__(**kwargs)
 
        if camera:
            self.initFromCamera(camera, detectorId=kwargs.get('detectorId', None))
 
        self.requiredAttributes.update(['level', 'means', 'variances', 'rawXcorrs',
                                        'badAmps', 'gain', 'noise', 'meanXcorrs', 'valid',
                                        'ampKernels', 'detKernels'])
 

Member Function Documentation

fromDict()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.fromDict	(		cls,
			dictionary
	)

Construct a calibration from a dictionary of properties.

Parameters
----------
dictionary : `dict`
    Dictionary of properties.

Returns
-------
calib : `lsst.ip.isr.BrighterFatterKernel
    Constructed calibration.

Raises
------
RuntimeError :
    Raised if the supplied dictionary is for a different
    calibration.

Definition at line 192 of file brighterFatterKernel.py.

    def fromDict(cls, dictionary):
        """Construct a calibration from a dictionary of properties.
 
        Parameters
        ----------
        dictionary : `dict`
            Dictionary of properties.
 
        Returns
        -------
        calib : `lsst.ip.isr.BrighterFatterKernel
            Constructed calibration.
 
        Raises
        ------
        RuntimeError :
            Raised if the supplied dictionary is for a different
            calibration.
        """
        calib = cls()
 
        if calib._OBSTYPE != (found := dictionary['metadata']['OBSTYPE']):
            raise RuntimeError(f"Incorrect brighter-fatter kernel supplied.  Expected {calib._OBSTYPE}, "
                               f"found {found}")
 
        calib.setMetadata(dictionary['metadata'])
        calib.calibInfoFromDict(dictionary)
 
        calib.level = dictionary['metadata'].get('LEVEL', 'AMP')
        calib.shape = (dictionary['metadata'].get('KERNEL_DX', 0),
                       dictionary['metadata'].get('KERNEL_DY', 0))
 
        calib.means = {amp: np.array(dictionary['means'][amp]) for amp in dictionary['means']}
        calib.variances = {amp: np.array(dictionary['variances'][amp]) for amp in dictionary['variances']}
 
        # Lengths for reshape:
        _, smallLength, nObs = calib.getLengths()
        smallShapeSide = int(np.sqrt(smallLength))
 
        calib.rawXcorrs = {amp: np.array(dictionary['rawXcorrs'][amp]).reshape((nObs,
                                                                                smallShapeSide,
                                                                                smallShapeSide))
                           for amp in dictionary['rawXcorrs']}
 
        calib.gain = dictionary['gain']
        calib.noise = dictionary['noise']
 
        calib.meanXcorrs = {amp: np.array(dictionary['meanXcorrs'][amp]).reshape(calib.shape)
                            for amp in dictionary['rawXcorrs']}
        calib.ampKernels = {amp: np.array(dictionary['ampKernels'][amp]).reshape(calib.shape)
                            for amp in dictionary['ampKernels']}
        calib.valid = {amp: bool(value) for amp, value in dictionary['valid'].items()}
        calib.badAmps = [amp for amp, valid in dictionary['valid'].items() if valid is False]
 
        calib.detKernels = {det: np.array(dictionary['detKernels'][det]).reshape(calib.shape)
                            for det in dictionary['detKernels']}
 
        calib.updateMetadata()
        return calib
 

fromTable()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.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` [`astropy.table.Table`]
    List of tables to use to construct the brighter-fatter
    calibration.

Returns
-------
calib : `lsst.ip.isr.BrighterFatterKernel`
    The calibration defined in the tables.

Definition at line 291 of file brighterFatterKernel.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` [`astropy.table.Table`]
            List of tables to use to construct the brighter-fatter
            calibration.
 
        Returns
        -------
        calib : `lsst.ip.isr.BrighterFatterKernel`
            The calibration defined in the tables.
        """
        ampTable = tableList[0]
 
        metadata = ampTable.meta
        inDict = dict()
        inDict['metadata'] = metadata
 
        amps = ampTable['AMPLIFIER']
 
        meanList = ampTable['MEANS']
        varianceList = ampTable['VARIANCES']
 
        rawXcorrs = ampTable['RAW_XCORRS']
        gainList = ampTable['GAIN']
        noiseList = ampTable['NOISE']
 
        meanXcorrs = ampTable['MEAN_XCORRS']
        ampKernels = ampTable['KERNEL']
        validList = ampTable['VALID']
 
        inDict['means'] = {amp: mean for amp, mean in zip(amps, meanList)}
        inDict['variances'] = {amp: var for amp, var in zip(amps, varianceList)}
        inDict['rawXcorrs'] = {amp: kernel for amp, kernel in zip(amps, rawXcorrs)}
        inDict['gain'] = {amp: gain for amp, gain in zip(amps, gainList)}
        inDict['noise'] = {amp: noise for amp, noise in zip(amps, noiseList)}
        inDict['meanXcorrs'] = {amp: kernel for amp, kernel in zip(amps, meanXcorrs)}
        inDict['ampKernels'] = {amp: kernel for amp, kernel in zip(amps, ampKernels)}
        inDict['valid'] = {amp: bool(valid) for amp, valid in zip(amps, validList)}
 
        inDict['badAmps'] = [amp for amp, valid in inDict['valid'].items() if valid is False]
 
        if len(tableList) > 1:
            detTable = tableList[1]
            inDict['detKernels'] = {det: kernel for det, kernel
                                    in zip(detTable['DETECTOR'], detTable['KERNEL'])}
        else:
            inDict['detKernels'] = {}
 
        return cls.fromDict(inDict)
 

getLengths()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.getLengths

(

self

)

Return the set of lengths needed for reshaping components.

Returns
-------
kernelLength : `int`
    Product of the elements of self.shape.
smallLength : `int`
    Size of an untiled covariance.
nObs : `int`
    Number of observation pairs used in the kernel.

Definition at line 167 of file brighterFatterKernel.py.

    def getLengths(self):
        """Return the set of lengths needed for reshaping components.
 
        Returns
        -------
        kernelLength : `int`
            Product of the elements of self.shape.
        smallLength : `int`
            Size of an untiled covariance.
        nObs : `int`
            Number of observation pairs used in the kernel.
        """
        kernelLength = self.shape[0] * self.shape[1]
        smallLength = int((self.shape[0] - 1)*(self.shape[1] - 1)/4)
        if self.level == 'AMP':
            nObservations = set([len(self.means[amp]) for amp in self.means])
            if len(nObservations) != 1:
                raise RuntimeError("Inconsistent number of observations found.")
            nObs = nObservations.pop()
        else:
            nObs = 0
 
        return (kernelLength, smallLength, nObs)
 

initFromCamera()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.initFromCamera	(		self,
			camera,
			detectorId = None
	)

Initialize kernel structure from camera.

Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`
    Camera to use to define geometry.
detectorId : `int`, optional
    Index of the detector to generate.

Returns
-------
calib : `lsst.ip.isr.BrighterFatterKernel`
    The initialized calibration.

Raises
------
RuntimeError :
    Raised if no detectorId is supplied for a calibration with
    level='AMP'.

Definition at line 112 of file brighterFatterKernel.py.

    def initFromCamera(self, camera, detectorId=None):
        """Initialize kernel structure from camera.
 
        Parameters
        ----------
        camera : `lsst.afw.cameraGeom.Camera`
            Camera to use to define geometry.
        detectorId : `int`, optional
            Index of the detector to generate.
 
        Returns
        -------
        calib : `lsst.ip.isr.BrighterFatterKernel`
            The initialized calibration.
 
        Raises
        ------
        RuntimeError :
            Raised if no detectorId is supplied for a calibration with
            level='AMP'.
        """
        self._instrument = camera.getName()
 
        if detectorId is not None:
            detector = camera[detectorId]
            self._detectorId = detectorId
            self._detectorName = detector.getName()
            self._detectorSerial = detector.getSerial()
 
        if self.level == 'AMP':
            if detectorId is None:
                raise RuntimeError("A detectorId must be supplied if level='AMP'.")
 
            self.badAmps = []
 
            for amp in detector:
                ampName = amp.getName()
                self.means[ampName] = []
                self.variances[ampName] = []
                self.rawXcorrs[ampName] = []
                self.gain[ampName] = amp.getGain()
                self.noise[ampName] = amp.getReadNoise()
                self.meanXcorrs[ampName] = []
                self.ampKernels[ampName] = []
                self.valid[ampName] = []
        elif self.level == 'DETECTOR':
            if detectorId is None:
                for det in camera:
                    detName = det.getName()
                    self.detKernels[detName] = []
            else:
                self.detKernels[self._detectorName] = []
 
        return self
 

makeDetectorKernelFromAmpwiseKernels()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.makeDetectorKernelFromAmpwiseKernels	(		self,
			detectorName,
			ampsToExclude = []
	)

Average the amplifier level kernels to create a detector level kernel.

Definition at line 420 of file brighterFatterKernel.py.

    def makeDetectorKernelFromAmpwiseKernels(self, detectorName, ampsToExclude=[]):
        """Average the amplifier level kernels to create a detector level kernel.
        """
        inKernels = np.array([self.ampKernels[amp] for amp in
                              self.ampKernels if amp not in ampsToExclude])
        averagingList = np.transpose(inKernels)
        avgKernel = np.zeros_like(inKernels[0])
        sctrl = afwMath.StatisticsControl()
        sctrl.setNumSigmaClip(5.0)
        for i in range(np.shape(avgKernel)[0]):
            for j in range(np.shape(avgKernel)[1]):
                avgKernel[i, j] = afwMath.makeStatistics(averagingList[i, j],
                                                         afwMath.MEANCLIP, sctrl).getValue()
 
        self.detKernels[detectorName] = avgKernel
 

replaceDetectorKernelWithAmpKernel()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.replaceDetectorKernelWithAmpKernel	(		self,
			ampName,
			detectorName
	)

Definition at line 436 of file brighterFatterKernel.py.

    def replaceDetectorKernelWithAmpKernel(self, ampName, detectorName):
        self.detKernel[detectorName] = self.ampKernel[ampName]

toDict()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.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.

Definition at line 252 of file brighterFatterKernel.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 = {}
        metadata = self.getMetadata()
        outDict['metadata'] = metadata
 
        # Lengths for ravel:
        kernelLength, smallLength, nObs = self.getLengths()
 
        outDict['means'] = {amp: np.array(self.means[amp]).tolist() for amp in self.means}
        outDict['variances'] = {amp: np.array(self.variances[amp]).tolist() for amp in self.variances}
        outDict['rawXcorrs'] = {amp: np.array(self.rawXcorrs[amp]).reshape(nObs*smallLength).tolist()
                                for amp in self.rawXcorrs}
        outDict['badAmps'] = self.badAmps
        outDict['gain'] = self.gain
        outDict['noise'] = self.noise
 
        outDict['meanXcorrs'] = {amp: self.meanXcorrs[amp].reshape(kernelLength).tolist()
                                 for amp in self.meanXcorrs}
        outDict['ampKernels'] = {amp: self.ampKernels[amp].reshape(kernelLength).tolist()
                                 for amp in self.ampKernels}
        outDict['valid'] = self.valid
 
        outDict['detKernels'] = {det: self.detKernels[det].reshape(kernelLength).tolist()
                                 for det in self.detKernels}
        return outDict
 

toTable()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.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` [`lsst.afw.table.Table`]
    List of tables containing the crosstalk calibration
    information.

Definition at line 348 of file brighterFatterKernel.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` [`lsst.afw.table.Table`]
            List of tables containing the crosstalk calibration
            information.
 
        """
        tableList = []
        self.updateMetadata()
 
        # Lengths
        kernelLength, smallLength, nObs = self.getLengths()
 
        ampList = []
        meanList = []
        varianceList = []
        rawXcorrs = []
        gainList = []
        noiseList = []
 
        meanXcorrsList = []
        kernelList = []
        validList = []
 
        if self.level == 'AMP':
            for amp in self.means.keys():
                ampList.append(amp)
                meanList.append(self.means[amp])
                varianceList.append(self.variances[amp])
                rawXcorrs.append(np.array(self.rawXcorrs[amp]).reshape(nObs*smallLength).tolist())
                gainList.append(self.gain[amp])
                noiseList.append(self.noise[amp])
 
                meanXcorrsList.append(self.meanXcorrs[amp].reshape(kernelLength).tolist())
                kernelList.append(self.ampKernels[amp].reshape(kernelLength).tolist())
                validList.append(int(self.valid[amp] and not (amp in self.badAmps)))
 
        ampTable = Table({'AMPLIFIER': ampList,
                          'MEANS': meanList,
                          'VARIANCES': varianceList,
                          'RAW_XCORRS': rawXcorrs,
                          'GAIN': gainList,
                          'NOISE': noiseList,
                          'MEAN_XCORRS': meanXcorrsList,
                          'KERNEL': kernelList,
                          'VALID': validList,
                          })
 
        ampTable.meta = self.getMetadata().toDict()
        tableList.append(ampTable)
 
        if len(self.detKernels):
            detList = []
            kernelList = []
            for det in self.detKernels.keys():
                detList.append(det)
                kernelList.append(self.detKernels[det].reshape(kernelLength).tolist())
 
            detTable = Table({'DETECTOR': detList,
                              'KERNEL': kernelList})
            detTable.meta = self.getMetadata().toDict()
            tableList.append(detTable)
 
        return tableList
 

updateMetadata()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.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 92 of file brighterFatterKernel.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['LEVEL'] = self.level
        kwargs['KERNEL_DX'] = self.shape[0]
        kwargs['KERNEL_DY'] = self.shape[1]
 
        super().updateMetadata(setDate=setDate, **kwargs)
 

Member Data Documentation

ampKernels

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.ampKernels

Definition at line 80 of file brighterFatterKernel.py.

badAmps

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.badAmps

Definition at line 70 of file brighterFatterKernel.py.

detKernels

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.detKernels

Definition at line 81 of file brighterFatterKernel.py.

gain

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.gain

Definition at line 72 of file brighterFatterKernel.py.

level

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.level

Definition at line 64 of file brighterFatterKernel.py.

means

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.means

Definition at line 67 of file brighterFatterKernel.py.

meanXcorrs

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.meanXcorrs

Definition at line 76 of file brighterFatterKernel.py.

noise

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.noise

Definition at line 73 of file brighterFatterKernel.py.

rawXcorrs

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawXcorrs

Definition at line 69 of file brighterFatterKernel.py.

shape

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.shape

Definition at line 71 of file brighterFatterKernel.py.

valid

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.valid

Definition at line 77 of file brighterFatterKernel.py.

variances

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.variances

Definition at line 68 of file brighterFatterKernel.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/brighterFatterKernel.py