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

Public Member Functions
def	__init__ (self, table=None, detector=None, override=False, log=None)

def	__call__ (self, exposure)

def	fromDetector (self, detector)

def	fromYaml (self, yamlObject)

def	toDict (self)

def	getLinearityTypeByName (self, linearityTypeName)

def	validate (self, detector=None, amplifier=None)

def	applyLinearity (self, image, detector=None, log=None)

Public Attributes
	linearityCoeffs

	linearityType

	linearityThreshold

	linearityMaximum

	linearityUnits

	linearityBBox

	override

	populated

	log

	tableData

Detailed Description

Parameter set for linearization.

These parameters are included in cameraGeom.Amplifier, but
should be accessible externally to allow for testing.

Parameters
----------
table : `numpy.array`, optional
    Lookup table; a 2-dimensional array of floats:
        - one row for each row index (value of coef[0] in the amplifier)
        - one column for each image value
    To avoid copying the table the last index should vary fastest
    (numpy default "C" order)
override : `bool`, optional
    Override the parameters defined in the detector/amplifier.
log : `lsst.log.Log`, optional
    Logger to handle messages.

Raises
------
RuntimeError :
    Raised if the supplied table is not 2D, or if the table has fewer
    columns than rows (indicating that the indices are swapped).

Definition at line 34 of file linearize.py.

Constructor & Destructor Documentation

◆ init()

def lsst.ip.isr.linearize.Linearizer.__init__	(	self,
		table = `None`,
		detector = `None`,
		override = `False`,
		log = `None`
	)

Definition at line 59 of file linearize.py.

Member Function Documentation

◆ call()

def lsst.ip.isr.linearize.Linearizer.__call__	(	self,
		exposure
	)

Apply linearity, setting parameters if necessary.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to correct.

Returns
-------
output : `lsst.pipe.base.Struct`
    Linearization results:
    ``"numAmps"``
Number of amplifiers considered.
    ``"numLinearized"``
Number of amplifiers linearized.

Definition at line 85 of file linearize.py.

◆ applyLinearity()

def lsst.ip.isr.linearize.Linearizer.applyLinearity	(	self,
		image,
		detector = `None`,
		log = `None`
	)

Apply the linearity to an image.

If the linearity parameters are populated, use those,
otherwise use the values from the detector.

Parameters
----------
image : `~lsst.afw.image.image`
    Image to correct.
detector : `~lsst.afw.cameraGeom.detector`
    Detector to use for linearity parameters if not already
    populated.
log : `~lsst.log.Log`, optional
    Log object to use for logging.

Definition at line 233 of file linearize.py.

◆ fromDetector()

def lsst.ip.isr.linearize.Linearizer.fromDetector	(	self,
		detector
	)

Read linearity parameters from a detector.

Parameters
----------
detector : `lsst.afw.cameraGeom.detector`
    Input detector with parameters to use.

Definition at line 103 of file linearize.py.

◆ fromYaml()

def lsst.ip.isr.linearize.Linearizer.fromYaml	(	self,
		yamlObject
	)

Read linearity parameters from a dict.

Parameters
----------
yamlObject : `dict`
    Dictionary containing detector and amplifier information.

Definition at line 122 of file linearize.py.

◆ getLinearityTypeByName()

def lsst.ip.isr.linearize.Linearizer.getLinearityTypeByName	(	self,
		linearityTypeName
	)

Determine the linearity class to use from the type name.

Parameters
----------
linearityTypeName : str
    String name of the linearity type that is needed.

Returns
-------
linearityType : `~lsst.ip.isr.linearize.LinearizeBase`
    The appropriate linearity class to use.  If no matching class
    is found, `None` is returned.

Definition at line 157 of file linearize.py.

◆ toDict()

def lsst.ip.isr.linearize.Linearizer.toDict ( self )

Return linearity parameters as a dict.

Returns
-------
outDict : `dict`:

Definition at line 141 of file linearize.py.

◆ validate()

def lsst.ip.isr.linearize.Linearizer.validate	(	self,
		detector = `None`,
		amplifier = `None`
	)

Validate linearity for a detector/amplifier.

Parameters
----------
detector : `lsst.afw.cameraGeom.Detector`, optional
    Detector to validate, along with its amplifiers.
amplifier : `lsst.afw.cameraGeom.Amplifier`, optional
    Single amplifier to validate.

Raises
------
RuntimeError :
    Raised if there is a mismatch in linearity parameters, and
    the cameraGeom parameters are not being overridden.

Definition at line 180 of file linearize.py.

Member Data Documentation

◆ linearityBBox

lsst.ip.isr.linearize.Linearizer.linearityBBox

Definition at line 68 of file linearize.py.

◆ linearityCoeffs

lsst.ip.isr.linearize.Linearizer.linearityCoeffs

Definition at line 63 of file linearize.py.

◆ linearityMaximum

lsst.ip.isr.linearize.Linearizer.linearityMaximum

Definition at line 66 of file linearize.py.

◆ linearityThreshold

lsst.ip.isr.linearize.Linearizer.linearityThreshold

Definition at line 65 of file linearize.py.

◆ linearityType

lsst.ip.isr.linearize.Linearizer.linearityType

Definition at line 64 of file linearize.py.

◆ linearityUnits

lsst.ip.isr.linearize.Linearizer.linearityUnits

Definition at line 67 of file linearize.py.

◆ log

lsst.ip.isr.linearize.Linearizer.log

Definition at line 72 of file linearize.py.

◆ override

lsst.ip.isr.linearize.Linearizer.override

Definition at line 70 of file linearize.py.

◆ populated

lsst.ip.isr.linearize.Linearizer.populated

Definition at line 71 of file linearize.py.

◆ tableData

lsst.ip.isr.linearize.Linearizer.tableData

Definition at line 74 of file linearize.py.

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

python/lsst/ip/isr/linearize.py

Public Member Functions

Public Attributes