SkyCircularAperture

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

Bases: photutils.SkyAperture

Circular aperture(s), defined in sky coordinates.

Parameters:
positions : SkyCoord

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

r : Quantity

The radius of the aperture(s), either in angular or pixel units.

Methods Summary

to_pixel(wcs[, mode]) Convert the aperture to a CircularAperture object defined in pixel coordinates.

Methods Documentation

to_pixel(wcs, mode='all')[source]

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

Parameters:
wcs : WCS

The world coordinate system (WCS) transformation to use.

mode : {‘all’, ‘wcs’}, optional

Whether to do the transformation including distortions ('all'; default) or only including only the core WCS transformation ('wcs').

Returns:
aperture : CircularAperture object

A CircularAperture object.