SkyRegion

class regions.SkyRegion[source]

Bases: regions.Region

Base class for all regions defined in celestial coordinates

Methods Summary

contains(self, skycoord, wcs) Check whether a sky coordinate falls inside the region
intersection(self, other) Returns a region representing the intersection of this region with other.
symmetric_difference(self, other) Returns the union of the two regions minus any areas contained in the intersection of the two regions.
to_pixel(self, wcs) Returns the equivalent region defined in pixel coordinates.
union(self, other) Returns a region representing the union of this region with other.

Methods Documentation

contains(self, skycoord, wcs)[source]

Check whether a sky coordinate falls inside the region

Parameters:
skycoord : SkyCoord

The position or positions to check

wcs : WCS instance

The world coordinate system transformation to assume

intersection(self, other)[source]

Returns a region representing the intersection of this region with other.

symmetric_difference(self, other)[source]

Returns the union of the two regions minus any areas contained in the intersection of the two regions.

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.
union(self, other)[source]

Returns a region representing the union of this region with other.