SkyEllipticalAperture

class photutils.SkyEllipticalAperture(positions, a, b, theta=<Quantity 0. deg>)[source]

Bases: photutils.SkyAperture

Elliptical 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.

a : Quantity

The semimajor axis, either in angular or pixel units.

b : Quantity

The semiminor axis, either in angular or pixel units.

theta : Quantity, optional

The position angle (in angular units) of the semimajor axis. For a right-handed world coordinate system, the position angle increases counterclockwise from North (PA=0). The default is 0 degrees.

Methods Summary

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

Methods Documentation

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

Convert the aperture to an EllipticalAperture 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 : EllipticalAperture object

An EllipticalAperture object.