catalog_mask

grizli.utils.catalog_mask(cat, ecol='FLUXERR_APER_0', max_err_percentile=90, pad=0.05, pad_is_absolute=False, min_flux_radius=1.0, min_nexp=2)[source]
Compute a catalog mask for

  1. Objects within pad of the edge of the catalog convex hull

  2. Uncertainties < max_err_percentile

Parameters
catTable

Input catalog.

ecolstr, optional

Name of the column containing the flux uncertainties. Default is “FLUXERR_APER_0”.

max_err_percentilefloat, optional

Maximum percentile of flux uncertainties to include in the mask. Default is 90.

padfloat, optional

Distance in pixels from the edge of the catalog convex hull to consider as the edge. Default is 0.05.

pad_is_absolutebool, optional

If True, pad is interpreted as an absolute distance in pixels. If False, pad is interpreted as a fraction of the catalog size. Default is False.

min_flux_radiusfloat, optional

Minimum value of the flux radius to include in the mask. Default is 1.0.

min_nexpint, optional

Minimum number of exposures to include in the mask. Default is 2.

Returns
maskndarray

Boolean mask indicating which objects in the catalog pass the criteria.