lsst.ip.isr g1eb1de935c+f382d957d6
|
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 | |
expIdMask | |
rawMeans | |
rawVariances | |
rawXcorrs | |
badAmps | |
shape | |
gain | |
noise | |
meanXcorrs | |
valid | |
ampKernels | |
detKernels | |
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. Notes ----- TODO: DM-35260 Document what is stored in the BFK calibration. Version 1.1 adds the `expIdMask` property, and substitutes `means` and `variances` for `rawMeans` and `rawVariances` from the PTC dataset.
Definition at line 34 of file brighterFatterKernel.py.
def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.__init__ | ( | self, | |
camera = None , |
|||
level = None , |
|||
** | kwargs | ||
) |
Definition at line 71 of file brighterFatterKernel.py.
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 202 of file brighterFatterKernel.py.
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 322 of file brighterFatterKernel.py.
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 177 of file brighterFatterKernel.py.
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 121 of file brighterFatterKernel.py.
def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.makeDetectorKernelFromAmpwiseKernels | ( | self, | |
detectorName, | |||
ampsToExclude = [] |
|||
) |
Average the amplifier level kernels to create a detector level kernel.
Definition at line 477 of file brighterFatterKernel.py.
def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.replaceDetectorKernelWithAmpKernel | ( | self, | |
ampName, | |||
detectorName | |||
) |
Definition at line 494 of file brighterFatterKernel.py.
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 281 of file brighterFatterKernel.py.
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 401 of file brighterFatterKernel.py.
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 101 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.ampKernels |
Definition at line 89 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.badAmps |
Definition at line 79 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.detKernels |
Definition at line 90 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.expIdMask |
Definition at line 75 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.gain |
Definition at line 81 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.level |
Definition at line 72 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.meanXcorrs |
Definition at line 85 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.noise |
Definition at line 82 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawMeans |
Definition at line 76 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawVariances |
Definition at line 77 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawXcorrs |
Definition at line 78 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.shape |
Definition at line 80 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.valid |
Definition at line 86 of file brighterFatterKernel.py.