Photutils

-------------------

General
^^^^^^^

New Features
^^^^^^^^^^^^

Bug Fixes
^^^^^^^^^

API Changes
^^^^^^^^^^^

-------------------

General
^^^^^^^

- The minimum required Python is now 3.10. [1719]

- The minimum required NumPy is now 1.23. [1719]

- The minimum required SciPy is now 1.8. [1719]

- The minimum required scikit-image is now 0.20. [1719]

- The minimum required scikit-learn is now 1.1. [1719]

- The minimum required pytest-astropy is now 0.11. [1719]

- The minimum required sphinx-astropy is now 1.9. [1719]

- NumPy 2.0 is supported.

Bug Fixes
^^^^^^^^^

- ``photutils.background``

- No longer warn about NaNs in the data if those NaNs are masked in
``mask`` passed to ``Background2D``. [1712]

API Changes
^^^^^^^^^^^

- ``photutils.utils``

- The default value for the ``ImageDepth`` ``mask_pad`` keyword is now
set to 0. [1714]

-------------------

New Features
^^^^^^^^^^^^

- ``photutils.psf``

- An ``init_params`` table is now included in the ``PSFPhotometry``
``fit_results`` dictionary. [1681]

- Added an ``include_localbkg`` keyword to the PSF photometry
``make_model_image`` and ``make_residual_image`` methods. [1691]

- Significantly reduced the memory usage of PSF photometry when using
a ``GriddedPSFModel`` PSF model. [1679]

- Added a ``mode`` keyword to ``IterativePSFPhotometry`` for
controlling the fitting mode. [1708]

- ``photutils.datasets``

- Improved the performance of ``make_test_psf_data`` when generating
random coordinates with a minimum separation. [1668]

- ``photutils.segmentation``

- The ``SourceFinder`` ``npixels`` keyword can now be a tuple
corresponding to the values used for the source finder and source
deblender, respectively. [1688]

- ``photutils.utils``

- Improved the performance of ``ImageDepth`` when generating
random coordinates with a minimum separation. [1668]

Bug Fixes
^^^^^^^^^

- ``photutils.psf``

- Fixed an issue where PSF models produced by ``make_psf_model`` would
raise an error with ``PSFPhotometry`` if the fit did not converge.
[1672]

- Fixed an issue where ``GriddedPSFModel`` fixed model parameters were
not respected when copying the model or fitting with the PSF
photometry classes. [1679]

API Changes
^^^^^^^^^^^

- ``photutils.aperture``

- ``PixelAperture`` instances now raise an informative error message
when ``positions`` is input as a ``zip`` object containing Astropy
``Quantity`` objects. [1682]

- ``photutils.psf``

- The ``GridddedPSFModel`` string representations now include the
model ``flux``, ``x_0``, and ``y_0`` parameters. [1680]

- The PSF photometry ``make_model_image`` and ``make_residual_image``
methods no longer include the local background by default. This is a
backwards-incompatible change. If the previous behavior is desired,
set ``include_localbkg=True``. [1703]

- The PSF photometry ``finder_results`` attribute is now returned as a
``QTable`` instead of a list of ``QTable``. [1704]

- Deprecated the ``NonNormalizable`` custom warning class in favor of
``AstropyUserWarning``. [1710]

- ``photutils.segmentation``

- The ``SourceCatalog`` ``get_label`` and ``get_labels`` methods now
raise a ``ValueError`` if any of the input labels are invalid. [1694]

-------------------

General
^^^^^^^

- The minimum required Astropy is now 5.1. [1627]

New Features
^^^^^^^^^^^^

- ``photutils.datasets``

- Added a ``border_size`` keyword to ``make_test_psf_data``. [1665]

- Improved the generation of random PSF positions in
``make_test_psf_data``. [1665]

- ``photutils.detection``

- Added a ``min_separation`` keyword to ``DAOStarFinder`` and
``IRAFStarFinder``. [1663]

- ``photutils.morphology``

- Added a ``wcs`` keyword to ``data_properties``. [1648]

- ``photutils.psf``

- The ``GriddedPSFModel`` ``plot_grid`` method now returns a
``matplotlib.figure.Figure`` object. [1653]

- Added the ability for the ``GriddedPSFModel`` ``read`` method to
read FITS files generated by WebbPSF. [1654]

- Added "flux_0" and "flux0" as allowed flux column names in the
``init_params`` table input to the PSF photometry objects. [1656]

- PSF models output from ``prepare_psf_model`` can now be input into
the PSF photometry classes. [1657]

- Added ``make_psf_model`` function for making a PSF model from a
2D Astropy model. Compound models are also supported. [1658]

- The ``GriddedPSFModel`` oversampling can now be different in the x
and y directions. The ``oversampling`` attribute is now stored as
a 1D ``numpy.ndarray`` with two elements. [1664]

- ``photutils.segmentation``

- The ``SegmentationImage`` ``make_source_mask`` method now uses a
much faster implementation of binary dilation. [1638]

- Added a ``scale`` keyword to the ``SegmentationImage.to_patches()``
method to scale the sizes of the polygon patches. [1641, 1646]

- Improved the ``SegmentationImage`` ``imshow`` method to ensure that
labels are plotted with unique colors. [1649]

- Added a ``imshow_map`` method to ``SegmentationImage`` for plotting
segmentation images with a small number of non-consecutive labels.
[1649]

- Added a ``reset_cmap`` method to ``SegmentationImage`` for resetting
the colormap to a new random colormap. [1649]

- ``photutils.utils``

- Improved the generation of random aperture positions in
``ImageDepth``. [1666]

Bug Fixes
^^^^^^^^^

- ``photutils.aperture``

- Fixed an issue where the aperture ``plot`` method ``**kwargs`` were
not reset to the default values when called multiple times. [1655]

- ``photutils.psf``

- Fixed a bug where ``SourceGrouper`` would fail if only one source
was input. [1617]

- Fixed a bug in ``GriddedPSFModel`` ``plot_grid`` where the grid
could be plotted incorrectly if the input ``xygrid`` was not sorted
in y then x order. [1661]

- ``photutils.segmentation``

- Fixed an issue where ``deblend_sources`` and ``SourceFinder`` would
raise an error if the ``contrast`` keyword was set to 1 (meaning no
deblending). [1636]

- Fixed an issue where the vertices of the ``SegmentationImage``
``polygons`` were shifted by 0.5 pixels in both x and y. [1646]

API Changes
^^^^^^^^^^^

- The metadata in output tables now contains a timestamp. [1640]

- The order of the metadata in a table is now preserved when writing to
a file. [1640]

- ``photutils.psf``

- Deprecated the ``prepare_psf_model`` function. Use the new
``make_psf_model`` function instead. [1658]

- The ``GriddedPSFModel`` now stores the ePSF grid such that it is
first sorted by y then by x. As a result, the order of the ``data``
and ``xygrid`` attributes may be different. [1661]

- The ``oversampling`` attribute is now stored as a 1D
``numpy.ndarray`` with two elements. [1664]

- A ``ValueError`` is raised if ``GriddedPSFModel`` is called with x
and y arrays that have more than 2 dimensions. [1662]

- ``photutils.segmentation``

- Removed the deprecated ``kernel`` keyword from ``SourceCatalog``.
[1613]

------------------

General
^^^^^^^

- The minimum required Python is now 3.9. [1569]

- The minimum required NumPy is now 1.22. [1572]

New Features
^^^^^^^^^^^^

- ``photutils.background``

- Added ``LocalBackground`` class for computing local backgrounds in a
circular annulus aperture. [1556]

- ``photutils.datasets``

- Added new ``make_test_psf_data`` function. [1558, 1582, 1585]

- ``photutils.psf``

- Propagate measurement uncertainties in PSF fitting. [1543]

- Added new ``PSFPhotometry`` and ``IterativePSFPhotometry`` classes
for performing PSF-fitting photometry. [1558, 1559, 1563, 1566,
1567, 1581, 1586, 1590, 1594, 1603, 1604]

- Added a new ``SourceGrouper`` class. [1558, 1605]

- Added a ``GriddedPSFModel`` ``fill_value`` attribute. [1583]

- Added a ``grid_from_epsfs`` function to make a ``GriddedPSFModel``
from ePSFs. [1596]

- Added a ``read`` method to ``GriddedPSFModel`` for reading "STDPSF"
FITS files containing grids of ePSF models. [1557]

- Added a ``plot_grid`` method to ``GriddedPSFModel`` for plotting
ePSF grids. [1557]

- Added a ``STDPSFGrid`` class for reading "STDPSF" FITS files
containing grids of ePSF models and plotting the ePSF grids. [1557]


Bug Fixes
^^^^^^^^^

- ``photutils.aperture``

- Fixed a bug in the validation of ``PixelAperture`` positions. [1553]

API Changes
^^^^^^^^^^^

- ``photutils.psf``

- Deprecated the PSF photometry classes ``BasicPSFPhotometry``,
``IterativelySubtractedPSFPhotometry``, and
``DAOPhotPSFPhotometry``. Use the new ``PSFPhotometry`` or
``IterativePSFPhotometry`` class instead. [1578]

- Deprecated the ``DAOGroup``, ``DBSCANGroup``, and ``GroupStarsBase``
classes. Use the new ``SourceGrouper`` class instead. [1578]

- Deprecated the ``get_grouped_psf_model`` and ``subtract_psf``
function. [1578]

------------------

General
^^^^^^^

- The minimum required Numpy is now 1.21. [1528]

- The minimum required Scipy is now 1.7.0. [1528]

- The minimum required Matplotlib is now 3.5.0. [1528]

- The minimum required scikit-image is now 0.19.0. [1528]

- The minimum required gwcs is now 0.18. [1528]

New Features
^^^^^^^^^^^^

- ``photutils.profiles``

- The ``RadialProfile`` and ``CurveOfGrowth`` radial bins can now be
directly input, which also allows for non-uniform radial spacing.
[1540]

Bug Fixes
^^^^^^^^^

- ``photutils.psf``

- Fixed an issue with the local model cache in ``GriddedPSFModel``,
significantly improving performance. [1536]

API Changes
^^^^^^^^^^^

- Removed the deprecated ``axes`` keyword in favor of ``ax`` for
consistency with other packages. [1523]

- ``photutils.aperture``

- Removed the ``ApertureStats`` ``unpack_nddata`` method. [1537]

- ``photutils.profiles``

- The API for defining the radial bins for the ``RadialProfile`` and
``CurveOfGrowth`` classes was changed. While the new API allows for
more flexibility, unfortunately, it is not backwards-compatible.
[1540]

- ``photutils.segmentation``

- Removed the deprecated ``kernel`` keyword from ``detect_sources``
and ``deblend_sources``. [1524]

- Deprecated the ``kernel`` keyword in ``SourceCatalog``. [1525]

- Removed the deprecated ``outline_segments`` method from
``SegmentationImage``. [1526]

- The ``SourceCatalog`` ``kron_params`` attribute is no longer
returned as a ``ndarray``. It is returned as a ``tuple``. [1531]