PSF Photometry (photutils.psf)#

Subpackage containing tools for performing point-spread-function (PSF) photometry.

Functions#

decode_psf_flags(flags[, return_bit_values])

Decode PSF photometry bit flags into individual components.

extract_stars(data, catalogs, *[, size])

Extract cutout images centered on stars defined in the input catalog(s).

fit_2dgaussian(data, *[, xypos, fwhm, ...])

Fit a 2D Gaussian model to one or more sources in an image.

fit_fwhm(data, *[, xypos, fwhm, fit_shape, ...])

Fit the FWHM of one or more sources in an image.

grid_from_epsfs(epsfs[, grid_xypos, meta])

make_psf_model(model, *[, x_name, y_name, ...])

Make a PSF model that can be used with the PSF photometry classes (PSFPhotometry or IterativePSFPhotometry) from an Astropy fittable 2D model.

make_psf_model_image(shape, psf_model, ...)

Make an example image containing PSF model images.

stdpsf_reader(filename[, detector_id])

Generate a GriddedPSFModel from a STScI standard- format ePSF (STDPSF) FITS file.

webbpsf_reader(filename)

Generate a GriddedPSFModel from a WebbPSF FITS file containing a PSF grid.

Classes#

AiryDiskPSF(*[, flux, x_0, y_0, radius, ...])

A 2D Airy disk PSF model.

CircularGaussianPRF(*[, flux, x_0, y_0, ...])

A circular 2D Gaussian PSF model integrated over pixels.

CircularGaussianPSF(*[, flux, x_0, y_0, ...])

A circular 2D Gaussian PSF model.

CircularGaussianSigmaPRF(*[, flux, x_0, ...])

A circular 2D Gaussian PSF model integrated over pixels.

EPSFBuildResult(epsf, fitted_stars, ...)

Container for ePSF building results.

EPSFBuilder(*[, oversampling, shape, ...])

Class to build an effective PSF (ePSF).

EPSFFitter(*[, fitter, fit_boxsize])

EPSFStar(data, *[, weights, cutout_center, ...])

A class to hold a 2D cutout image and associated metadata of a star used to build an ePSF.

EPSFStars(stars_list)

Class to hold a list of EPSFStar and/or LinkedEPSFStar objects.

GaussianPRF(*[, flux, x_0, y_0, x_fwhm, ...])

A 2D Gaussian PSF model integrated over pixels.

GaussianPSF(*[, flux, x_0, y_0, x_fwhm, ...])

A 2D Gaussian PSF model.

GriddedPSFModel(nddata, *[, flux, x_0, y_0, ...])

A model for a grid of 2D ePSF models.

GriddedPSFModelRead(instance, cls)

Read and parse a FITS file into a GriddedPSFModel instance.

ImagePSF(data, *[, flux, x_0, y_0, origin, ...])

A model for a 2D image PSF.

IterativePSFPhotometry(psf_model, fit_shape, ...)

Class to iteratively perform PSF photometry.

LinkedEPSFStar(stars_list)

A class to hold a list of EPSFStar objects for linked stars.

MoffatPSF(*[, flux, x_0, y_0, alpha, beta, ...])

A 2D Moffat PSF model.

PSFPhotometry(psf_model, fit_shape, *[, ...])

Class to perform PSF photometry.

STDPSFGrid(filename)

Class to read and plot "STDPSF" format ePSF model grids.

SourceGrouper(min_separation)

Class to group sources into clusters based on a minimum separation distance.

SourceGroups(x, y, groups)

Container for source grouping results with analysis methods.

Class Inheritance Diagram#

Inheritance diagram of photutils.psf.functional_models.AiryDiskPSF, photutils.psf.functional_models.CircularGaussianPRF, photutils.psf.functional_models.CircularGaussianPSF, photutils.psf.functional_models.CircularGaussianSigmaPRF, photutils.psf.epsf_builder.EPSFBuildResult, photutils.psf.epsf_builder.EPSFBuilder, photutils.psf.epsf_builder.EPSFFitter, photutils.psf.epsf_stars.EPSFStar, photutils.psf.epsf_stars.EPSFStars, photutils.psf.functional_models.GaussianPRF, photutils.psf.functional_models.GaussianPSF, photutils.psf.gridded_models.GriddedPSFModel, photutils.psf.model_io.GriddedPSFModelRead, photutils.psf.image_models.ImagePSF, photutils.psf.iterative.IterativePSFPhotometry, photutils.psf.epsf_stars.LinkedEPSFStar, photutils.psf.functional_models.MoffatPSF, photutils.psf.photometry.PSFPhotometry, photutils.psf.gridded_models.STDPSFGrid, photutils.psf.groupers.SourceGrouper, photutils.psf.groupers.SourceGroups

User Guide#

PSF Photometry (photutils.psf)