get_mask¶

pyregion.get_mask(region, hdu, origin=1)[source]¶

Get mask.

Parameters:

region : ShapeList

List of Shape

hdu : ImageHDU

FITS image HDU

origin : float

TODO: document me

Returns:

mask : array

Boolean mask

Examples

>>> from astropy.io import fits
>>> from pyregion import read_region_as_imagecoord, get_mask
>>> hdu = fits.open("test.fits")[0]
>>> region = "test01.reg"
>>> reg = read_region_as_imagecoord(open(region), f[0].header)
>>> mask = get_mask(reg, hdu)