LineSkyRegion

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

Bases: regions.SkyRegion

A line in sky coordinates.

Parameters:

start : SkyCoord

Start position

end : SkyCoord

End position

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

end	Descriptor class for SkyRegion which takes a scalar SkyCoord object.
start	Descriptor class for SkyRegion which takes a scalar SkyCoord object.

Methods Summary

contains(self, skycoord, wcs)	Check whether a sky coordinate falls inside the region
to_pixel(self, wcs)	Returns the equivalent region defined in pixel coordinates.

Attributes Documentation

end

Descriptor class for SkyRegion which takes a scalar SkyCoord object.

start

Descriptor class for SkyRegion which takes a scalar SkyCoord object.

Methods Documentation

contains(self, skycoord, wcs)

Check whether a sky coordinate falls inside the region

Parameters:

skycoord : SkyCoord

The position or positions to check

wcs : WCS instance

The world coordinate system transformation to assume

to_pixel(self, wcs)

Returns the equivalent region defined in pixel coordinates.

Parameters:

wcs : WCS instance

The world coordinate system transformation to assume

Returns:

pixel_region : PixelRegion object.