HeavyFootprintD#

class lsst.afw.detection.HeavyFootprintD#

Bases: Footprint

Methods Summary

addTo(image)

Add this heavy footprint to an image.

dot(self, arg0)

extractImage([fill, bbox, imageType])

Create a 2D image of a HeavyFootprint

getImageArray(self)

getMaskArray(self)

getMaskBitsSet(self)

getVarianceArray(self)

insert(*args, **kwargs)

Overloaded function.

isHeavy(self)

subtractFrom(image)

Subtract this heavy footprint from an image.

Methods Documentation

addTo(image)#

Add this heavy footprint to an image.

Parameters#

image : lsst.afw.image

dot(self: lsst.afw.detection.HeavyFootprintD, arg0: lsst.afw.detection.HeavyFootprintD) float#
extractImage(fill=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.

bboxBox2I

Bounding box of the output image.

imageTypetype

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#

imagelsst.afw.image.MaskedImage or lsst.afw.image.Image

An image defined by bbox and padded with fill that contains the projected flux in heavy.

getImageArray(self: lsst.afw.detection.HeavyFootprintD) numpy.ndarray#
getMaskArray(self: lsst.afw.detection.HeavyFootprintD) numpy.ndarray#
getMaskBitsSet(self: lsst.afw.detection.HeavyFootprintD) int#
getVarianceArray(self: lsst.afw.detection.HeavyFootprintD) numpy.ndarray#
insert(*args, **kwargs)#

Overloaded function.

  1. insert(self: lsst.afw.detection.HeavyFootprintD, arg0: lsst::afw::image::MaskedImage<double, int, float>) -> None

  2. insert(self: lsst.afw.detection.HeavyFootprintD, arg0: lsst::afw::image::Image<double>) -> None

isHeavy(self: lsst.afw.detection.HeavyFootprintD) bool#
subtractFrom(image)#

Subtract this heavy footprint from an image.

Parameters#

image : lsst.afw.image