SingleScaleStructure

class scarlet2.detect.SingleScaleStructure(scale, footprint)

Bases: object

A connected set of pixels with common peaks at a single wavelet scale.

Using the terminology of Starck et al. 2011, a structure is a connected set of significant wavelet coefficients at a given scale, together with any peaks contributed by overlapping structures at other scales.

scale

The wavelet scale of this structure.

Type:

int

footprint

The footprint at the primary scale.

Type:

Footprint

bbox

Bounding box of the primary footprint.

Type:

Box

peaks

{scale: [Peak, …]} — peaks contributed from each scale.

Type:

dict

Parameters:

• scale (int) – Wavelet scale of the primary footprint.

• footprint (Footprint) – The footprint at the primary scale.

add_footprint(scale, footprint)

Add peaks from a footprint at another scale.

Parameters:

• scale (int) – The wavelet scale of this structure.

• footprint (Footprint) – The footprint at the primary scale.

add_scale_tree(scale, tree)

Add all footprints from a QuadTreeRegion at another scale that overlap with this structure.

Parameters:

• scale (int) – The wavelet scale of this structure.

• tree (QuadTreeRegion) – The tree at this scale.

Returns:

self

Return type:

SingleScaleStructure

property all_peaks

Set of (x, y) tuples for every peak across all scales.