RectangleAnnulusPixelRegion

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

Bases: regions.shapes.annulus.AsymmetricAnnulusPixelRegion

A rectangular annulus in pixel coordinates.

Parameters
centerPixCoord

The position of the center of the rectangular annulus.

inner_widthfloat

The inner width of the rectangular annulus (before rotation) in pixels.

outer_widthfloat

The outer width of the rectangular annulus (before rotation) in pixels.

inner_heightfloat

The inner height of the rectangular annulus (before rotation) in pixels.

outer_heightfloat

The outer height of the rectangular annulus (before rotation) in pixels.

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 x axis.

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.

Examples

from astropy.coordinates import Angle
from regions import PixCoord, RectangleAnnulusPixelRegion
import matplotlib.pyplot as plt

fig, ax = plt.subplots(1, 1)

reg = RectangleAnnulusPixelRegion(PixCoord(x=6, y=6),
                                  inner_width=5.5,
                                  outer_width=8.5,
                                  inner_height=3.5,
                                  outer_height=6.5,
                                  angle=Angle('45deg'))
patch = reg.plot(ax=ax, facecolor='none', edgecolor='red', lw=2,
                 label='Rectangle Annulus')

ax.legend(handles=(patch,), loc='upper center')
ax.set_xlim(-5, 20)
ax.set_ylim(-5, 20)
ax.set_aspect('equal')

(Source code, png, hires.png, pdf, svg)

../_images/regions-RectangleAnnulusPixelRegion-1.png

Attributes Summary

angle

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

center

The center pixel position as a PixCoord.

inner_height

The inner height (before rotation) in pixels as a float.

inner_width

The inner width (before rotation) in pixels as a float.

outer_height

The outer height (before rotation) in pixels as a float.

outer_width

The outer width (before rotation) in pixels as a float.

Methods Summary

to_sky(wcs)

Return a region defined in sky coordinates.

Attributes Documentation

angle

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

center

The center pixel position as a PixCoord.

inner_height

The inner height (before rotation) in pixels as a float.

inner_width

The inner width (before rotation) in pixels as a float.

outer_height

The outer height (before rotation) in pixels as a float.

outer_width

The outer width (before rotation) in pixels as a float.

Methods Documentation

to_sky(wcs)[source]

Return a region defined in sky coordinates.

Parameters
wcsWCS

The world coordinate system transformation to use to convert from pixels to sky coordinates.

Returns
sky_regionSkyRegion

The sky region.