CompoundSkyRegion

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

Bases: regions.core.core.SkyRegion

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

Parameters
region1SkyRegion

The inner sky region.

region2SkyRegion

The outer sky 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

operator

region1

Descriptor class for compound pixel and sky regions.

region2

Descriptor class for compound pixel and sky regions.

Methods Summary

as_artist(ax, **kwargs)

contains(skycoord, wcs)

Check whether a sky coordinate falls inside the region.

to_pixel(wcs)

Return the equivalent region defined in pixel coordinates.

Attributes Documentation

operator
region1

Descriptor class for compound pixel and sky regions.

region2

Descriptor class for compound pixel and sky regions.

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

The world coordinate system transformation to use to convert between sky and pixel coordinates.

to_pixel(wcs)[source]

Return the equivalent region defined in pixel coordinates.

Parameters
wcsWCS

The world coordinate system transformation to use to convert between sky and pixel coordinates.

Returns
pixel_regionPixelRegion

A pixel region.