lsst.coadd.chisquared.coadd.Coadd Class Reference

Inheritance diagram for lsst.coadd.chisquared.coadd.Coadd:

Public Member Functions
def	__init__ (self, bbox, wcs, badMaskPlanes, logName="coadd.chisquared.Coadd")
def	addExposure (self, exposure, weightFactor=1.0)
def	fromConfig (cls, bbox, wcs, config, logName="coadd.utils.Coadd")
def	getCoadd (self)
def	getFilters (self)
def	getBadPixelMask (self)
def	getBBox (self)
def	getWcs (self)
def	getWeightMap (self)

Static Public Attributes
	ConfigClass = CoaddConfig

Detailed Description

Create a chi-squared coadd.

Parameters
----------
bbox : `lsst.afw.geom.Box2I`
    Bounding box of coadd Exposure with respect to parent:
    coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()
wcs : `lsst.afw.geom.SkyWcs`
    WCS of coadd exposure
badMaskPlanes : `list` of `str`
    Mask planes to pay attention to when rejecting masked pixels.
    Specify as a collection of names.
    badMaskPlanes should always include "EDGE".
logName : `str`, optional
    Name by which messages are logged.

Definition at line 28 of file coadd.py.

Constructor & Destructor Documentation

__init__()

def lsst.coadd.chisquared.coadd.Coadd.__init__	(		self,
			bbox,
			wcs,
			badMaskPlanes,
			logName = "coadd.chisquared.Coadd"
	)

Definition at line 46 of file coadd.py.

    def __init__(self, bbox, wcs, badMaskPlanes, logName="coadd.chisquared.Coadd"):
        coaddUtils.Coadd.__init__(self,
                                  bbox=bbox,
                                  wcs=wcs,
                                  badMaskPlanes=badMaskPlanes,
                                  logName=logName,
                                  )

Member Function Documentation

addExposure()

def lsst.coadd.chisquared.coadd.Coadd.addExposure	(		self,
			exposure,
			weightFactor = 1.0
	)

Add a an exposure to the coadd; it is assumed to have the same WCS
as the coadd

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to add to coadd; this must be:
    - background-subtracted or background-matched to the other images
      being coadded
    - psf-matched to the desired PSF model (optional)
    - warped to match the coadd
weightFactor : `float`
    weight with which to add exposure to coadd

Returns
-------
overlapBBox : `lsst.afw.geom.Box2I`
    Region of overlap between ``exposure`` and coadd in parent
    coordinates.
weight : `float`
    Weight with which ``exposure`` was added to coadd;
    weight = weightFactor for this kind of coadd.

Definition at line 54 of file coadd.py.

    def addExposure(self, exposure, weightFactor=1.0):
        """Add a an exposure to the coadd; it is assumed to have the same WCS
        as the coadd

        Parameters
        ----------
        exposure : `lsst.afw.image.Exposure`
            Exposure to add to coadd; this must be:
            - background-subtracted or background-matched to the other images
              being coadded
            - psf-matched to the desired PSF model (optional)
            - warped to match the coadd
        weightFactor : `float`
            weight with which to add exposure to coadd

        Returns
        -------
        overlapBBox : `lsst.afw.geom.Box2I`
            Region of overlap between ``exposure`` and coadd in parent
            coordinates.
        weight : `float`
            Weight with which ``exposure`` was added to coadd;
            weight = weightFactor for this kind of coadd.
        """
        self._log.info("add exposure to coadd")

        # save filter info
        filter = exposure.getFilter()
        self._filterDict.setdefault(filter.getName(), filter)

        overlapBBox = addToCoadd(self._coadd.getMaskedImage(), self._weightMap,
                                 exposure.getMaskedImage(), self._badPixelMask, weightFactor)

        return overlapBBox, weightFactor

fromConfig()

def lsst.coadd.utils.coadd.Coadd.fromConfig (   cls,   bbox,   wcs,   config,   logName = "coadd.utils.Coadd"  )

inherited

Create a coadd

@param[in] bbox: bounding box of coadd Exposure with respect to parent (lsst.afw.geom.Box2I):
    coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()
@param[in] wcs: WCS of coadd exposure (lsst.afw.geom.SKyWcs)
@param[in] config: coadd config; an instance of CoaddConfig
@param[in] logName: name by which messages are logged

Definition at line 76 of file coadd.py.

    def fromConfig(cls, bbox, wcs, config, logName="coadd.utils.Coadd"):
        """Create a coadd

        @param[in] bbox: bounding box of coadd Exposure with respect to parent (lsst.afw.geom.Box2I):
            coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()
        @param[in] wcs: WCS of coadd exposure (lsst.afw.geom.SKyWcs)
        @param[in] config: coadd config; an instance of CoaddConfig
        @param[in] logName: name by which messages are logged
        """
        return cls(
            bbox=bbox,
            wcs=wcs,
            badMaskPlanes=config.badMaskPlanes,
            logName=logName,
        )

getBadPixelMask()

def lsst.coadd.utils.coadd.Coadd.getBadPixelMask (   self )

inherited

Return the bad pixel mask

Definition at line 157 of file coadd.py.

    def getBadPixelMask(self):
        """Return the bad pixel mask
        """
        return self._badPixelMask

getBBox()

def lsst.coadd.utils.coadd.Coadd.getBBox (   self )

inherited

Return the bounding box of the coadd

Definition at line 162 of file coadd.py.

    def getBBox(self):
        """Return the bounding box of the coadd
        """
        return self._bbox

getCoadd()

def lsst.coadd.utils.coadd.Coadd.getCoadd (   self )

inherited

Get the coadd exposure for all exposures you have coadded so far

If all exposures in this coadd have the same-named filter then that filter is set in the coadd.
Otherwise the coadd will have the default unknown filter.

@warning: the Calib is not be set.

Definition at line 129 of file coadd.py.

    def getCoadd(self):
        """Get the coadd exposure for all exposures you have coadded so far

        If all exposures in this coadd have the same-named filter then that filter is set in the coadd.
        Otherwise the coadd will have the default unknown filter.

        @warning: the Calib is not be set.
        """
        # make a deep copy so I can scale it
        coaddMaskedImage = self._coadd.getMaskedImage()
        scaledMaskedImage = coaddMaskedImage.Factory(coaddMaskedImage, True)

        # set the edge pixels
        setCoaddEdgeBits(scaledMaskedImage.getMask(), self._weightMap)

        # scale non-edge pixels by weight map
        scaledMaskedImage /= self._weightMap

        scaledExposure = afwImage.makeExposure(scaledMaskedImage, self._wcs)
        if len(self._filterDict) == 1:
            scaledExposure.setFilter(list(self._filterDict.values())[0])
        return scaledExposure

getFilters()

def lsst.coadd.utils.coadd.Coadd.getFilters (   self )

inherited

Return a collection of all the filters seen so far in in addExposure

Definition at line 152 of file coadd.py.

    def getFilters(self):
        """Return a collection of all the filters seen so far in in addExposure
        """
        return list(self._filterDict.values())

getWcs()

def lsst.coadd.utils.coadd.Coadd.getWcs (   self )

inherited

Return the wcs of the coadd

Definition at line 167 of file coadd.py.

    def getWcs(self):
        """Return the wcs of the coadd
        """
        return self._wcs

getWeightMap()

def lsst.coadd.utils.coadd.Coadd.getWeightMap (   self )

inherited

Return the weight map for all exposures you have coadded so far

The weight map is a float Image of the same dimensions as the coadd; the value of each pixel
is the sum of the weights of all exposures that contributed to that pixel.

Definition at line 172 of file coadd.py.

    def getWeightMap(self):
        """Return the weight map for all exposures you have coadded so far

        The weight map is a float Image of the same dimensions as the coadd; the value of each pixel
        is the sum of the weights of all exposures that contributed to that pixel.
        """
        return self._weightMap

Member Data Documentation

ConfigClass

lsst.coadd.utils.coadd.Coadd.ConfigClass = CoaddConfig

staticinherited

Definition at line 49 of file coadd.py.

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/coadd_chisquared/16.0-3-ge00e371+41/python/lsst/coadd/chisquared/coadd.py

---

Generated on Thu Jan 24 2019 08:45:55 for LSSTApplications by   1.8.13