SkyCircularAperture

class photutils.aperture.SkyCircularAperture(positions, r)[source]

Bases: photutils.aperture.SkyAperture

A circular aperture defined in sky coordinates.

The aperture has a single fixed size/shape, but it can have multiple positions (see the positions input).

Parameters
positionsSkyCoord

The celestial coordinates of the aperture center(s). This can be either scalar coordinates or an array of coordinates.

rscalar Quantity

The radius of the circle, either in angular or pixel units.

Examples

>>> from astropy.coordinates import SkyCoord
>>> import astropy.units as u
>>> from photutils import SkyCircularAperture
>>> positions = SkyCoord(ra=[10., 20.], dec=[30., 40.], unit='deg')
>>> aper = SkyCircularAperture(positions, 0.5*u.arcsec)

Attributes Summary

positions

Check that value is a SkyCoord.

r

Check that value is either an angular or a pixel scalar Quantity.

Methods Summary

to_pixel(wcs)

Convert the aperture to a CircularAperture object defined in pixel coordinates.

Attributes Documentation

positions

Check that value is a SkyCoord.

r

Check that value is either an angular or a pixel scalar Quantity.

Methods Documentation

to_pixel(wcs)[source]

Convert the aperture to a CircularAperture object defined in pixel coordinates.

Parameters
wcsWCS object

A world coordinate system (WCS) transformation that supports the astropy shared interface for WCS (e.g., astropy.wcs.WCS, gwcs.wcs.WCS).

Returns
apertureCircularAperture object

A CircularAperture object.