lsst.ip.isr gdc0c513512+9ee1ab4172
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.isr.linearize.LinearizeSpline Class Reference
Inheritance diagram for lsst.ip.isr.linearize.LinearizeSpline:
lsst.ip.isr.linearize.LinearizeBase

Public Member Functions

 __call__ (self, image, **kwargs)
 

Static Public Attributes

str LinearityType = "Spline"
 

Detailed Description

Correct non-linearity with a spline model.

corrImage = uncorrImage - Spline(coeffs, uncorrImage)

Notes
-----

The spline fit calculates a correction as a function of the
expected linear flux term.  Because of this, the correction needs
to be subtracted from the observed flux.

Definition at line 720 of file linearize.py.

Member Function Documentation

◆ __call__()

lsst.ip.isr.linearize.LinearizeSpline.__call__ ( self,
image,
** kwargs )
Correct for 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`).
    ``log``
        Logger to handle messages (`logging.Logger`).

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 735 of file linearize.py.

Member Data Documentation

◆ LinearityType

str lsst.ip.isr.linearize.LinearizeSpline.LinearityType = "Spline"
static

Definition at line 733 of file linearize.py.


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