LinePixelRegion

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

Bases: regions.core.core.PixelRegion

A line in pixel coordinates.

Parameters
startPixCoord

The start position.

endPixCoord

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.

Examples

from regions import PixCoord, LinePixelRegion
import matplotlib.pyplot as plt

fig, ax = plt.subplots(1, 1)

start = PixCoord(x=15, y=10)
end = PixCoord(x=20, y=25)
reg = LinePixelRegion(start=start, end=end)
patch = reg.plot(ax=ax, edgecolor='red', lw=2, label='Line')

ax.legend(handles=(patch,), loc='upper center')
ax.set_xlim(0, 30)
ax.set_ylim(0, 30)
ax.set_aspect('equal')

(Source code, png, hires.png, pdf, svg)

../_images/regions-LinePixelRegion-1.png

Attributes Summary

area

The exact analytical area of the region shape.

bounding_box

The minimal bounding box (in integer pixel coordinates) that contains the region.

end

The end pixel position as a PixCoord.

start

The start pixel position as a PixCoord.

Methods Summary

as_artist([origin])

Return a matplotlib patch object for this region (matplotlib.patches.Arrow).

contains(pixcoord)

Check whether a position or positions fall inside the region.

rotate(center, angle)

Rotate the region.

to_mask([mode, subpixels])

Return a mask for the region.

to_sky(wcs)

Return a region defined in sky coordinates.

Attributes Documentation

area
bounding_box
end

The end pixel position as a PixCoord.

start

The start pixel position as a PixCoord.

Methods Documentation

as_artist(origin=(0, 0), **kwargs)[source]

Return a matplotlib patch object for this region (matplotlib.patches.Arrow).

Parameters
originarray_like, optional

The (x, y) pixel position of the origin of the displayed image.

**kwargsdict

Any keyword arguments accepted by Arrow. These keywords will override any visual meta attributes of this region.

Returns
artistArrow

A matplotlib line patch.

contains(pixcoord)[source]

Check whether a position or positions fall inside the region.

Parameters
pixcoordPixCoord

The position or positions to check.

rotate(center, angle)[source]

Rotate the region.

Positive angle corresponds to counter-clockwise rotation.

Parameters
centerPixCoord

The rotation center point.

angleAngle

The rotation angle.

Returns
regionLinePixelRegion

The rotated region (which is an independent copy).

to_mask(mode='center', subpixels=5)[source]

Return a mask for the region.

Parameters
mode{‘center’, ‘exact’, ‘subpixels’}, optional

The method used to determine the overlap of the region on the pixel grid. Not all options are available for all region types. Note that the more precise methods are generally slower. The following methods are available:

  • 'center': A pixel is considered to be entirely in or out of the region depending on whether its center is in or out of the region. The returned mask will contain values only of 0 (out) and 1 (in).

  • 'exact' (default): The exact fractional overlap of the region and each pixel is calculated. The returned mask will contain values between 0 and 1.

  • 'subpixel': A pixel is divided into subpixels (see the subpixels keyword), each of which are considered to be entirely in or out of the region depending on whether its center is in or out of the region. If subpixels=1, this method is equivalent to 'center'. The returned mask will contain values between 0 and 1.

subpixelsint, optional

For the 'subpixel' mode, resample pixels by this factor in each dimension. That is, each pixel is divided into subpixels ** 2 subpixels.

Returns
maskRegionMask

A mask for the region.

to_sky(wcs)[source]

Return a region defined in sky coordinates.

Parameters
wcsWCS

The world coordinate system transformation to use to convert from pixels to sky coordinates.

Returns
sky_regionSkyRegion

The sky region.