lsst.ip.isr  20.0.0-25-g5eafb0f+e9f7dc078a
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.isr.linearize.LinearizePolynomial Class Reference
Inheritance diagram for lsst.ip.isr.linearize.LinearizePolynomial:
lsst.ip.isr.linearize.LinearizeBase

Public Member Functions

def __call__ (self, image, **kwargs)
 

Static Public Attributes

string LinearityType = "Polynomial"
 

Detailed Description

Correct non-linearity with a polynomial mode.

corrImage = uncorrImage + sum_i c_i uncorrImage^(2 + i)

where c_i are the linearity coefficients for each amplifier.
Lower order coefficients are not included as they duplicate other
calibration parameters:
    ``"k0"``
        A coefficient multiplied by uncorrImage**0 is equivalent to
        bias level.  Irrelevant for correcting non-linearity.
    ``"k1"``
        A coefficient multiplied by uncorrImage**1 is proportional
        to the gain.  Not necessary for correcting non-linearity.

Definition at line 594 of file linearize.py.

Member Function Documentation

◆ __call__()

def lsst.ip.isr.linearize.LinearizePolynomial.__call__ (   self,
  image,
**  kwargs 
)
Correct non-linearity.

Parameters
----------
image : `lsst.afw.image.Image`
    Image to be corrected
kwargs : `dict`
    Dictionary of parameter keywords:
    ``"coeffs"``
Coefficient vector (`list` or `numpy.array`).
If the order of the polynomial is n, this list
should have a length of n-1 ("k0" and "k1" are
not needed for the correction).
    ``"log"``
Logger to handle messages (`lsst.log.Log`).

Returns
-------
output : `tuple` [`bool`, `int`]
    If true, a correction was applied successfully.  The
    integer indicates the number of pixels that were
    uncorrectable by being out of range.

Reimplemented from lsst.ip.isr.linearize.LinearizeBase.

Definition at line 611 of file linearize.py.

Member Data Documentation

◆ LinearityType

string lsst.ip.isr.linearize.LinearizePolynomial.LinearityType = "Polynomial"
static

Definition at line 609 of file linearize.py.


The documentation for this class was generated from the following file: