PolygonSkyRegion

class regions.PolygonSkyRegion(vertices, meta=None, visual=None)[source]

Bases: regions.SkyRegion

A polygon defined using vertices in sky coordinates.

Parameters:
vertices : SkyCoord

The vertices of the polygon

meta : RegionMeta object, optional

A dictionary which stores the meta attributes of this region.

visual : RegionVisual object, optional

A dictionary which stores the visual meta attributes of this region.

Attributes Summary

vertices Descriptor class for SkyRegion which takes a one dimensional SkyCoord object.

Methods Summary

to_pixel(wcs) Returns the equivalent region defined in pixel coordinates.

Attributes Documentation

vertices

Descriptor class for SkyRegion which takes a one dimensional SkyCoord object.

Methods Documentation

to_pixel(wcs)[source]

Returns the equivalent region defined in pixel coordinates.

Parameters:
wcs : WCS instance

The world coordinate system transformation to assume

Returns:
pixel_region : PixelRegion object.