lsst.cp.pipe.cpCombine.CalibStatsTask Class Reference

Inheritance diagram for lsst.cp.pipe.cpCombine.CalibStatsTask:

Public Member Functions
def	run (self, exposureOrImage)

Static Public Attributes
	ConfigClass = CalibStatsConfig

Detailed Description

Measure statistics on the background

This can be useful for scaling the background, e.g., for flats and fringe frames.

Definition at line 62 of file cpCombine.py.

Member Function Documentation

run()

def lsst.cp.pipe.cpCombine.CalibStatsTask.run	(		self,
			exposureOrImage
	)

Measure a particular statistic on an image (of some sort).

Parameters
----------
exposureOrImage : `lsst.afw.image.Exposure`, `lsst.afw.image.MaskedImage`, or `lsst.afw.image.Image`
   Exposure or image to calculate statistics on.

Returns
-------
results : float
   Resulting statistic value.

Definition at line 69 of file cpCombine.py.

    def run(self, exposureOrImage):
        """Measure a particular statistic on an image (of some sort).
 
        Parameters
        ----------
        exposureOrImage : `lsst.afw.image.Exposure`, `lsst.afw.image.MaskedImage`, or `lsst.afw.image.Image`
           Exposure or image to calculate statistics on.
 
        Returns
        -------
        results : float
           Resulting statistic value.
        """
        stats = afwMath.StatisticsControl(self.config.clip, self.config.nIter,
                                          afwImage.Mask.getPlaneBitMask(self.config.mask))
        try:
            image = exposureOrImage.getMaskedImage()
        except Exception:
            try:
                image = exposureOrImage.getImage()
            except Exception:
                image = exposureOrImage
        statType = afwMath.stringToStatisticsProperty(self.config.stat)
        return afwMath.makeStatistics(image, statType, stats).getValue()
 
 

Member Data Documentation

ConfigClass

lsst.cp.pipe.cpCombine.CalibStatsTask.ConfigClass = CalibStatsConfig

static

Definition at line 67 of file cpCombine.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.6.0/Linux64/cp_pipe/22.0.1-18-gb17765a+2264247a6b/python/lsst/cp/pipe/cpCombine.py