CompoundSkyRegion

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

Bases: regions.SkyRegion

Represents the logical combination of two regions in sky coordinates.

Parameters:
region1 : SkyRegion object

The inner sky region.

region2 : SkyRegion object

The outer sky region.

operator : function

A callable binary operator.

meta : RegionMeta object, optional

A dictionary which stores the meta attributes of this region.

visual : RegionVisual object, optional

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

Attributes Summary

operator
region1 Descriptor class is for CompoundSkyRegion which takes a SkyRegion object.
region2 Descriptor class is for CompoundSkyRegion which takes a SkyRegion object.

Methods Summary

as_artist(self, ax, \*\*kwargs)
contains(self, skycoord, wcs) Check whether a sky coordinate falls inside the region
to_pixel(self, wcs) Returns the equivalent region defined in pixel coordinates.

Attributes Documentation

operator
region1

Descriptor class is for CompoundSkyRegion which takes a SkyRegion object.

region2

Descriptor class is for CompoundSkyRegion which takes a SkyRegion object.

Methods Documentation

as_artist(self, ax, **kwargs)[source]
contains(self, skycoord, wcs)[source]

Check whether a sky coordinate falls inside the region

Parameters:
skycoord : SkyCoord

The position or positions to check

wcs : WCS instance

The world coordinate system transformation to assume

to_pixel(self, wcs)[source]

Returns the equivalent region defined in pixel coordinates.

Parameters:
wcs : WCS instance

The world coordinate system transformation to assume

Returns:
pixel_region : PixelRegion object.