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

Public Member Functions
def	__call__ (self, image, detector, log=None)

def	checkLinearityType (self, detector)

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 AmpInfoCatalog

Definition at line 52 of file linearize.py.

Member Function Documentation

◆ call()

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

Correct non-linearity

@param[in] image  image to be corrected (an lsst.afw.image.Image)
@param[in] detector  detector information (an instance of lsst::afw::cameraGeom::Detector)
@param[in] log  logger (an lsst.log.Log), or None to disable logging;
    a warning is logged if amplifiers are skipped or other worrisome events occur

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

@throw RuntimeError if the linearity type is wrong
@throw a subclass of Exception if linearization fails for any other reason

Definition at line 61 of file linearize.py.

     def __call__(self, image, detector, log=None):
         """Correct non-linearity
 
         @param[in] image  image to be corrected (an lsst.afw.image.Image)
         @param[in] detector  detector information (an instance of lsst::afw::cameraGeom::Detector)
         @param[in] log  logger (an lsst.log.Log), or None to disable logging;
                     a warning is logged if amplifiers are skipped or other worrisome events occur
 
         @return an lsst.pipe.base.Struct containing at least the following fields:
         - numAmps number of amplifiers found
         - numLinearized  number of amplifiers linearized
 
         @throw RuntimeError if the linearity type is wrong
         @throw a subclass of Exception if linearization fails for any other reason
         """
         pass
 

◆ checkLinearityType()

def lsst.ip.isr.linearize.LinearizeBase.checkLinearityType	(	self,
		detector
	)

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 78 of file linearize.py.

     def checkLinearityType(self, detector):
         """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
         """
         ampInfoType = detector.getAmpInfoCatalog()[0].getLinearityType()
         if self.LinearityType != ampInfoType:
             raise RuntimeError("Linearity types don't match: %s != %s" % (self.LinearityType, ampInfoType))
 
 

Member Data Documentation

◆ LinearityType

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

static

Definition at line 58 of file linearize.py.

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

/j/snowflake/release/lsstsw/stack/Linux64/ip_isr/16.0-22-g62d8060+4/python/lsst/ip/isr/linearize.py

Public Member Functions