CircleSkyRegion

class regions.CircleSkyRegion(center, radius, meta=None, visual=None)[source]

Bases: regions.SkyRegion

A circle defined using sky coordinates.

Parameters:
center : SkyCoord

Center position

radius : Quantity

Radius in angular units

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

center Descriptor class for SkyRegion which takes a scalar SkyCoord object.
radius Descriptor class for SkyRegion which takes a scalar Quantity object.

Methods Summary

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

Attributes Documentation

center

Descriptor class for SkyRegion which takes a scalar SkyCoord object.

radius

Descriptor class for SkyRegion which takes a scalar Quantity object.

Methods Documentation

to_pixel(self, 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.