Function reference

Python aperture objects

Classes for readable aperture construction, plotting, weights, and aperture sums.

CircAp	Circular aperture in pixel coordinates.
CircAn	Circular annulus in pixel coordinates.
EllipAp	Elliptical aperture in pixel coordinates.
EllipAn	Elliptical annulus in pixel coordinates.
RectAp	Rotated rectangular aperture in pixel coordinates.
RectAn	Rotated rectangular annulus in pixel coordinates.
PillAp	Capsule-like aperture composed from one rectangle and two ellipses.
PillAn	Capsule-like annulus with explicit inner and outer pills.
WedgeAp	Annular wedge aperture in pixel coordinates.
PathAp	Aperture defined by a closed path of line segments and circular arcs.

Bounding boxes

Raw bbox-weight operations.

BoundingBox

Pixel-index bounding box with exclusive upper bounds.

Python convenience functions

Reference functions used by the object layer.

apsum_circ_exact	Return exact circular aperture sums for one or many aperture centers.
apsum_circ_center	Return center-selected circular aperture sums for one or many aperture centers.
apsum_circ_ann_exact	Return exact circular-annulus aperture sums for one or many aperture centers.
apsum_circ_ann_center	Return center-selected circular-annulus aperture sums for one or many aperture centers.
apsum_ellip_exact	Return exact elliptical aperture sums for one or many aperture centers.
apsum_ellip_center	Return center-selected elliptical aperture sums for one or many aperture centers.
apsum_ellip_ann_exact	Return exact elliptical-annulus aperture sums for one or many aperture centers.
apsum_ellip_ann_center	Return center-selected elliptical-annulus aperture sums for one or many aperture centers.
apsum_rect_exact	Return exact rotated-rectangle aperture sums for one or many aperture centers.
apsum_rect_center	Return center-selected rotated-rectangle aperture sums for one or many aperture centers.
apsum_rect_ann_exact	Return exact rotated-rectangle-annulus aperture sums for one or many aperture centers.
apsum_rect_ann_center	Return center-selected rotated-rectangle-annulus aperture sums for one or many aperture centers.
apsum_pill_exact	Return exact pill aperture sums for one or many aperture centers.
apsum_pill_center	Return center-selected pill aperture sums for one or many aperture centers.
apsum_pill_ann_exact	Return exact pill-annulus aperture sums for one or many aperture centers.
apsum_pill_ann_center	Return center-selected pill-annulus aperture sums for one or many aperture centers.
apsum_wedge_exact	Return exact wedge aperture sums for one or many aperture centers.
apsum_wedge_center	Return center-selected wedge aperture sums for one or many aperture centers.
apsum_path_exact	Return exact path aperture sums for one or many centers.
apsum_path_center	Return center-selected path aperture sums for one or many centers.
npix_circ_exact	Return exact circular-aperture effective in-frame pixel counts.
npix_circ_center	Return center-selected circular-aperture effective in-frame pixel counts.
npix_circ_ann_exact	Return exact circular-annulus effective in-frame pixel counts.
npix_circ_ann_center	Return center-selected circular-annulus effective in-frame pixel counts.
npix_ellip_exact	Return exact elliptical-aperture effective in-frame pixel counts.
npix_ellip_center	Return center-selected elliptical-aperture effective in-frame pixel counts.
npix_ellip_ann_exact	Return exact elliptical-annulus effective in-frame pixel counts.
npix_ellip_ann_center	Return center-selected elliptical-annulus effective in-frame pixel counts.
npix_rect_exact	Return exact rotated-rectangle-aperture effective in-frame pixel counts.
npix_rect_center	Return center-selected rotated-rectangle-aperture effective in-frame pixel counts.
npix_rect_ann_exact	Return exact rotated-rectangle-annulus effective in-frame pixel counts.
npix_rect_ann_center	Return center-selected rotated-rectangle-annulus effective in-frame pixel counts.
npix_pill_exact	Return exact pill-aperture effective in-frame pixel counts.
npix_pill_center	Return center-selected pill-aperture effective in-frame pixel counts.
npix_pill_ann_exact	Return exact pill-annulus effective in-frame pixel counts.
npix_pill_ann_center	Return center-selected pill-annulus effective in-frame pixel counts.
npix_wedge_exact	Return exact wedge-aperture effective in-frame pixel counts.
npix_wedge_center	Return center-selected wedge-aperture effective in-frame pixel counts.
bboxes_path	Return path aperture bounding boxes for one or many centers.

Parallel threshold utilities

Helpers for configuring when the Rust kernels switch to Rayon.

ParallelThresholdCalibration	Result from calibrating the Rayon parallelization threshold.
calibrate_parallel_threshold	Benchmark and optionally apply a machine-local parallel threshold.
get_parallel_threshold	Return the aperture count where Rust kernels switch to Rayon.
set_parallel_threshold	Set the aperture count where Rust kernels switch to Rayon.