lsst.afw.detection._footprintContinued.Footprint Class Reference

Public Member Functions
float	computeFluxFromArray (self, np.ndarray image, Point2I xy0)
float	computeFluxFromImage (self, "Image" image)

Detailed Description

Definition at line 36 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 37 of file _footprintContinued.py.

    def computeFluxFromArray(self, image: np.ndarray, xy0: Point2I) -> float:
        """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.
        """
        return self.spans.flatten(image, xy0).sum()
 

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 54 of file _footprintContinued.py.

    def computeFluxFromImage(self, image: "Image") -> float:
        """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.
        """
        return self.computeFluxFromArray(image.array, image.getXY0())

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/gb3a676b8dc+b4feba26a1/python/lsst/afw/detection/_footprintContinued.py