lsst.ip.isr.linearize.LinearizeBase Class Reference

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

Public Member Functions
	__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 694 of file linearize.py.

Member Function Documentation

__call__()

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 `np.ndarray`).
    ``table``
        Lookup table data (`np.ndarray`).
    ``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.

Definition at line 709 of file linearize.py.

Member Data Documentation

LinearityType

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

static

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