PolygonSkyRegion¶
- class regions.PolygonSkyRegion(vertices, meta=None, visual=None)[source]¶
Bases:
SkyRegion
A polygon defined using vertices in sky coordinates.
- Parameters:
- vertices
SkyCoord
The vertices of the polygon.
- meta
RegionMeta
ordict
, optional A dictionary that stores the meta attributes of the region.
- visual
RegionVisual
ordict
, optional A dictionary that stores the visual meta attributes of the region.
- vertices
Attributes Summary
The meta attributes as a
RegionMeta
The vertices of the polygon as a
astropy.coordinates.SkyCoord
array.The visual attributes as a
RegionVisual
.Methods Summary
to_pixel
(wcs)Return the equivalent region defined in pixel coordinates.
Attributes Documentation
- meta¶
The meta attributes as a
RegionMeta
- vertices¶
The vertices of the polygon as a
astropy.coordinates.SkyCoord
array.
- visual¶
The visual attributes as a
RegionVisual
.
Methods Documentation
- to_pixel(wcs)[source]¶
Return the equivalent region defined in pixel coordinates.
- Parameters:
- wcs
WCS
The world coordinate system transformation to use to convert between sky and pixel coordinates.
- wcs
- Returns:
- pixel_region
PixelRegion
A pixel region.
- pixel_region