phot.radprof.ee_radius

phot.radprof.ee_radius(
    im,
    center,
    fraction=0.5,
    r_min=0.5,
    r_max=None,
    sum_is_unity=False,
)

Find the radius enclosing a fraction of the total image flux.

Parameters

im : 2-D array

PSF or flux image. Total flux must be positive and contain no NaNs.

center : tuple of float

Center position in (x, y) order.

fraction : float = 0.5

The enclosed flux fraction to find the radius for. Default is 0.5.

r_min : float = 0.5

Lower bound for the search radius in pixels. Default is 0.5.

r_max : float = None

Upper bound for the search radius. If None, defaults to half the minimum image dimension. Default is None.

sum_is_unity : bool = False

If True, treat fraction as the target flux and assume im.sum() == 1. If False (default), use fraction * np.sum(im) as the target.

Returns

r : float

The radius (in pixels) encircling the given flux fraction.