|
lsst.ip.isr g9cb75138f3+bac7c66737
|
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 | |
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.
| def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.__init__ | ( | self, | |
camera = None, |
|||
level = None, |
|||
| ** | kwargs | ||
| ) |
Definition at line 63 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.
Definition at line 192 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 291 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 167 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 112 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 421 of file brighterFatterKernel.py.
| def lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.replaceDetectorKernelWithAmpKernel | ( | self, | |
| ampName, | |||
| detectorName | |||
| ) |
Definition at line 438 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 252 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 348 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 92 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.ampKernels |
Definition at line 80 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.badAmps |
Definition at line 70 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.detKernels |
Definition at line 81 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.gain |
Definition at line 72 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.level |
Definition at line 64 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.means |
Definition at line 67 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.meanXcorrs |
Definition at line 76 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.noise |
Definition at line 73 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawXcorrs |
Definition at line 69 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.shape |
Definition at line 71 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.valid |
Definition at line 77 of file brighterFatterKernel.py.
| lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.variances |
Definition at line 68 of file brighterFatterKernel.py.