Photutils

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

General
^^^^^^^

- The minimum required python version is 3.7. [1120]

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

- ``photutils.aperture``

- The ``PixelAperture.plot()`` method now returns a list of
``matplotlib.patches.Patch`` objects. [923]

- Added an ``area_overlap`` method for ``PixelAperture`` objects that
gives the overlapping area of the aperture on the data. [874]

- Added a ``get_overlap_slices`` method and a ``center`` attribute to
``BoundingBox``. [1157]

- Added a ``get_values`` method to ``ApertureMask`` that returns a 1D
array of mask-weighted values. [1158, 1161]

- Added ``get_overlap_slices`` method to ``ApertureMask``. [1165]

- ``photutils.background``

- The ``Background2D`` class now accepts astropy ``NDData``,
``CCDData``, and ``Quantity`` objects as data inputs. [1140]

- ``photutils.detection``

- Added a ``StarFinder`` class to detect stars with a user-defined
kernel. [1182]

- ``photutils.isophote``

- Added the ability to specify the output columns in the
``IsophoteList`` ``to_table`` method. [1117]

- ``photutils.psf``

- The ``EPSFStars`` class is now usable with multiprocessing. [1152]

- Slicing ``EPSFStars`` now returns an ``EPSFStars`` instance. [1185]

- ``photutils.segmentation``

- Added a modified, significantly faster, ``SourceCatalog`` class.
[1170, 1188, 1191]

- Added ``circular_aperture`` and ``circular_photometry`` methods to
the ``SourceCatalog`` class. [1188]

- Added ``fwhm`` property to the ``SourceCatalog`` class. [1191]

- Added ``fluxfrac_radius`` method to the ``SourceCatalog`` class.
[1192]

- Added a ``bbox`` attribute to ``SegmentationImage``. [1187]

Bug Fixes
^^^^^^^^^

- ``photutils.aperture``

- Slicing a scalar ``Aperture`` object now raises an informative error
message. [1154]

- Fixed an issue where ``ApertureMask.multiply`` ``fill_value`` was
not applied to pixels outside of the aperture mask, but within the
aperture bounding box. [1158]

- Fixed an issue where ``ApertureMask.cutout`` would raise an error
if ``fill_value`` was non-finite and the input array was integer
type. [1158]

- Fixed an issue where ``RectangularAnnulus`` with a non-default
``h_in`` would give an incorrect ``ApertureMask``. [1160]

- ``photutils.isophote``

- Fix computation of gradient relative error when gradient=0. [1180]

- ``photutils.psf``

- Fixed a bug in ``EPSFBuild`` where a warning was raised if the input
``smoothing_kernel`` was an ``numpy.ndarray``. [1146]

- Fixed a bug that caused photometry to fail on an ``EPSFmodel`` with
multiple stars in a group. [1135]

- Added a fallback ``aperture_radius`` for PSF models without a FWHM
or sigma attribute, raising a warning. [740]

- ``photutils.segmentation``

- Fixed ``SourceProperties`` ``local_background`` to work with
Quantity data inputs. [1162]

- Fixed ``SourceProperties`` ``local_background`` for sources near the
image edges. [1162]

- Fixed ``SourceProperties`` ``kron_radius`` for sources that are
completely masked. [1164]

- Fixed ``SourceProperties`` Kron properties for sources near the
image edges. [1167]

- Fixed ``SourceProperties`` Kron mask correction. [1167]

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

- ``photutils.aperture``

- Deprecated the ``BoundingBox`` ``slices`` attribute. Use the
``get_overlap_slices`` method instead. [1157]

- ``photutils.centroids``

- Removed the deprecated ``fit_2dgaussian`` function and
``GaussianConst2D`` class. [1147]

- Importing tools from the centroids subpackage without including the
subpackage name is deprecated. [1190]

- ``photutils.detection``

- Importing the ``DAOStarFinder``, ``IRAFStarFinder``, and
``StarFinderBase`` classes from the deprecated ``findstars.py``
module is now deprecated. These classes can be imported using ``from
photutils.detection import <class>``. [1173]

- Importing the ``find_peaks`` function from the deprecated
``core.py`` module is now deprecated. This function can be imported
using ``from photutils.detection import find_peaks``. [1173]

- ``photutils.morphology``

- Importing tools from the morphology subpackage without including the
subpackage name is deprecated. [1190]

- ``photutils.segmentation``

- Deprecated the ``"mask_all"`` option in the ``SourceProperties``
``kron_params`` keyword. [1167]

- Deprecated ``source_properties``, ``SourceProperties``, and
``LegacySourceCatalog``. Use the new ``SourceCatalog`` function
instead. [1170]

- The ``detect_threshold`` function was moved to the ``segmentation``
subpackage. [1171]

- Removed the ability to slice ``SegmentationImage``. Instead slice
the ``segments`` attribute. [1187]

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

General
^^^^^^^

- ``photutils.background``

- Improved the performance of ``Background2D`` (e.g., by a factor
of ~4 with 2048x2048 input arrays when using the default interpolator).
[1103, 1108]

Bug Fixes
^^^^^^^^^

- ``photutils.background``

- Fixed a bug with ``Background2D`` where using ``BkgIDWInterpolator``
would give incorrect results. [1104]

- ``photutils.isophote``

- Corrected calculations of upper harmonics and their errors [1089]

- Fixed bug that caused an infinite loop when the sample extracted
from an image has zero length. [1129]

- Fixed a bug where the default ``fixed_parameters`` in
``EllipseSample.update()`` were not defined. [1139]

- ``photutils.psf``

- Fixed a bug where very incorrect PSF-fitting uncertainties could
be returned when the astropy fitter did not return fit
uncertainties. [1143]

- Changed the default ``recentering_func`` in ``EPSFBuilder``, to
avoid convergence issues. [1144]

- ``photutils.segmentation``

- Fixed an issue where negative Kron radius values could be returned,
which would cause an error when calculating Kron fluxes. [1132]

- Fixed an issue where an error was raised with
``SegmentationImage.remove_border_labels()`` with ``relabel=True``
when no segments remain. [1133]

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

Bug Fixes
^^^^^^^^^

- ``photutils.psf``

- Fixed checks on ``oversampling`` factors. [1086]

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

General
^^^^^^^

- The minimum required python version is 3.6. [952]

- The minimum required astropy version is 4.0. [1081]

- The minimum required numpy version is 1.17. [1079]

- Removed ``astropy-helpers`` and updated the package infrastructure
as described in Astropy APE 17. [915]

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

- ``photutils.aperture``

- Added ``b_in`` as an optional ellipse annulus keyword. [1070]

- Added ``h_in`` as an optional rectangle annulus keyword. [1070]

- ``photutils.background``

- Added ``coverage_mask`` and ``fill_value`` keyword options to
``Background2D``. [1061]

- ``photutils.centroids``

- Added quadratic centroid estimator function
(``centroid_quadratic``). [1067]

- ``photutils.psf``

- Added the ability to use odd oversampling factors in
``EPSFBuilder``. [1076]

- ``photutils.segmentation``

- Added Kron radius, flux, flux error, and aperture to
``SourceProperties``. [1068]

- Added local background to ``SourceProperties``. [1075]

Bug Fixes
^^^^^^^^^

- ``photutils.isophote``

- Fixed a typo in the calculation of the ``b4`` higher-order
harmonic coefficient in ``build_ellipse_model``. [1052]

- Fixed a bug where ``build_ellipse_model`` falls into an infinite
loop when the pixel to fit is outside of the image. [1039]

- Fixed a bug where ``build_ellipse_model`` falls into an infinite
loop under certain image/parameters input combinations. [1056]

- ``photutils.psf``

- Fixed a bug in ``subtract_psf`` caused by using a fill_value of
np.nan with an integer input array. [1062]

- ``photutils.segmentation``

- Fixed a bug where ``source_properties`` would fail with unitless
``gwcs.wcs.WCS`` objects. [1020]

- ``photutils.utils``

- The ``effective_gain`` parameter in ``calc_total_error`` can now
be zero (or contain zero values). [1019]

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

- ``photutils.aperture``

- Aperture pixel positions can no longer be shaped as 2xN. [953]

- Removed the deprecated ``units`` keyword in ``aperture_photometry``
and ``PixelAperture.do_photometry``. [953]

- ``PrimaryHDU``, ``ImageHDU``, and ``HDUList`` can no longer be
input to ``aperture_photometry``. [953]

- Removed the deprecated the Aperture ``mask_area`` method. [953]

- Removed the deprecated Aperture plot keywords ``ax`` and
``indices``. [953]

- ``photutils.background``

- Removed the deprecated ``ax`` keyword in
``Background2D.plot_meshes``. [953]

- ``Background2D`` keyword options can not be input as positional
arguments. [1061]

- ``photutils.centroids``

- ``centroid_1dg``, ``centroid_2dg``, ``gaussian1d_moments``,
``fit_2dgaussian``, and ``GaussianConst2D`` have been moved to a new
``photutils.centroids.gaussian`` module. [1064]

- Deprecated ``fit_2dgaussian`` and ``GaussianConst2D``. [1064]

- ``photutils.datasets``

- Removed the deprecated ``type`` keyword in ``make_noise_image``.
[953]

- Renamed the ``random_state`` keyword (deprecated) to
``seed`` in ``apply_poisson_noise``, ``make_noise_image``,
``make_random_models_table``, and ``make_random_gaussians_table``
functions. [1080]

- ``photutils.detection``

- Removed the deprecated ``snr`` keyword in ``detect_threshold``.
[953]

- ``photutils.psf``

- Added ``flux_residual_sigclip`` as an input parameter, allowing for
custom sigma clipping options in ``EPSFBuilder``. [984]

- Added ``extra_output_cols`` as a parameter to
``BasicPSFPhotometry``, ``IterativelySubtractedPSFPhotometry`` and
``DAOPhotPSFPhotometry``. [745]

- ``photutils.segmentation``

- Removed the deprecated ``SegmentationImage`` methods ``cmap`` and
``relabel``. [953]

- Removed the deprecated ``SourceProperties`` ``values`` and ``coords``
attributes. [953]

- Removed the deprecated ``xmin/ymin`` and ``xmax/ymax`` properties.
[953]

- Removed the deprecated ``snr`` and ``mask_value`` keywords in
``make_source_mask``. [953]

- Renamed the ``random_state`` keyword (deprecated) to ``seed`` in the
``make_cmap`` method. [1080]

- ``photutils.utils``

- Removed the deprecated ``random_cmap``, ``mask_to_mirrored_num``,
``get_version_info``, ``filter_data``, and ``std_blocksum``
functions. [953]

- Removed the deprecated ``wcs_helpers`` functions
``pixel_scale_angle_at_skycoord``, ``assert_angle_or_pixel``,
``assert_angle``, and ``pixel_to_icrs_coords``. [953]

- Deprecated the ``check_random_state`` function. [1080]

- Renamed the ``random_state`` keyword (deprecated) to ``seed`` in the
``make_random_cmap`` function. [1080]

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

Bug Fixes
^^^^^^^^^

- ``photutils.isophote``

- Fixed computation of upper harmonics ``a3``, ``b3``, ``a4``, and
``b4`` in the ellipse fitting algorithm. [1008]

- ``photutils.psf``

- Fix to algorithm in ``EPSFBuilder``, causing issues where ePSFs
failed to build. [974]

- Fix to ``IterativelySubtractedPSFPhotometry`` where an error could
be thrown when a ``Finder`` was passed which did not return
``None`` if no sources were found. [986]

- Fix to ``centroid_epsf`` where the wrong oversampling factor was
used along the y axis. [1002]

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

Bug Fixes
^^^^^^^^^

- ``photutils.psf``

- Fix to ``IterativelySubtractedPSFPhotometry`` where the residual
image was not initialized when ``bkg_estimator`` was not supplied.
[942]

- ``photutils.segmentation``

- Fixed a labeling bug in ``deblend_sources``. [961]

- Fixed an issue in ``source_properties`` when the input ``data``
is a ``Quantity`` array. [963]