lsst.ip.isr  21.0.0-18-g4012351+0a75f16931
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

def __call__ (self, image, **kwargs)
 

Static Public Attributes

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

Member Function Documentation

◆ __call__()

def 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 (`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 705 of file linearize.py.

Member Data Documentation

◆ LinearityType

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

Definition at line 703 of file linearize.py.


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