RectangleAnnulusSkyRegion

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

Bases: 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 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

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.
to_spherical_sky([wcs, ...])	Convert to an equivalent spherical SphericalSkyRegion instance.

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)

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.

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