CompoundPixelRegion¶
- class regions.CompoundPixelRegion(region1, region2, operator, meta=None, visual=None)[source]¶
Bases:
PixelRegion
A class that represents the logical combination of two regions in pixel coordinates.
- Parameters:
- region1
PixelRegion
The inner Pixel region.
- region2
PixelRegion
The outer Pixel region.
- operatorcallable
A callable binary operator.
- meta
RegionMeta
, optional A dictionary that stores the meta attributes of this region.
- visual
RegionVisual
, optional A dictionary that stores the visual meta attributes of this region.
- region1
Attributes Summary
The exact analytical area of the region shape.
The minimal bounding box (in integer pixel coordinates) that contains the region.
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¶
- operator¶
- region1¶
- region2¶
Methods Documentation
- as_artist(origin=(0, 0), **kwargs)[source]¶
Return a matplotlib patch object for this region (
matplotlib.patches.PathPatch
).
- contains(pixcoord)[source]¶
Check whether a position or positions fall inside the region.
- Parameters:
- pixcoord
PixCoord
The position or positions to check.
- pixcoord
- rotate(center, angle)[source]¶
Rotate the region.
Positive
angle
corresponds to counter-clockwise rotation.- Parameters:
- Returns:
- region
CompoundPixelRegion
The rotated region (which is an independent copy).
- region
- 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 thesubpixels
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. Ifsubpixels=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 intosubpixels ** 2
subpixels.
- Returns:
- mask
RegionMask
A mask for the region.
- mask