lsst.ip.isr.linearize.LinearizeSpline Class Reference

Inheritance diagram for lsst.ip.isr.linearize.LinearizeSpline:

Public Member Functions
	__call__ (self, image, **kwargs)

Static Public Attributes
	LinearityType = None

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 916 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 `np.ndarray`).
    ``log``
        Logger to handle messages (`logging.Logger`).
    ``gain``
        Gain value to apply.

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.

Definition at line 931 of file linearize.py.

Member Data Documentation

LinearityType

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

staticinherited

Definition at line 706 of file linearize.py.

---

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

• python/lsst/ip/isr/linearize.py