SkyRegion

class regions.SkyRegion

Bases: Region

Base class for all regions defined in celestial coordinates.

Methods Summary

contains(skycoord, wcs)	Check whether a sky coordinate falls inside the region.
intersection(other)	Return a region representing the intersection of this region with other.
symmetric_difference(other)	Return the union of the two regions minus any areas contained in the intersection of the two regions.
to_pixel(wcs)	Return the equivalent region defined in pixel coordinates.
to_spherical_sky([wcs, ...])	Convert to an equivalent spherical SphericalSkyRegion instance.
union(other)	Return a region representing the union of this region with other.

Methods Documentation

contains(skycoord, wcs)

Check whether a sky coordinate falls inside the region.

Parameters:

skycoordSkyCoord

The position or positions to check.

wcsWCS

The world coordinate system transformation to use to convert between sky and pixel coordinates.

intersection(other)

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

Parameters:

otherRegion

The other region to use for the intersection.

symmetric_difference(other)

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

Parameters:

otherRegion

The other region to use for the symmetric difference.

abstractmethod to_pixel(wcs)

Return the equivalent region defined in pixel coordinates.

Parameters:

wcsWCS

The world coordinate system transformation to use to convert between sky and pixel coordinates.

Returns:

pixel_regionPixelRegion

A pixel region.

abstractmethod to_spherical_sky(wcs=None, include_boundary_distortions=False, discretize_kwargs=None)

Convert to an equivalent spherical SphericalSkyRegion instance.

Parameters:

wcsWCS instance, optional

The world coordinate system transformation to use to convert between sky and pixel coordinates. Required if transforming with boundary distortions (if include_boundary_distortions is True). Ignored if boundary distortions not included.

include_boundary_distortionsbool, optional

If True, accounts for boundary boundary distortions in spherical to planar conversions, by discretizing the boundary and converting the boundary polygon. Default is False, which converts to an equivalent idealized shape.

discretize_kwargsdict, optional

Optional keyword arguments to pass to discretize_boundary() method if including boundary distortions.

Returns:

spherical_sky_regionSphericalSkyRegion

A spherical sky region, with an equivalent shape (if include_boundary_distortions is False), or a discretized polygon of the boundary (if include_boundary_distortions is True).

union(other)

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

Parameters:

otherRegion

The other region to use for the union.