CircleAnnulusSkyRegion¶

class regions.CircleAnnulusSkyRegion(center, inner_radius, outer_radius, meta=None, visual=None)[source]¶

A circular annulus in sky coordinates.

Parameters:

centerSkyCoord: The position of the center of the annulus.
inner_radiusQuantity: The inner radius of the annulus in angular units.
outer_radiusQuantity: The outer radius of the annulus in angular units.
metaRegionMeta or dict, optional: A dictionary that stores the meta attributes of the region.
visualRegionVisual or dict, optional: A dictionary that stores the visual meta attributes of the region.

Attributes Summary

`center`	The center position as a `astropy.coordinates.SkyCoord`.
`inner_radius`	The inner radius as a `astropy.units.Quantity` angle.
`meta`	The meta attributes as a `RegionMeta`
`outer_radius`	The outer radius as a `astropy.units.Quantity` angle.
`visual`	The visual attributes as a `RegionVisual`.

Methods Summary

`to_pixel`(wcs)	Return the equivalent region defined in pixel coordinates.
`to_spherical_sky`([wcs, ...])	Convert to an equivalent spherical `SphericalSkyRegion` instance.

Attributes Documentation

Methods Documentation

to_pixel(wcs)[source]¶

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:

to_spherical_sky(wcs=None, include_boundary_distortions=False, discretize_kwargs=None)[source]¶

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).