Aperture Photometry (photutils.aperture)#

This subpackage contains tools to perform aperture photometry.

Functions#

aperture_photometry(data, apertures[, ...])

Perform aperture photometry on the input data by summing the flux within the given aperture(s).

region_to_aperture(region)

Convert a given regions.Region object to an Aperture object.

Classes#

Aperture()

Abstract base class for all apertures.

ApertureMask(data, bbox)

Class for an aperture mask.

ApertureStats(data, aperture, *[, error, ...])

Class to create a catalog of statistics for pixels within an aperture.

BoundingBox(ixmin, ixmax, iymin, iymax)

A rectangular bounding box in integer (not float) pixel indices.

CircularAnnulus(positions, r_in, r_out)

A circular annulus aperture defined in pixel coordinates.

CircularAperture(positions, r)

A circular aperture defined in pixel coordinates.

CircularMaskMixin()

Mixin class to create masks for circular and circular-annulus aperture objects.

EllipticalAnnulus(positions, a_in, a_out, b_out)

An elliptical annulus aperture defined in pixel coordinates.

EllipticalAperture(positions, a, b[, theta])

An elliptical aperture defined in pixel coordinates.

EllipticalMaskMixin()

Mixin class to create masks for elliptical and elliptical-annulus aperture objects.

PixelAperture()

Abstract base class for apertures defined in pixel coordinates.

RectangularAnnulus(positions, w_in, w_out, h_out)

A rectangular annulus aperture defined in pixel coordinates.

RectangularAperture(positions, w, h[, theta])

A rectangular aperture defined in pixel coordinates.

RectangularMaskMixin()

Mixin class to create masks for rectangular or rectangular-annulus aperture objects.

SkyAperture()

Abstract base class for all apertures defined in celestial coordinates.

SkyCircularAnnulus(positions, r_in, r_out)

A circular annulus aperture defined in sky coordinates.

SkyCircularAperture(positions, r)

A circular aperture defined in sky coordinates.

SkyEllipticalAnnulus(positions, a_in, a_out, ...)

An elliptical annulus aperture defined in sky coordinates.

SkyEllipticalAperture(positions, a, b[, theta])

An elliptical aperture defined in sky coordinates.

SkyRectangularAnnulus(positions, w_in, ...)

A rectangular annulus aperture defined in sky coordinates.

SkyRectangularAperture(positions, w, h[, theta])

A rectangular aperture defined in sky coordinates.

Class Inheritance Diagram#

Inheritance diagram of photutils.aperture.core.Aperture, photutils.aperture.mask.ApertureMask, photutils.aperture.stats.ApertureStats, photutils.aperture.bounding_box.BoundingBox, photutils.aperture.circle.CircularAnnulus, photutils.aperture.circle.CircularAperture, photutils.aperture.circle.CircularMaskMixin, photutils.aperture.ellipse.EllipticalAnnulus, photutils.aperture.ellipse.EllipticalAperture, photutils.aperture.ellipse.EllipticalMaskMixin, photutils.aperture.core.PixelAperture, photutils.aperture.rectangle.RectangularAnnulus, photutils.aperture.rectangle.RectangularAperture, photutils.aperture.rectangle.RectangularMaskMixin, photutils.aperture.core.SkyAperture, photutils.aperture.circle.SkyCircularAnnulus, photutils.aperture.circle.SkyCircularAperture, photutils.aperture.ellipse.SkyEllipticalAnnulus, photutils.aperture.ellipse.SkyEllipticalAperture, photutils.aperture.rectangle.SkyRectangularAnnulus, photutils.aperture.rectangle.SkyRectangularAperture