CircleAnnulusSkyRegion

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

Bases: regions.core.core.SkyRegion

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, optional

A dictionary that stores the meta attributes of this region.

visualRegionVisual, optional

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

Attributes Summary

center

Descriptor class for SkyRegion, which takes a scalar SkyCoord object.

inner_radius

Descriptor class for SkyRegion, which takes a scalar Quantity object.

outer_radius

Descriptor class for SkyRegion, which takes a scalar Quantity object.

Methods Summary

to_pixel(wcs)

Return the equivalent region defined in pixel coordinates.

Attributes Documentation

center

Descriptor class for SkyRegion, which takes a scalar SkyCoord object.

inner_radius

Descriptor class for SkyRegion, which takes a scalar Quantity object.

outer_radius

Descriptor class for SkyRegion, which takes a scalar Quantity object.

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
pixel_regionPixelRegion

A pixel region.