|
lsst.ip.isr gf5f1c85443+e8e946ae08
|
Public Member Functions | |
| __init__ (self, camera=None, inputRange=1, fitRange=None, **kwargs) | |
| updateMetadata (self, setDate=False, **kwargs) | |
| initFromCamera (self, camera, detectorId=None) | |
| fromDict (cls, dictionary) | |
| toDict (self) | |
| fromTable (cls, tableList) | |
| toTable (self) | |
| requiredAttributes (self) | |
| requiredAttributes (self, value) | |
| __str__ (self) | |
| __eq__ (self, other) | |
| metadata (self) | |
| getMetadata (self) | |
| setMetadata (self, metadata) | |
| updateMetadataFromExposures (self, exposures) | |
| calibInfoFromDict (self, dictionary) | |
| determineCalibClass (cls, metadata, message) | |
| readText (cls, filename, **kwargs) | |
| writeText (self, filename, format="auto") | |
| readFits (cls, filename, **kwargs) | |
| writeFits (self, filename) | |
| fromDetector (self, detector) | |
| validate (self, other=None) | |
| apply (self, target) | |
Public Attributes | |
| list | ampNames = [] |
| inputRange = inputRange | |
| fitRange = fitRange | |
| badAmps = list() | |
| gain = dict() | |
| aMatrix = np.full((inputRange, inputRange), np.nan) | |
| aMatrixSigma = np.full((inputRange, inputRange), np.nan) | |
| aMatrixModel = np.full((fitRange, fitRange), np.nan) | |
| aMatrixSum = np.nan | |
| aMatrixModelSum = np.nan | |
| list | modelNormalization = [np.nan, np.nan] |
| usedPixels = np.full((inputRange, inputRange), np.nan) | |
| fitParamNames = list() | |
| freeFitParamNames = list() | |
| fitParams = dict() | |
| fitParamErrors = dict() | |
| fitChi2 = np.nan | |
| fitReducedChi2 = np.nan | |
| fitParamCovMatrix = np.array([]) | |
| ath = np.full((fitRange, fitRange), np.nan) | |
| athMinusBeta = np.full((fitRange, fitRange), np.nan) | |
| aN = np.full((fitRange, fitRange), np.nan) | |
| aS = np.full((fitRange, fitRange), np.nan) | |
| aE = np.full((fitRange, fitRange), np.nan) | |
| aW = np.full((fitRange, fitRange), np.nan) | |
| requiredAttributes = set(["_OBSTYPE", "_SCHEMA", "_VERSION"]) | |
| log = log if log else logging.getLogger(__name__) | |
Protected Attributes | |
| _instrument = None | |
| _raftName = None | |
| _slotName = None | |
| _detectorName = None | |
| _detectorSerial = None | |
| _detectorId = None | |
| _filter = None | |
| str | _calibId = None |
| _seqfile = None | |
| _seqname = None | |
| _seqcksum = None | |
| _metadata = PropertyList() | |
| _requiredAttributes | |
Static Protected Attributes | |
| str | _OBSTYPE = "generic" |
| str | _SCHEMA = "NO SCHEMA" |
| int | _VERSION = 0 |
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.
inputRange : `int`
The size of the input aMatrix shape in each dimension.
fitRange : `int`
The size of the input aMatrix shape in each dimension that is
used for fitting the electrostatic model. Must be less than or
equal to inputRange.
badAmps : `list`, [`str`]
List of bad amplifiers names.
gain : `dict`, [`str`,`float`]
Dictionary keyed by amp names containing the gains inherited
from the inputPTC.
aMatrix : `numpy.ndarray`
The average aMatrix inherited from the inputPTC's good amplifiers.
aMatrixSigma : `numpy.ndarray`
The uncertainty matrix used to weight the fit.
aMatrixModel : `numpy.ndarray`
The modeled aMatrix based on the electrostatic fit parameters.
aMatrixSum : `float`
The sum of the symmetrized aMatrix.
aMatrixModelSum : `float`
The sum of the symmetrized aMatrixModel.
modelNormalization : `list`
A two element array of the multiplicative and additive
normalization to the aMatrixModel.
usedPixels : `numpy.ndarray`, [`bool`]
Array of shape like aMatrix containing the mask indicating which
elements of the input aMatrix were used to fit the electrostatic
model.
fitParamNames : `list`, [`str`]
List of all the parameter names in the electrostatic fit.
freeFitParamNames : `list`, [`str`]
List of the parameter names that were allowed to vary during
the electrostatic fit.
fitParams : `dict`, [`str`, `float`]
Dictionary containing each named parameter and its final
fitted value.
fitParamErrors : `dict`, [`str`, `float`]
Dictionary containing each named parameter and its
estimated fitting error.
fitChi2 : `float`
The computed chi squared between the data and the
final model.
fitReducedChi2 : `float`
The computed reduced chi squared between the data
and the final model.
fitParamCovMatrix : `numpy.ndarray`
The estimated covariance matrix between all fit parameters.
ath : `numpy.ndarray`
something...
athMinusBeta : `numpy.ndarray`
something...
aN : `numpy.ndarray`
Array of shape (fitRange, fitRange) containing the
computed `North` component of the pixel boundary shift.
aS : `numpy.ndarray`
Array of shape (fitRange, fitRange) containing the
computed `South` component of the pixel boundary shift.
aE : `numpy.ndarray`
Array of shape (fitRange, fitRange) containing the
computed `East` component of the pixel boundary shift.
aW : `numpy.ndarray`
Array of shape (fitRange, fitRange) containing the
computed `West` component of the pixel boundary shift.
Definition at line 39 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.__init__ | ( | self, | |
| camera = None, | |||
| inputRange = 1, | |||
| fitRange = None, | |||
| ** | kwargs ) |
Filename refers to an input tuple that contains the boundary shifts for one electron. This file is produced by an electrostatic fit to data extracted from flat-field statistics, implemented in https://gitlab.in2p3.fr/astier/bfptc/tools/fit_cov.py
Definition at line 139 of file electrostaticBrighterFatter.py.
|
inherited |
Calibration equivalence. Running ``calib.log.setLevel(0)`` enables debug statements to identify problematic fields.
Definition at line 105 of file calibType.py.
|
inherited |
Definition at line 102 of file calibType.py.
|
inherited |
Method to apply the calibration to the target object.
Parameters
----------
target : `object`
Thing to validate against.
Returns
-------
valid : `bool`
Returns true if the calibration was applied correctly.
Raises
------
NotImplementedError
Raised if not implemented.
Definition at line 706 of file calibType.py.
|
inherited |
Handle common keywords.
This isn't an ideal solution, but until all calibrations
expect to find everything in the metadata, they still need to
search through dictionaries.
Parameters
----------
dictionary : `dict` or `lsst.daf.base.PropertyList`
Source for the common keywords.
Raises
------
RuntimeError
Raised if the dictionary does not match the expected OBSTYPE.
Definition at line 325 of file calibType.py.
|
inherited |
Attempt to find calibration class in metadata.
Parameters
----------
metadata : `dict` or `lsst.daf.base.PropertyList`
Metadata possibly containing a calibration class entry.
message : `str`
Message to include in any errors.
Returns
-------
calibClass : `object`
The class to use to read the file contents. Should be an
`lsst.ip.isr.IsrCalib` subclass.
Raises
------
ValueError
Raised if the resulting calibClass is the base
`lsst.ip.isr.IsrClass` (which does not implement the
content methods).
Definition at line 391 of file calibType.py.
|
inherited |
Modify the calibration parameters to match the supplied detector.
Parameters
----------
detector : `lsst.afw.cameraGeom.Detector`
Detector to use to set parameters from.
Raises
------
NotImplementedError
Raised if not implemented by a subclass.
This needs to be implemented by subclasses for each
calibration type.
Reimplemented in lsst.ip.isr.crosstalk.CrosstalkCalib, lsst.ip.isr.deferredCharge.DeferredChargeCalib, lsst.ip.isr.linearize.Linearizer, and lsst.ip.isr.ptcDataset.PhotonTransferCurveDataset.
Definition at line 588 of file calibType.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.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.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 246 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.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.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 382 of file electrostaticBrighterFatter.py.
|
inherited |
Retrieve metadata associated with this calibration.
Returns
-------
meta : `lsst.daf.base.PropertyList`
Metadata. The returned `~lsst.daf.base.PropertyList` can be
modified by the caller and the changes will be written to
external files.
Definition at line 174 of file calibType.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.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 207 of file electrostaticBrighterFatter.py.
|
inherited |
Definition at line 171 of file calibType.py.
|
inherited |
Read calibration data from a FITS file.
Parameters
----------
filename : `str`
Filename to read data from.
kwargs : `dict` or collections.abc.Mapping`, optional
Set of key=value pairs to pass to the ``fromTable``
method.
Returns
-------
calib : `lsst.ip.isr.IsrCalib`
Calibration contained within the file.
Definition at line 517 of file calibType.py.
|
inherited |
Read calibration representation from a yaml/ecsv file.
Parameters
----------
filename : `str`
Name of the file containing the calibration definition.
kwargs : `dict` or collections.abc.Mapping`, optional
Set of key=value pairs to pass to the ``fromDict`` or
``fromTable`` methods.
Returns
-------
calib : `~lsst.ip.isr.IsrCalibType`
Calibration class.
Raises
------
RuntimeError
Raised if the filename does not end in ".ecsv" or ".yaml".
Definition at line 425 of file calibType.py.
|
inherited |
Definition at line 162 of file calibType.py.
|
inherited |
Definition at line 166 of file calibType.py.
|
inherited |
Store a copy of the supplied metadata with this calibration.
Parameters
----------
metadata : `lsst.daf.base.PropertyList`
Metadata to associate with the calibration. Will be copied and
overwrite existing metadata.
Reimplemented in lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.
Definition at line 186 of file calibType.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.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.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 335 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.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.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 444 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.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.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 188 of file electrostaticBrighterFatter.py.
|
inherited |
Extract and unify metadata information.
Parameters
----------
exposures : `list`
Exposures or other calibrations to scan.
Definition at line 294 of file calibType.py.
|
inherited |
Validate that this calibration is defined and can be used.
Parameters
----------
other : `object`, optional
Thing to validate against.
Returns
-------
valid : `bool`
Returns true if the calibration is valid and appropriate.
Reimplemented in lsst.ip.isr.linearize.Linearizer, and lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.
Definition at line 691 of file calibType.py.
|
inherited |
Write calibration data to a FITS file.
Parameters
----------
filename : `str`
Filename to write data to.
Returns
-------
used : `str`
The name of the file used to write the data.
Reimplemented in lsst.ip.isr.transmissionCurve.IntermediateTransmissionCurve.
Definition at line 565 of file calibType.py.
|
inherited |
Write the calibration data to a text file.
Parameters
----------
filename : `str`
Name of the file to write.
format : `str`
Format to write the file as. Supported values are:
``"auto"`` : Determine filetype from filename.
``"yaml"`` : Write as yaml.
``"ecsv"`` : Write as ecsv.
Returns
-------
used : `str`
The name of the file used to write the data. This may
differ from the input if the format is explicitly chosen.
Raises
------
RuntimeError
Raised if filename does not end in a known extension, or
if all information cannot be written.
Notes
-----
The file is written to YAML/ECSV format and will include any
associated metadata.
Definition at line 463 of file calibType.py.
|
protectedinherited |
Definition at line 76 of file calibType.py.
|
protectedinherited |
Definition at line 74 of file calibType.py.
|
protectedinherited |
Definition at line 72 of file calibType.py.
|
protectedinherited |
Definition at line 73 of file calibType.py.
|
protectedinherited |
Definition at line 75 of file calibType.py.
|
protectedinherited |
Definition at line 69 of file calibType.py.
|
protectedinherited |
Definition at line 80 of file calibType.py.
|
staticprotectedinherited |
Definition at line 64 of file calibType.py.
|
protectedinherited |
Definition at line 70 of file calibType.py.
|
protectedinherited |
Definition at line 115 of file calibType.py.
|
staticprotectedinherited |
Definition at line 65 of file calibType.py.
|
protectedinherited |
Definition at line 79 of file calibType.py.
|
protectedinherited |
Definition at line 77 of file calibType.py.
|
protectedinherited |
Definition at line 78 of file calibType.py.
|
protectedinherited |
Definition at line 71 of file calibType.py.
|
staticprotectedinherited |
Definition at line 66 of file calibType.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aE = np.full((fitRange, fitRange), np.nan) |
Definition at line 171 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aMatrix = np.full((inputRange, inputRange), np.nan) |
Definition at line 153 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aMatrixModel = np.full((fitRange, fitRange), np.nan) |
Definition at line 155 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aMatrixModelSum = np.nan |
Definition at line 157 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aMatrixSigma = np.full((inputRange, inputRange), np.nan) |
Definition at line 154 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aMatrixSum = np.nan |
Definition at line 156 of file electrostaticBrighterFatter.py.
| list lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.ampNames = [] |
Definition at line 146 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aN = np.full((fitRange, fitRange), np.nan) |
Definition at line 169 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aS = np.full((fitRange, fitRange), np.nan) |
Definition at line 170 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.ath = np.full((fitRange, fitRange), np.nan) |
Definition at line 167 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.athMinusBeta = np.full((fitRange, fitRange), np.nan) |
Definition at line 168 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.aW = np.full((fitRange, fitRange), np.nan) |
Definition at line 172 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.badAmps = list() |
Definition at line 151 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.fitChi2 = np.nan |
Definition at line 164 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.fitParamCovMatrix = np.array([]) |
Definition at line 166 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.fitParamErrors = dict() |
Definition at line 163 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.fitParamNames = list() |
Definition at line 160 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.fitParams = dict() |
Definition at line 162 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.fitRange = fitRange |
Definition at line 150 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.fitReducedChi2 = np.nan |
Definition at line 165 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.freeFitParamNames = list() |
Definition at line 161 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.gain = dict() |
Definition at line 152 of file electrostaticBrighterFatter.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.inputRange = inputRange |
Definition at line 147 of file electrostaticBrighterFatter.py.
|
inherited |
Definition at line 96 of file calibType.py.
| list lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.modelNormalization = [np.nan, np.nan] |
Definition at line 158 of file electrostaticBrighterFatter.py.
|
inherited |
Definition at line 90 of file calibType.py.
| lsst.ip.isr.electrostaticBrighterFatter.ElectrostaticBrighterFatterDistortionMatrix.usedPixels = np.full((inputRange, inputRange), np.nan) |
Definition at line 159 of file electrostaticBrighterFatter.py.