Skip to content

Commit

Permalink
Add linearizer attribute documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
czwa committed Aug 31, 2020
1 parent 5206b3c commit 04e4c35
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions python/lsst/ip/isr/linearize.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,36 @@ class Linearizer(IsrCalib):
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 linearizer attributes stored are:
hasLinearity : `bool`
Whether a linearity correction is defined for this detector.
override : `bool`
Whether the detector parameters should be overridden.
ampNames : `list` [`str`]
List of amplifier names to correct.
linearityCoeffs : `dict` [`str`, `numpy.array`]
Coefficients to use in correction. Indexed by amplifier
names. The format of the array depends on the type of
correction to apply.
linearityType : `dict` [`str`, `str`]
Type of correction to use, indexed by amplifier names.
linearityBBox : `dict` [`str`, `lsst.geom.Box2I`]
Bounding box the correction is valid over, indexed by
amplifier names.
fitParams : `dict` [`str`, `numpy.array`], optional
Linearity fit parameters used to construct the correction
coefficients, indexed as above.
fitParamsErr : `dict` [`str`, `numpy.array`], optional
Uncertainty values of the linearity fit parameters used to
construct the correction coefficients, indexed as above.
fitChiSq : `dict` [`str`, `float`], optional
Chi-squared value of the linearity fit, indexed as above.
tableData : `numpy.array`, optional
Lookup table data for the linearity correction.
"""
_OBSTYPE = "LINEARIZER"
_SCHEMA = 'Gen3 Linearizer'
Expand Down

0 comments on commit 04e4c35

Please sign in to comment.