lsst.ip.isr  14.0-6-g095d685
Public Member Functions | Static Public Attributes | List of all members
lsst.ip.isr.linearize.LinearizeSquared Class Reference
Inheritance diagram for lsst.ip.isr.linearize.LinearizeSquared:
lsst.ip.isr.linearize.LinearizeBase

Public Member Functions

def __call__ (self, image, detector, log=None)
 
def checkLinearityType (self, detector)
 

Static Public Attributes

string LinearityType = "Squared"
 

Detailed Description

Correct non-linearity with a squared model

corrImage = uncorrImage + c0*uncorrImage^2

where c0 is linearity coefficient 0 in the AmpInfoCatalog of the detector

Definition at line 194 of file linearize.py.

Member Function Documentation

◆ __call__()

def lsst.ip.isr.linearize.LinearizeSquared.__call__ (   self,
  image,
  detector,
  log = None 
)
Correct for non-linearity

@param[in] image  image to be corrected (an lsst.afw.image.Image)
@param[in] detector  detector info about image (an lsst.afw.cameraGeom.Detector)
@param[in] log  logger (an lsst.log.Log), or None to disable logging;
    a warning is logged if any amplifiers are skipped because the square coefficient is 0

@return an lsst.pipe.base.Struct containing at least the following fields:
- nAmps number of amplifiers found
- nLinearized  number of amplifiers linearized

@throw RuntimeError if the linearity type is wrong

Definition at line 203 of file linearize.py.

◆ checkLinearityType()

def lsst.ip.isr.linearize.LinearizeBase.checkLinearityType (   self,
  detector 
)
inherited
Verify that the linearity type is correct for this detector

@warning only checks the first record of the amp info catalog

@param[in] detector  detector information (an instance of lsst::afw::cameraGeom::Detector)

@throw RuntimeError if anything doesn't match

Definition at line 62 of file linearize.py.

Member Data Documentation

◆ LinearityType

string lsst.ip.isr.linearize.LinearizeSquared.LinearityType = "Squared"
static

Definition at line 201 of file linearize.py.


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