lsst.afw g2feeb41cd2+0b570383f2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst.afw.detection._heavyFootprintContinued.HeavyFootprint Class Reference
Inheritance diagram for lsst.afw.detection._heavyFootprintContinued.HeavyFootprint:

Public Member Functions

def addTo (self, image)
 
def subtractFrom (self, image)
 
def extractImage (self, fill=np.nan, bbox=None, imageType=None)
 

Detailed Description

Definition at line 28 of file _heavyFootprintContinued.py.

Member Function Documentation

◆ addTo()

def lsst.afw.detection._heavyFootprintContinued.HeavyFootprint.addTo (   self,
  image 
)
Add this heavy footprint to an image.

Parameters
----------
image : `lsst.afw.image`

Definition at line 29 of file _heavyFootprintContinued.py.

◆ extractImage()

def lsst.afw.detection._heavyFootprintContinued.HeavyFootprint.extractImage (   self,
  fill = np.nan,
  bbox = None,
  imageType = None 
)
Create a 2D image of a HeavyFootprint

Parameters
----------
fill: number
    Number to fill the pixels in the image that are not
    contained in `heavy`.
bbox : `Box2I`
    Bounding box of the output image.
imageType : `type`
    This should be either a `MaskedImage` or `Image` and describes
    the type of the output image.
    If `imageType` is `None` then `Image` will be used.

Returns
-------
image : `lsst.afw.image.MaskedImage` or `lsst.afw.image.Image`
    An image defined by `bbox` and padded with `fill` that
    contains the projected flux in `heavy`.

Definition at line 51 of file _heavyFootprintContinued.py.

◆ subtractFrom()

def lsst.afw.detection._heavyFootprintContinued.HeavyFootprint.subtractFrom (   self,
  image 
)
Subtract this heavy footprint from an image.

Parameters
----------
image : `lsst.afw.image`

Definition at line 40 of file _heavyFootprintContinued.py.


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