LineSkyRegion

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

Bases: regions.SkyRegion

A line in sky coordinates.

Parameters
startSkyCoord

Start position

endSkyCoord

End position

metaRegionMeta object, optional

A dictionary which stores the meta attributes of this region.

visualRegionVisual 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(skycoord, wcs)

Check whether a sky coordinate falls inside the region

to_pixel(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(skycoord, wcs)[source]

Check whether a sky coordinate falls inside the region

Parameters
skycoordSkyCoord

The position or positions to check

wcsWCS instance

The world coordinate system transformation to assume

to_pixel(wcs)[source]

Returns the equivalent region defined in pixel coordinates.

Parameters
wcsWCS instance

The world coordinate system transformation to assume

Returns
pixel_regionPixelRegion object.