Inheritance diagram for lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection:
Public Member Functions | |
| def | __init__ (self, table=None, **kwargs) |
| def | updateMetadata (self, setDate=False, **kwargs) |
| def | fromDict (cls, dictionary) |
| def | toDict (self) |
| def | fromTable (cls, tableList) |
| def | toTable (self) |
| def | validate (self) |
Public Attributes | |
| abscissaCorrections | |
| tableData | |
Detailed Description
Parameter set for photodiode correction.
These parameters are included in cameraGeom.Amplifier, but
should be accessible externally to allow for testing.
Parameters
----------
table : `numpy.array`, optional
Lookup table; a 2-dimensional array of floats:
- one row for each row index (value of coef[0] in the amplifier)
- one column for each image value
To avoid copying the table the last index should vary fastest
(numpy default "C" order)
log : `logging.Logger`, optional
Logger to handle messages.
kwargs : `dict`, optional
Other keyword arguments to pass to the parent init.
Raises
------
RuntimeError :
Raised if the supplied table is not 2D, or if the table has fewer
columns than rows (indicating that the indices are swapped).
Notes
-----
The photodiode correction attributes stored are:
abscissaCorrections : `dict` : [`str`, `float`]
Correction value indexed by exposure pair
Definition at line 31 of file photodiodeCorrection.py.
Constructor & Destructor Documentation
◆ __init__()
| def lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.__init__ | ( | self, | |
table = None, |
|||
| ** | kwargs | ||
| ) |
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 66 of file photodiodeCorrection.py.
Member Function Documentation
◆ fromDict()
| def lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.fromDict | ( | cls, | |
| dictionary | |||
| ) |
Construct a PhotodiodeCorrection from a dictionary of properties.
Parameters
----------
dictionary : `dict`
Dictionary of properties.
Returns
-------
calib : `lsst.ip.isr.PhotodiodeCorrection`
Constructed photodiode data.
Raises
------
RuntimeError :
Raised if the supplied dictionary is for a different
calibration type.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 97 of file photodiodeCorrection.py.
◆ fromTable()
| def lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.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 crosstalk
calibration.
Returns
-------
calib : `lsst.ip.isr.PhotodiodeCorrection`
The calibration defined in the tables.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 158 of file photodiodeCorrection.py.
◆ toDict()
| def lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.toDict | ( | self | ) |
Return a dictionary containing the photodiode correction 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 133 of file photodiodeCorrection.py.
◆ toTable()
| def lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.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` [`astropy.table.Table`]
List of tables containing the photodiode correction
information.
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 193 of file photodiodeCorrection.py.
◆ updateMetadata()
| def lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.updateMetadata | ( | self, | |
setDate = False, |
|||
| ** | kwargs | ||
| ) |
Update metadata keywords with new values.
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 79 of file photodiodeCorrection.py.
◆ validate()
| def lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.validate | ( | self | ) |
Validate photodiode correction
Reimplemented from lsst.ip.isr.calibType.IsrCalib.
Definition at line 220 of file photodiodeCorrection.py.
Member Data Documentation
◆ abscissaCorrections
| lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.abscissaCorrections |
Definition at line 67 of file photodiodeCorrection.py.
◆ tableData
| lsst.ip.isr.photodiodeCorrection.PhotodiodeCorrection.tableData |
Definition at line 68 of file photodiodeCorrection.py.
The documentation for this class was generated from the following file:
- python/lsst/ip/isr/photodiodeCorrection.py
