EPSFFitter

class photutils.psf.EPSFFitter(*, fitter=None, fit_boxsize=5, **fitter_kwargs)

Bases: object

Deprecated since version 3.0: EPSFFitter is deprecated and will be removed in a version 4.0. Use EPSFBuilder with the fitter, fit_shape, and fitter_maxiters parameters instead.

Class to fit an ePSF model to one or more stars.

Parameters:

fitterastropy.modeling.fitting.Fitter, optional

A Fitter object. If None, then the default TRFLSQFitter will be used.

fit_boxsizeint, tuple of int, or None, optional

The size (in pixels) of the box centered on the star to be used for ePSF fitting. This allows using only a small number of central pixels of the star (i.e., where the star is brightest) for fitting. If fit_boxsize is a scalar then a square box of size fit_boxsize will be used. If fit_boxsize has two elements, they must be in (ny, nx) order. fit_boxsize must have odd values and be greater than or equal to 3 for both axes. If None, the fitter will use the entire star image.

**fitter_kwargsdict, optional

Any additional keyword arguments (except x, y, z, or weights) to be passed directly to the __call__() method of the input fitter.

Deprecated since version 3.0: EPSFFitter is deprecated and will be removed in a version 4.0. Use EPSFBuilder with the fitter, fit_shape, and fitter_maxiters parameters instead.

Methods Summary

__call__(epsf, stars)

Fit an ePSF model to stars.

Methods Documentation

__call__(epsf, stars)

Fit an ePSF model to stars.

Parameters:

epsfImagePSF

An ePSF model to be fitted to the stars.

starsEPSFStars object

The stars to be fit. The center coordinates for each star should be as close as possible to actual centers. For stars than contain weights, a weighted fit of the ePSF to the star will be performed.

Returns:

fitted_starsEPSFStars object

The fitted stars. The ePSF-fitted center position and flux are stored in the center (and cutout_center) and flux attributes.