footprints

scarlet2.plot.footprints(detect, fps)

Plot wavelet-scale detection images with overlaid footprints and peaks.

Creates one panel per wavelet scale (including the coarse residual plane), showing the masked starlet coefficient image at each scale. For scales that appear in fps, the detected footprint masks are overlaid as a semi-transparent grey layer and each peak is marked with a white x. The final panel corresponds to the smooth background residual and is labelled scale=N+.

Parameters:

• detect (ndarray, shape (max_scale+1, height, width) or (max_scale+2, height, width)) – Masked starlet coefficients, e.g. the first element of the tuple returned by detect.multiscale_footprints(..., return_intermediates=True).

• fps (dict mapping int → list of Footprint) – Footprints at each detected scale, as returned by multiscale_footprints(). Only the scales that appear as keys in this dict receive footprint and peak overlays.

Returns:

fig – Figure with len(detect) panels, one per wavelet scale.

Return type:

matplotlib.figure.Figure