SkyAperture

class photutils.aperture.SkyAperture

Bases: Aperture

Abstract base class for all apertures defined in celestial coordinates.

Attributes Summary

isscalar	Whether the instance is scalar (i.e., a single position).
shape	The shape of the instance.

Methods Summary

copy()	Make a deep copy of this object.
positions()	The aperture positions, as an array of (x, y) coordinates or a SkyCoord.
to_pixel(wcs)	Convert the aperture to a PixelAperture object defined in pixel coordinates.

Attributes Documentation

isscalar

Whether the instance is scalar (i.e., a single position).

shape

The shape of the instance.

Methods Documentation

copy()

Make a deep copy of this object.

Returns:

resultAperture

A deep copy of the Aperture object.

abstractmethod positions()

The aperture positions, as an array of (x, y) coordinates or a SkyCoord.

abstractmethod to_pixel(wcs)

Convert the aperture to a PixelAperture 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:

aperturePixelAperture object

A PixelAperture object.