EllipseSkyRegion¶

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

An ellipse defined using sky coordinates.

Parameters:

centerSkyCoord: The position of the center of the ellipse.
widthQuantity: The width of the ellipse (before rotation) as an angle.
heightQuantity: The height of the ellipse (before rotation) as an angle.
angleQuantity, optional: The rotation angle of the ellipse, 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`.
`height`	The height of the ellipse (before rotation) as a `astropy.units.Quantity` angle.
`meta`	The meta attributes as a `RegionMeta`
`visual`	The visual attributes as a `RegionVisual`.
`width`	The width of the ellipse (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.

height¶: The height of the ellipse (before rotation) as a astropy.units.Quantity angle.

width¶: The width of the ellipse (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:

to_spherical_sky(wcs=None, include_boundary_distortions=False, discretize_kwargs=None)[source]¶

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