regions2roi#
- jdaviz.core.region_translators.regions2roi(region_shape, wcs=None)[source]#
Convert a given
regions
shape toglue
ROI.This is the opposite of what is offered by
glue_astronomy.translators.regions.AstropyRegionsHandler.to_object
but does not cover all the same shapes exactly.- Parameters:
- region_shape
regions.Region
A supported
regions
shape.- wcs
WCS
orNone
A compatible WCS object, if required. This is only used for sky aperture.
- region_shape
- Returns:
- roi
glue.core.roi.Roi
An equivalent
glue
ROI.
- roi
- Raises:
- ValueError
WCS is required but not provided.
- NotImplementedError
The given
regions
shape is not supported.
Examples
Translate a
regions.CirclePixelRegion
toglue.core.roi.CircularROI
:>>> from regions import CirclePixelRegion, PixCoord >>> from jdaviz.core.region_translators import regions2roi >>> region_shape = CirclePixelRegion(center=PixCoord(x=42, y=43), radius=4.2) >>> regions2roi(region_shape) <glue.core.roi.CircularROI object at ...>