lsst.afw.detection._footprintContinued Namespace Reference

Classes
class	Footprint

Functions
Footprint	getFootprintIntersection (Footprint footprint1, Footprint footprint2, bool copyPeaks=True)

Function Documentation

getFootprintIntersection()

Footprint lsst.afw.detection._footprintContinued.getFootprintIntersection	(	Footprint	footprint1,
		Footprint	footprint2,
		bool	copyPeaks = True )

Calculate the intersection of two Footprints.

Parameters
----------
footprint1: Footprint
    The first Footprint.
footprint2: Footprint
    The second Footprint.
copyFromFirst: bool
    Whether or not to copy the peaks from the first Footprint.

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

Definition at line 35 of file _footprintContinued.py.

) -> Footprint:
    """Calculate the intersection of two Footprints.
 
    Parameters
    ----------
    footprint1: Footprint
        The first Footprint.
    footprint2: Footprint
        The second Footprint.
    copyFromFirst: bool
        Whether or not to copy the peaks from the first Footprint.
 
    Returns
    -------
    result:
        The Footprint containing the intersection of the two footprints.
    """
    # Create the intersecting footprint
    spans = footprint1.spans.intersect(footprint2.spans)
    result = Footprint(spans)
    result.setPeakSchema(footprint1.peaks.getSchema())
 
    if copyPeaks:
        # Only copy peaks that are contained in the intersection
        for peak in footprint1.peaks:
            if spans.contains(Point2I(peak.getIx(), peak.getIy())):
                # Add a copy of the entire peak record to preserve the ID
                result.peaks.append(peak)
    return result
 
 
@continueClass