regions2aperture

jdaviz.core.region_translators.regions2aperture(region_shape)[source] [edit on github]

Convert a given regions shape to photutils aperture.

Parameters

region_shaperegions.Region: A supported regions shape.

Returns

aperturephotutils.aperture.Aperture: An equivalent photutils aperture.

Raises

NotImplementedError: The given regions shape is not supported.

See also

aperture2regions

Examples

Translate a regions.CirclePixelRegion to photutils.aperture.CircularAperture:

>>> from regions import CirclePixelRegion, PixCoord
>>> from jdaviz.core.region_translators import regions2aperture
>>> region_shape = CirclePixelRegion(center=PixCoord(x=42, y=43), radius=4.2)
>>> regions2aperture(region_shape)
<CircularAperture([42., 43.], r=4.2)>