lsst.coadd.chisquared  16.0-2-g839ba83+57
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__ (self, bbox, wcs, badMaskPlanes, logName="coadd.chisquared.Coadd")
 
def addExposure (self, exposure, weightFactor=1.0)
 

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.

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.


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