LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | List of all members
lsst.coadd.chisquared.coadd.Coadd Class Reference
Inheritance diagram for lsst.coadd.chisquared.coadd.Coadd:

Public Member Functions

def __init__
 
def addExposure
 

Detailed Description

Definition at line 28 of file coadd.py.

Constructor & Destructor Documentation

def lsst.coadd.chisquared.coadd.Coadd.__init__ (   self,
  bbox,
  wcs,
  badMaskPlanes,
  logName = "coadd.chisquared.Coadd" 
)
Create a chi-squared coadd

Inputs:
@param[in] bbox: bounding box of coadd Exposure with respect to parent (afwGeom.Box2I):
    coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()
@param[in] wcs: WCS of coadd exposure (lsst.afw.math.Wcs)
@param[in] badMaskPlanes: mask planes to pay attention to when rejecting masked pixels.
    Specify as a collection of names.
    badMaskPlanes should always include "EDGE".
@param[in] logName: name by which messages are logged

Definition at line 29 of file coadd.py.

29 
30  def __init__(self, bbox, wcs, badMaskPlanes, logName="coadd.chisquared.Coadd"):
31  """Create a chi-squared coadd
32 
33  Inputs:
34  @param[in] bbox: bounding box of coadd Exposure with respect to parent (afwGeom.Box2I):
35  coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()
36  @param[in] wcs: WCS of coadd exposure (lsst.afw.math.Wcs)
37  @param[in] badMaskPlanes: mask planes to pay attention to when rejecting masked pixels.
38  Specify as a collection of names.
39  badMaskPlanes should always include "EDGE".
40  @param[in] logName: name by which messages are logged
41  """
42  coaddUtils.Coadd.__init__(self,
43  bbox = bbox,
44  wcs = wcs,
45  badMaskPlanes = badMaskPlanes,
46  logName = logName,
47  )

Member Function Documentation

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

Inputs:
@param[in] 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
@param[in] weightFactor: weight with which to add exposure to coadd

@return
- overlapBBox: region of overlap between exposure and coadd in parent coordinates (afwGeom.Box2I)
- weight: weight with which exposure was added to coadd; weight = weightFactor for this kind of coadd

Definition at line 48 of file coadd.py.

48 
49  def addExposure(self, exposure, weightFactor=1.0):
50  """Add a an exposure to the coadd; it is assumed to have the same WCS as the coadd
51 
52  Inputs:
53  @param[in] exposure: Exposure to add to coadd; this must be:
54  - background-subtracted or background-matched to the other images being coadded
55  - psf-matched to the desired PSF model (optional)
56  - warped to match the coadd
57  @param[in] weightFactor: weight with which to add exposure to coadd
58 
59  @return
60  - overlapBBox: region of overlap between exposure and coadd in parent coordinates (afwGeom.Box2I)
61  - weight: weight with which exposure was added to coadd; weight = weightFactor for this kind of coadd
62  """
63  self._log.log(pexLog.Log.INFO, "add exposure to coadd")
64 
65  # save filter info
66  filter = exposure.getFilter()
67  self._filterDict.setdefault(filter.getName(), filter)
68 
69  overlapBBox = chisquaredLib.addToCoadd(self._coadd.getMaskedImage(), self._weightMap,
70  exposure.getMaskedImage(), self._badPixelMask, weightFactor)
71 
72  return overlapBBox, weightFactor

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