footprints

Contents

footprints#

scarlet2.detect.footprints(image, min_separation=0, min_area=9, thresh=0)[source]#

Detect footprints and their peaks in an image.

Thresholds the image at thresh, labels 4-connected regions using scipy.ndimage.label(), filters by minimum area, and locates peaks within each footprint.

Parameters:

  • image (2D array-like) – The image to detect sources in. Accepts NumPy or JAX arrays.

  • min_separation (float, optional) – Minimum pixel separation between peaks within a footprint.

  • min_area (int, optional) – Minimum number of pixels a footprint must contain to be kept.

  • thresh (float, optional) – Detection threshold; pixels must strictly exceed this value.

Returns:

footprints – Detected footprints, each containing the boolean mask (sized to the bounding box), peak list, and bounding box in the full image.

Return type:

list of Footprint

Contents