RectangleAnnulusSkyRegion

class regions.RectangleAnnulusSkyRegion(center, inner_width, outer_width, inner_height, outer_height, angle=<Quantity 0. deg>, meta=None, visual=None)[source]

Bases: regions.shapes.annulus.AsymmetricAnnulusSkyRegion

A rectangular annulus in SkyCoord coordinates.

Parameters
centerSkyCoord

The position of the center of the rectangular annulus.

inner_widthQuantity

The inner width of the rectangular annulus (before rotation) as an angle.

outer_widthQuantity

The outer width of the rectangular annulus (before rotation) as an angle.

inner_heightQuantity

The inner height of the rectangular annulus (before rotation) as an angle.

outer_heightQuantity

The outer height of the rectangular annulus (before rotation) as an angle.

angleQuantity, optional

The rotation angle of the rectangular annulus, measured anti-clockwise. If set to zero (the default), the width axis is lined up with the longitude axis of the celestial coordinates

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

angle

The rotation angle measured anti-clockwise as a astropy.units.Quantity angle.

center

The center position as a astropy.coordinates.SkyCoord.

inner_height

The inner height (before rotation) as a astropy.units.Quantity angle.

inner_width

The inner width (before rotation) as a astropy.units.Quantity angle.

outer_height

The outer height (before rotation) as a astropy.units.Quantity angle.

outer_width

The outer width (before rotation) as a astropy.units.Quantity angle.

Methods Summary

to_pixel(wcs)

Return the equivalent region defined in pixel coordinates.

Attributes Documentation

angle

The rotation angle measured anti-clockwise as a astropy.units.Quantity angle.

center

The center position as a astropy.coordinates.SkyCoord.

inner_height

The inner height (before rotation) as a astropy.units.Quantity angle.

inner_width

The inner width (before rotation) as a astropy.units.Quantity angle.

outer_height

The outer height (before rotation) as a astropy.units.Quantity angle.

outer_width

The outer width (before rotation) as a astropy.units.Quantity angle.

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.