CompoundPixelRegion

class regions.CompoundPixelRegion(region1, region2, operator, meta=None, visual=None)[source]

Bases: regions.core.core.PixelRegion

A class that represents the logical combination of two regions in pixel coordinates.

Parameters
region1PixelRegion

The inner Pixel region.

region2PixelRegion

The outer Pixel region.

operatorcallable

A callable binary operator.

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

area

The area of the region.

bounding_box

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

mpl_artist

operator

region1

Descriptor class for compound pixel and sky regions.

region2

Descriptor class for compound pixel and sky regions.

Methods Summary

as_artist([origin])

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

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
mpl_artist = 'Patch'
operator
region1

Descriptor class for compound pixel and sky regions.

region2

Descriptor class for compound pixel and sky regions.

Methods Documentation

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

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

Parameters
originarray_like, optional

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

**kwargsdict

Any keyword arguments accepted by PathPatch.

Returns
patchPathPatch

A matplotlib patch object.

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
regionCompoundPixelRegion

The rotated region (which is an independent copy).

to_mask(mode='center', subpixels=1)[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.