lsst.ip.isr g32debb59f0+f0b7ece141
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.isr.linearize.LinearizeBase Class Reference
Inheritance diagram for lsst.ip.isr.linearize.LinearizeBase:
lsst.ip.isr.linearize.LinearizeLookupTable lsst.ip.isr.linearize.LinearizeNone lsst.ip.isr.linearize.LinearizePolynomial lsst.ip.isr.linearize.LinearizeProportional lsst.ip.isr.linearize.LinearizeSpline lsst.ip.isr.linearize.LinearizeSquared

Public Member Functions

def __call__ (self, image, **kwargs)
 

Static Public Attributes

 LinearityType = None
 

Detailed Description

Abstract base class functor for correcting non-linearity.

Subclasses must define __call__ and set class variable
LinearityType to a string that will be used for linearity type in
the cameraGeom.Amplifier.linearityType field.

All linearity corrections should be defined in terms of an
additive correction, such that:

corrected_value = uncorrected_value + f(uncorrected_value)

Definition at line 475 of file linearize.py.

Member Function Documentation

◆ __call__()

def lsst.ip.isr.linearize.LinearizeBase.__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`).
    ``"table"``
        Lookup table data (`numpy.array`).
    ``"log"``
        Logger to handle messages (`logging.Logger`).

Returns
-------
output : `bool`
    If true, a correction was applied successfully.

Raises
------
RuntimeError:
    Raised if the linearity type listed in the
    detector does not match the class type.

Reimplemented in lsst.ip.isr.linearize.LinearizeLookupTable, lsst.ip.isr.linearize.LinearizePolynomial, lsst.ip.isr.linearize.LinearizeSquared, lsst.ip.isr.linearize.LinearizeSpline, lsst.ip.isr.linearize.LinearizeProportional, and lsst.ip.isr.linearize.LinearizeNone.

Definition at line 490 of file linearize.py.

Member Data Documentation

◆ LinearityType

lsst.ip.isr.linearize.LinearizeBase.LinearityType = None
static

Definition at line 487 of file linearize.py.


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