LineSkyRegion

class regions.LineSkyRegion(start, end, meta=None, visual=None)

Bases: SkyRegion

A line in sky coordinates.

Parameters:

startSkyCoord

The start position.

endSkyCoord

The end position.

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

end	The end position as a astropy.coordinates.SkyCoord.
meta	The meta attributes as a RegionMeta
start	The start position as a astropy.coordinates.SkyCoord.
visual	The visual attributes as a RegionVisual.

Methods Summary

contains(skycoord, wcs)	Check whether a sky coordinate falls inside the region.
to_pixel(wcs)	Return the equivalent region defined in pixel coordinates.
to_spherical_sky([wcs, ...])	Convert to an equivalent spherical SphericalSkyRegion instance.

Attributes Documentation

end

The end position as a astropy.coordinates.SkyCoord.

meta

The meta attributes as a RegionMeta

start

The start position as a astropy.coordinates.SkyCoord.

visual

The visual attributes as a RegionVisual.

Methods Documentation

contains(skycoord, wcs)

Check whether a sky coordinate falls inside the region.

Parameters:

skycoordSkyCoord

The position or positions to check.

wcsWCS

The world coordinate system transformation to use to convert between sky and pixel coordinates.

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