LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, camera=None, level=None, **kwargs) | |
updateMetadata (self, setDate=False, **kwargs) | |
initFromCamera (self, camera, detectorId=None) | |
getLengths (self) | |
fromDict (cls, dictionary) | |
toDict (self) | |
fromTable (cls, tableList) | |
toTable (self) | |
repackCorrelations (self, amp, correlationShape) | |
makeDetectorKernelFromAmpwiseKernels (self, detectorName, ampsToExclude=[]) | |
replaceDetectorKernelWithAmpKernel (self, ampName, detectorName) | |
Public Attributes | |
level | |
expIdMask | |
rawMeans | |
rawVariances | |
rawXcorrs | |
badAmps | |
shape | |
gain | |
noise | |
meanXcorrs | |
valid | |
ampKernels | |
detKernels | |
Protected Attributes | |
_instrument | |
_detectorId | |
_detectorName | |
_detectorSerial | |
Static Protected Attributes | |
str | _OBSTYPE = 'bfk' |
str | _SCHEMA = 'Brighter-fatter kernel' |
float | _VERSION = 1.1 |
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.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.__init__ | ( | self, | |
camera = None, | |||
level = None, | |||
** | kwargs ) |
Definition at line 102 of file brighterFatterKernel.py.
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.
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.
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.
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.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.makeDetectorKernelFromAmpwiseKernels | ( | self, | |
detectorName, | |||
ampsToExclude = [] ) |
Average the amplifier level kernels to create a detector level kernel. There is no change in index ordering/orientation from this averaging. Parameters ---------- detectorName : `str` Detector for which the averaged kernel will be used. ampsToExclude : `list` [`str`], optional Amps that should not be included in the average.
Definition at line 553 of file brighterFatterKernel.py.
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.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.replaceDetectorKernelWithAmpKernel | ( | self, | |
ampName, | |||
detectorName ) |
Definition at line 577 of file brighterFatterKernel.py.
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.
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.
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.
|
protected |
Definition at line 177 of file brighterFatterKernel.py.
|
protected |
Definition at line 178 of file brighterFatterKernel.py.
|
protected |
Definition at line 179 of file brighterFatterKernel.py.
|
protected |
Definition at line 173 of file brighterFatterKernel.py.
|
staticprotected |
Definition at line 98 of file brighterFatterKernel.py.
|
staticprotected |
Definition at line 99 of file brighterFatterKernel.py.
|
staticprotected |
Definition at line 100 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.ampKernels |
Definition at line 120 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.badAmps |
Definition at line 110 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.detKernels |
Definition at line 121 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.expIdMask |
Definition at line 106 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.gain |
Definition at line 112 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.level |
Definition at line 103 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.meanXcorrs |
Definition at line 116 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.noise |
Definition at line 113 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawMeans |
Definition at line 107 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawVariances |
Definition at line 108 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.rawXcorrs |
Definition at line 109 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.shape |
Definition at line 111 of file brighterFatterKernel.py.
lsst.ip.isr.brighterFatterKernel.BrighterFatterKernel.valid |
Definition at line 117 of file brighterFatterKernel.py.