CircAn

CircAn(positions, r_in, r_out, *, validate=True)

Circular annulus in pixel coordinates.

Parameters

positions : tuple or array - like

Annulus center or centers as (x, y) pixel coordinates. Multiple centers are accepted as an (N, 2) array-like object. Coordinates are copied into owned, read-only float64 storage. Editing the input does not move the aperture; construct a new aperture to change centers. The positions attribute cannot be reassigned. C-order, Fortran-order, and strided inputs are accepted. Input (x, y) gives scalar sums; [(x, y)] gives length-one vector sums.

r_in : float

Inner and outer radii in pixels. r_in may be zero and must be smaller than r_out.

r_out : float

Inner and outer radii in pixels. r_in may be zero and must be smaller than r_out.

validate : bool = True

If False, skip input validation and assume finite geometry, ordered radii, and finite positions with shape (2,) or (N, 2). Coordinates are still copied and converted to float64.

Methods

Name Description
bboxes Override the default python for-loop with a Rust-accelerated batch function.

bboxes

CircAn.bboxes()

Override the default python for-loop with a Rust-accelerated batch function.