LineSkyRegion

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

Bases: regions.core.core.SkyRegion

A line in sky coordinates.

Parameters
startSkyCoord

The start position.

endSkyCoord

The end position.

metaRegionMeta, optional

A dictionary that stores the meta attributes of this region.

visualRegionVisual, optional

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

Attributes Summary

end

The end position as a astropy.coordinates.SkyCoord.

start

The start position as a astropy.coordinates.SkyCoord.

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.

Attributes Documentation

end

The end position as a astropy.coordinates.SkyCoord.

start

The start position as a astropy.coordinates.SkyCoord.

Methods Documentation

contains(skycoord, wcs)[source]

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)[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
pixel_regionPixelRegion

A pixel region.