lsst.afw.detection._heavyFootprintContinued.HeavyFootprint Class Reference

Inheritance diagram for lsst.afw.detection._heavyFootprintContinued.HeavyFootprint:

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

Detailed Description

Definition at line 28 of file _heavyFootprintContinued.py.

Member Function Documentation

addTo()

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.

    def addTo(self, image):
        """Add this heavy footprint to an image.
 
        Parameters
        ----------
        image : `lsst.afw.image`
        """
        indices = self.spans.indices()
        image.array[indices[0, :] - image.getY0(),
                    indices[1, :] - image.getX0()] += self.getImageArray()
 

extractImage()

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.

    def 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`.
        """
        # Prevent circular import
        from lsst.afw.image import Image
        if imageType is None:
            imageType = Image
        if bbox is None:
            bbox = self.getBBox()
        image = imageType(bbox, dtype=self.getImageArray().dtype)
        image.set(fill)
        self.insert(image)
        return image
 
 

subtractFrom()

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.

    def subtractFrom(self, image):
        """Subtract this heavy footprint from an image.
 
        Parameters
        ----------
        image : `lsst.afw.image`
        """
        indices = self.spans.indices()
        image.array[indices[0, :] - image.getY0(),
                    indices[1, :] - image.getX0()] -= self.getImageArray()
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+be83d3ecdb/python/lsst/afw/detection/_heavyFootprintContinued.py