lsst.ip.isr g137835810c+974c3b7f7d
Public Member Functions | Public Attributes | List of all members
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 repackCorrelations (self, amp, correlationShape)
 
def makeDetectorKernelFromAmpwiseKernels (self, detectorName, ampsToExclude=[])
 
def replaceDetectorKernelWithAmpKernel (self, ampName, detectorName)
 

Public Attributes

 level
 
 expIdMask
 
 rawMeans
 
 rawVariances
 
 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
----------
camera : `lsst.afw.cameraGeom.Camera`
    Camera describing detector geometry.
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.

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

expIdMask : `dict`, [`str`,`numpy.ndarray`]
    Dictionary keyed by amp names containing the mask produced after
    outlier rejection.
rawMeans : `dict`, [`str`, `numpy.ndarray`]
    Dictionary keyed by amp names containing the unmasked average of the
    means of the exposures in each flat pair.
rawVariances : `dict`, [`str`, `numpy.ndarray`]
    Dictionary keyed by amp names containing the variance of the
    difference image of the exposures in each flat pair.
    Corresponds to rawVars of PTC.
rawXcorrs : `dict`, [`str`, `numpy.ndarray`]
    Dictionary keyed by amp names containing an array of measured
    covariances per mean flux.
    Corresponds to covariances of PTC.
badAmps : `list`
    List of bad amplifiers names.
shape : `tuple`
    Tuple of the shape of the BFK kernels.
gain : `dict`, [`str`,`float`]
    Dictionary keyed by amp names containing the fitted gains.
noise : `dict`, [`str`,`float`]
    Dictionary keyed by amp names containing the fitted noise.
meanXcorrs : `dict`, [`str`,`numpy.ndarray`]
    Dictionary keyed by amp names containing the averaged
    cross-correlations.
valid : `dict`, [`str`,`bool`]
    Dictionary keyed by amp names containing validity of data.
ampKernels : `dict`, [`str`, `numpy.ndarray`]
    Dictionary keyed by amp names containing the BF kernels.
detKernels : `dict`
    Dictionary keyed by detector names containing the BF kernels.

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 102 of file brighterFatterKernel.py.

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.
    Raised if the version of the supplied dictionary is 1.0.

Definition at line 233 of file brighterFatterKernel.py.

◆ 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 366 of file brighterFatterKernel.py.

◆ 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 208 of file brighterFatterKernel.py.

◆ 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 152 of file brighterFatterKernel.py.

◆ 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 553 of file brighterFatterKernel.py.

◆ repackCorrelations()

def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.repackCorrelations (   self,
  amp,
  correlationShape 
)
If the correlations were masked, they need to be repacked into the
correct shape.

Parameters
----------
amp : `str`
    Amplifier needing repacked.
correlationShape : `tuple` [`int`], (3, )
    Shape the correlations are expected to take.

Definition at line 531 of file brighterFatterKernel.py.

◆ replaceDetectorKernelWithAmpKernel()

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

Definition at line 570 of file brighterFatterKernel.py.

◆ 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 312 of file brighterFatterKernel.py.

◆ 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 445 of file brighterFatterKernel.py.

◆ 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 132 of file brighterFatterKernel.py.

Member Data Documentation

◆ ampKernels

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.ampKernels

Definition at line 120 of file brighterFatterKernel.py.

◆ badAmps

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.badAmps

Definition at line 110 of file brighterFatterKernel.py.

◆ detKernels

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.detKernels

Definition at line 121 of file brighterFatterKernel.py.

◆ expIdMask

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.expIdMask

Definition at line 106 of file brighterFatterKernel.py.

◆ gain

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.gain

Definition at line 112 of file brighterFatterKernel.py.

◆ level

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.level

Definition at line 103 of file brighterFatterKernel.py.

◆ meanXcorrs

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.meanXcorrs

Definition at line 116 of file brighterFatterKernel.py.

◆ noise

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.noise

Definition at line 113 of file brighterFatterKernel.py.

◆ rawMeans

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawMeans

Definition at line 107 of file brighterFatterKernel.py.

◆ rawVariances

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawVariances

Definition at line 108 of file brighterFatterKernel.py.

◆ rawXcorrs

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawXcorrs

Definition at line 109 of file brighterFatterKernel.py.

◆ shape

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.shape

Definition at line 111 of file brighterFatterKernel.py.

◆ valid

lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.valid

Definition at line 117 of file brighterFatterKernel.py.


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