RectangleSkyRegion

class regions.RectangleSkyRegion(center, width, height, angle=<Quantity 0. deg>, meta=None, visual=None)[source]

Bases: regions.SkyRegion

A rectangle in sky coordinates.

Parameters:
center : SkyCoord

The position of the center of the rectangle.

width : Quantity

The width of the rectangle (before rotation) as an angle

height : Quantity

The height of the rectangle (before rotation) as an angle

angle : Quantity, optional

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

meta : RegionMeta object, optional

A dictionary which stores the meta attributes of this region.

visual : RegionVisual object, optional

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

Attributes Summary

angle Descriptor class for SkyRegion which takes a scalar Quantity object.
center Descriptor class for SkyRegion which takes a scalar SkyCoord object.
height Descriptor class for SkyRegion which takes a scalar Quantity object.
width Descriptor class for SkyRegion which takes a scalar Quantity object.

Methods Summary

to_pixel(self, wcs) Returns the equivalent region defined in pixel coordinates.

Attributes Documentation

angle

Descriptor class for SkyRegion which takes a scalar Quantity object.

center

Descriptor class for SkyRegion which takes a scalar SkyCoord object.

height

Descriptor class for SkyRegion which takes a scalar Quantity object.

width

Descriptor class for SkyRegion which takes a scalar Quantity object.

Methods Documentation

to_pixel(self, wcs)[source]

Returns the equivalent region defined in pixel coordinates.

Parameters:
wcs : WCS instance

The world coordinate system transformation to assume

Returns:
pixel_region : PixelRegion object.