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
region1SkyRegion object

The inner sky region.

region2SkyRegion object

The outer sky region.

operatorfunction

A callable binary operator.

metaRegionMeta object, optional

A dictionary which stores the meta attributes of this region.

visualRegionVisual 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(ax, **kwargs)

contains(skycoord, wcs)

Check whether a sky coordinate falls inside the region

to_pixel(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(ax, **kwargs)[source]
contains(skycoord, wcs)[source]

Check whether a sky coordinate falls inside the region

Parameters
skycoordSkyCoord

The position or positions to check

wcsWCS instance

The world coordinate system transformation to assume

to_pixel(wcs)[source]

Returns the equivalent region defined in pixel coordinates.

Parameters
wcsWCS instance

The world coordinate system transformation to assume

Returns
pixel_regionPixelRegion object.