LinearizeBase#

class lsst.ip.isr.LinearizeBase#

Bases: object

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)

Attributes Summary

LinearityType

Methods Summary

__call__(image, **kwargs)

Correct non-linearity.

Attributes Documentation

LinearityType = None#

Methods Documentation

abstract __call__(image, **kwargs)#

Correct non-linearity.

Parameters#

imagelsst.afw.image.Image

Image to be corrected

kwargsdict

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#

outputbool: If True, a correction was applied successfully.

Raises#

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