lsst.pipe.drivers.constructCalibs.CalibCombineTask Class Reference

Inheritance diagram for lsst.pipe.drivers.constructCalibs.CalibCombineTask:

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	run (self, sensorRefList, expScales=None, finalScale=None, inputName="postISRCCD")
	Combine calib images for a single sensor. More...
def	getDimensions (self, sensorRefList, inputName="postISRCCD")
def	applyScale (self, exposure, scale=None)
def	combine (self, target, imageList, stats)
	Combine multiple images. More...

Static Public Attributes
	ConfigClass = CalibCombineConfig

Detailed Description

Task to combine calib images

Definition at line 91 of file constructCalibs.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.drivers.constructCalibs.CalibCombineTask.__init__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 95 of file constructCalibs.py.

    def __init__(self, *args, **kwargs):
        Task.__init__(self, *args, **kwargs)
        self.makeSubtask("stats")
 

Member Function Documentation

applyScale()

def lsst.pipe.drivers.constructCalibs.CalibCombineTask.applyScale	(		self,
			exposure,
			scale = None
	)

Apply scale to input exposure

This implementation applies a flux scaling: the input exposure is
divided by the provided scale.

Definition at line 155 of file constructCalibs.py.

    def applyScale(self, exposure, scale=None):
        """Apply scale to input exposure
 
        This implementation applies a flux scaling: the input exposure is
        divided by the provided scale.
        """
        if scale is not None:
            mi = exposure.getMaskedImage()
            mi /= scale
 

combine()

def lsst.pipe.drivers.constructCalibs.CalibCombineTask.combine	(		self,
			target,
			imageList,
			stats
	)

Combine multiple images.

    @param target      Target image to receive the combined pixels
    @param imageList   List of input images
    @param stats       Statistics control

Definition at line 165 of file constructCalibs.py.

    def combine(self, target, imageList, stats):
        """!Combine multiple images
 
        @param target      Target image to receive the combined pixels
        @param imageList   List of input images
        @param stats       Statistics control
        """
        images = [img for img in imageList if img is not None]
        afwMath.statisticsStack(target, images, afwMath.Property(self.config.combine), stats)
 
 

getDimensions()

def lsst.pipe.drivers.constructCalibs.CalibCombineTask.getDimensions	(		self,
			sensorRefList,
			inputName = "postISRCCD"
	)

Get dimensions of the inputs

Definition at line 145 of file constructCalibs.py.

    def getDimensions(self, sensorRefList, inputName="postISRCCD"):
        """Get dimensions of the inputs"""
        dimList = []
        for sensorRef in sensorRefList:
            if sensorRef is None:
                continue
            md = sensorRef.get(inputName + "_md")
            dimList.append(afwImage.bboxFromMetadata(md).getDimensions())
        return getSize(dimList)
 

run()

def lsst.pipe.drivers.constructCalibs.CalibCombineTask.run	(		self,
			sensorRefList,
			expScales = None,
			finalScale = None,
			inputName = "postISRCCD"
	)

Combine calib images for a single sensor.

    @param sensorRefList   List of data references to combine (for a single sensor)
    @param expScales       List of scales to apply for each exposure
    @param finalScale      Desired scale for final combined image
    @param inputName       Data set name for inputs
    @return combined image

Definition at line 99 of file constructCalibs.py.

    def run(self, sensorRefList, expScales=None, finalScale=None, inputName="postISRCCD"):
        """!Combine calib images for a single sensor
 
        @param sensorRefList   List of data references to combine (for a single sensor)
        @param expScales       List of scales to apply for each exposure
        @param finalScale      Desired scale for final combined image
        @param inputName       Data set name for inputs
        @return combined image
        """
        width, height = self.getDimensions(sensorRefList)
        stats = afwMath.StatisticsControl(self.config.clip, self.config.nIter,
                                          afwImage.Mask.getPlaneBitMask(self.config.mask))
        numImages = len(sensorRefList)
        if numImages < 1:
            raise RuntimeError("No valid input data")
        if numImages < self.config.stats.maxVisitsToCalcErrorFromInputVariance:
            stats.setCalcErrorFromInputVariance(True)
 
        # Combine images
        combined = afwImage.MaskedImageF(width, height)
        imageList = [None]*numImages
        for start in range(0, height, self.config.rows):
            rows = min(self.config.rows, height - start)
            box = geom.Box2I(geom.Point2I(0, start),
                             geom.Extent2I(width, rows))
            subCombined = combined.Factory(combined, box)
 
            for i, sensorRef in enumerate(sensorRefList):
                if sensorRef is None:
                    imageList[i] = None
                    continue
                exposure = sensorRef.get(inputName + "_sub", bbox=box)
                if expScales is not None:
                    self.applyScale(exposure, expScales[i])
                imageList[i] = exposure.getMaskedImage()
 
            self.combine(subCombined, imageList, stats)
 
        if finalScale is not None:
            background = self.stats.run(combined)
            self.log.info("%s: Measured background of stack is %f; adjusting to %f" %
                          (NODE, background, finalScale))
            combined *= finalScale / background
 
        return combined
 

Member Data Documentation

ConfigClass

lsst.pipe.drivers.constructCalibs.CalibCombineTask.ConfigClass = CalibCombineConfig

static

Definition at line 93 of file constructCalibs.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_drivers/22.0.0+1ea9a8b2b2/python/lsst/pipe/drivers/constructCalibs.py