lsst.ip.isr.linearize.LinearizeSquared Class Reference

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

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

Static Public Attributes
str	LinearityType = "Squared"

Detailed Description

Correct non-linearity with a squared model.

corrImage = uncorrImage + c0*uncorrImage^2

where c0 is linearity coefficient 0 for each amplifier.

Definition at line 679 of file linearize.py.

Member Function Documentation

__call__()

lsst.ip.isr.linearize.LinearizeSquared.__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 688 of file linearize.py.

    def __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.
        """
 
        sqCoeff = kwargs['coeffs'][0]
        if sqCoeff != 0:
            ampArr = image.getArray()
            ampArr *= (1 + sqCoeff*ampArr)
            return True, 0
        else:
            return False, 0
 
 

Member Data Documentation

LinearityType

str lsst.ip.isr.linearize.LinearizeSquared.LinearityType = "Squared"

static

Definition at line 686 of file linearize.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g02d81e74bb+bd2ed33bd6/python/lsst/ip/isr/linearize.py