lsst.coadd.chisquared  14.0-1-g6829aa7+17
coadd.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008, 2009, 2010 LSST Corporation.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 from __future__ import absolute_import, division, print_function
23 
24 import lsst.coadd.utils as coaddUtils
25 from . addToCoadd import addToCoadd
26 
27 __all__ = ["Coadd"]
28 
29 
30 class Coadd(coaddUtils.Coadd):
31 
32  def __init__(self, bbox, wcs, badMaskPlanes, logName="coadd.chisquared.Coadd"):
33  """Create a chi-squared coadd
34 
35  Inputs:
36  @param[in] bbox: bounding box of coadd Exposure with respect to parent (afwGeom.Box2I):
37  coadd dimensions = bbox.getDimensions(); xy0 = bbox.getMin()
38  @param[in] wcs: WCS of coadd exposure (lsst.afw.geom.SkyWcs)
39  @param[in] badMaskPlanes: mask planes to pay attention to when rejecting masked pixels.
40  Specify as a collection of names.
41  badMaskPlanes should always include "EDGE".
42  @param[in] logName: name by which messages are logged
43  """
44  coaddUtils.Coadd.__init__(self,
45  bbox=bbox,
46  wcs=wcs,
47  badMaskPlanes=badMaskPlanes,
48  logName=logName,
49  )
50 
51  def addExposure(self, exposure, weightFactor=1.0):
52  """Add a an exposure to the coadd; it is assumed to have the same WCS as the coadd
53 
54  Inputs:
55  @param[in] exposure: Exposure to add to coadd; this must be:
56  - background-subtracted or background-matched to the other images being coadded
57  - psf-matched to the desired PSF model (optional)
58  - warped to match the coadd
59  @param[in] weightFactor: weight with which to add exposure to coadd
60 
61  @return
62  - overlapBBox: region of overlap between exposure and coadd in parent coordinates (afwGeom.Box2I)
63  - weight: weight with which exposure was added to coadd; weight = weightFactor for this kind of coadd
64  """
65  self._log.info("add exposure to coadd")
66 
67  # save filter info
68  filter = exposure.getFilter()
69  self._filterDict.setdefault(filter.getName(), filter)
70 
71  overlapBBox = addToCoadd(self._coadd.getMaskedImage(), self._weightMap,
72  exposure.getMaskedImage(), self._badPixelMask, weightFactor)
73 
74  return overlapBBox, weightFactor
def __init__(self, bbox, wcs, badMaskPlanes, logName="coadd.chisquared.Coadd")
Definition: coadd.py:32
def addExposure(self, exposure, weightFactor=1.0)
Definition: coadd.py:51