lsst.afw.detection._footprintContinued.Footprint Class Reference

Public Member Functions
float	computeFluxFromArray (self, np.ndarray image, Point2I xy0)
float	computeFluxFromImage (self, "Image" image)
Footprint	intersect (self, Footprint other, bool copyPeaks=True)

Detailed Description

Definition at line 71 of file _footprintContinued.py.

Member Function Documentation

computeFluxFromArray()

float lsst.afw.detection._footprintContinued.Footprint.computeFluxFromArray	(		self,
		np.ndarray	image,
		Point2I	xy0 )

Calculate the total flux in the region of an image array
contained in this Footprint.

Parameters
----------
image:
    Array containing the pixels to extract.
xy0:
    The origin of the image array.

Returns
flux:
    Flux from the image in pixels contained in the footprint.

Definition at line 72 of file _footprintContinued.py.

computeFluxFromImage()

float lsst.afw.detection._footprintContinued.Footprint.computeFluxFromImage	(		self,
		"Image"	image )

Calculate the total flux in the region of an Image contained in
this Footprint.

Parameters
----------
image:
    Image to extract.

Returns
-------
flux:
    Flux from the image pixels contained in the footprint.

Definition at line 89 of file _footprintContinued.py.

intersect()

Footprint lsst.afw.detection._footprintContinued.Footprint.intersect	(		self,
		Footprint	other,
		bool	copyPeaks = True )

Calculate the intersection of this Footprint with another Footprint.

Parameters
----------
other:
    The other Footprint.
copyPeaks:
    Whether or not to copy the peaks from this Footprint.
    Note: the peaks in other are always ignored.

Returns
-------
result:
    The Footprint containing the intersection of the two footprints.

Definition at line 105 of file _footprintContinued.py.

---

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

• python/lsst/afw/detection/_footprintContinued.py