CHANGES.rst

3.0.0 (unreleased)

General

• The minimum required NumPy is now 2.0. [#2115]
• The minimum required SciPy is now 1.13. [#2121]
• The minimum required Matplotlib is now 3.9. [#2115]
• The minimum required scikit-image is now 0.23. [#2115]
• The minimum required astropy is now 6.1.4. [#2130]

New Features

• photutils.aperture
  • The to_sky and to_pixel methods for all pixel and sky aperture types now use the local WCS Jacobian to accurately compute pixel scale factors and rotation angles. This correctly handles WCS with distortions (e.g., SIP polynomial corrections) and non-square pixels. [#2240]
• photutils.background
  • Added a to_aperture method to LocalBackground. [#2118]
• photutils.centroids
  • Added a CentroidQuadratic class to provide an object-oriented interface to the centroid_quadratic function. [#2163, #2169]
• photutils.detection
  • Added a public StarFinderCatalogBase class that provides a common base for the catalogs in the DAOStarFinder, IRAFStarFinder, and StarFinder classes. [#2149, #2201]
  • Added __repr__ and __str__ methods to DAOStarFinder, IRAFStarFinder, and StarFinder. [#2201]
  • Significantly improved the performance of DAOStarFinder, IRAFStarFinder, and StarFinder by vectorizing cutout extraction and image moment computation. [#2201]
  • The threshold parameter in DAOStarFinder, IRAFStarFinder, and StarFinder now accepts a 2D array in addition to a scalar value, allowing for spatially varying detection thresholds. [#2202]
  • Added a scale_threshold parameter to DAOStarFinder. When set to False, the input threshold is applied directly to the convolved data without the default kernel-based scaling. [#2202]
  • Added a min_separation keyword to find_peaks. The implementation uses fast separable box filters and is approximately 10-400x faster than using an explicit circular footprint with scipy.ndimage.maximum_filter (depending on the radius), while producing identical results. [#2246]
• photutils.profiles
  • Added a EnsquaredCurveOfGrowth class to compute a curve of growth using concentric square apertures. [#2184]
  • Added a EllipticalCurveOfGrowth class to compute a curve of growth using concentric elliptical apertures with a fixed axis ratio and orientation. [#2184]
  • Added moffat_fit, moffat_profile, and moffat_fwhm properties to RadialProfile for fitting a 1D Moffat model to the radial profile. [#2185]
• photutils.psf
  • Added a SourceGroups class that stores the results of grouping sources and provides methods to analyze and plot the groupings. [#2116]
  • Added remove_invalid and reset_ids keywords to the results_to_init_params and results_to_model_params methods of PSFPhotometry and IterativePSFPhotometry. [#2131]
  • Added a decode_flags convenience method to PSFPhotometry and IterativePSFPhotometry classes to decode the bitwise flags from the results table. [#2132, #2136]
  • Added a return_bit_flags keyword to the decode_psf_flags function. [#2136]
  • Added __repr__ methods to ImagePSF and GriddedPSFModel. [#2134]
  • Added a shape property to ImagePSF. [#2158]
  • EPSFBuilder now automatically excludes stars that repeatedly fail fitting and emits warnings with specific failure reasons. [#2158, #2165]
  • Added validation and automatic shape handling for fit_shape=None in fit_2dgaussian and fit_fwhm. The functions now require explicit fit_shape for multiple sources and emit an informative warning for single-source fitting. [#2164]
  • The fit_fwhm and fit_2dgaussian xypos value can now be input as a zip object. [#2164]
• photutils.psf_matching
  • Added a regularization keyword to make_kernel to regularize division by near-zero values in the source Optical Transfer Function. [#2170, #2171, #2175]
  • Added make_wiener_kernel function that uses Wiener regularization to make a PSF matching kernel. [#2171, #2172, #2175]
  • make_kernel now validates input PSFs (2D, odd dimensions, centered) and the window function output. [#2170]
  • resize_psf now validates input PSFs and pixel scales. [#2170]
  • Added __repr__ methods to CosineBellWindow, HanningWindow, SplitCosineBellWindow, TopHatWindow, and TukeyWindow classes. [#2176]
• photutils.segmentation
  • The SourceCatalog fluxfrac_radius now caches results by fluxfrac value. Repeated calls with the same fluxfrac return the cached result without recomputation. [#2197]
  • The radial step used when searching for a bracketing interval in SourceCatalog fluxfrac_radius is now set to 10% of the current max_radius, bounding the fallback loop to at most ~10 iterations regardless of source size. [#2197]
  • Improved the performance (~6-9x speedup) of SourceCatalog min_value, max_value, segment_flux, segment_flux_err, background_sum, and background_mean. [#2199]
  • Added SegmentationImage get_segment and get_segments methods to return the Segment object(s) for a given label or list of labels. [#2228]
  • Added the ability to input RegionVisual keywords to the SegmentationImage to_regions method. [#2228]
  • Added SegmentationImage get_polygon, get_polygons, get_patch, get_patches, get_region, and get_regions methods to return the polygon, patch, or region for a given segment label or list of labels. [#2232]
  • Improved the performance of the SegmentationImage keep_labels method and missing_labels attribute. [#2234]
  • Improved the performance of SourceCatalog centroid_win (~3.5x speedup), centroid_quad, fluxfrac_radius (~6x speedup), kron_radius (~2x speedup), moments, moments_central, perimeter, and Kron photometry. [#2238]
• photutils.utils
  • Significantly improved the performance (by factors of 3 or more) of ShepardIDWInterpolator [#2187].

Bug Fixes

• photutils.background
  • Fixed Background2D raising AttributeError when passed a function as bkg_estimator or bkgrms_estimator instead of a class instance with a sigma_clip attribute. [#2181]
  • Fixed silent truncation of background estimates when integer input data were provided to Background2D. Integer inputs now produce np.float32 output to preserve precision from interpolation. [#2181]
• photutils.centroids
  • Fixed a bug in centroid_sources where the input error array could be ignored if more than one source was input. [#2179]
• photutils.datasets
  • Fixed a bug in apply_poisson_noise where the returned image could have a different dtype than the input. [#2173]
• photutils.detection
  • Fixed StarFinder mutating the input kernel array during normalization. [#2201]
  • Fixed an edge case of find_peaks not excluding NaN pixel locations from peak detection, which could produce false peaks when the NaN fill value was a local maximum. [#2247]
• photutils.isophote
  • build_ellipse_model now integrates over all angles instead of stopping once it hits the edge of the output image. [#2156]
• photutils.morphology
  • Fixed issues with negative pixel values input to gini. [#2178]
• photutils.profiles
  • Fixed an issue where the mask (input and non-finite values) was not applied to the raw data profile. [#2184]
• photutils.psf
  • PSFPhotometry and IterativePSFPhotometry now handle non-finite (NaN or inf) local background values instead of raising an error. Three new flags have been added to identify sources with non-finite values: flag 512 for non-finite fitted positions, flag 1024 for non-finite fitted flux, and flag 2048 for non-finite local background. [#2131]
  • Fixed a bug in EPSFBuilder where the recentering_boxsize was being applied in oversampled space instead of the original star pixel space. [#2168]
• photutils.segmentation
  • Fixed a bug in SourceCatalog where the (x, y) coordinates were swapped in the map_coordinates call used to interpolate the background at source centroids, causing background_centroid to return incorrect values. [#2198]
  • Fixed an issue in SourceCatalog where incorrect masking behavior could occur when apermask_method='none'. [#2198]
  • Fixed an issue in SourceCatalog where unrealistically large kron_radius values could cause out-of-memory issues. [#2237]

API Changes

• photutils
  • Passing optional arguments positionally to all functions, classes, methods in photutils is now deprecated. In the future, all optional arguments must be passed as keyword arguments. [#2219]
• photutils.aperture
  • The ApertureStats covar_sigx2, covar_sigxy, and covar_sigy2 attributes have been renamed to covariance_xx, covariance_xy, and covariance_yy, respectively. The old names are deprecated. [#2241]
  • The ApertureStats cxx, cxy, and cyy attributes have been renamed to ellipse_cxx, ellipse_cxy, and ellipse_cyy, respectively. The old names are deprecated. [#2241]
  • The ApertureStats data_sumcutout and error_sumcutout attributes have been renamed to data_sum_cutout and error_sum_cutout, respectively. The old names are deprecated. [#2241]
  • The ApertureStats get_id and get_ids methods have been renamed to select_id and select_ids, respectively. The old names are deprecated. [#2241]
  • The ApertureStats semimajor_sigma and semiminor_sigma attributes/columns have been renamed to semimajor_axis and semiminor_axis, respectively. The old names are deprecated. [#2241]
  • The ApertureStats xcentroid and ycentroid attributes/columns have been renamed to x_centroid and y_centroid, respectively. The old names are deprecated. [#2241]
  • The xcenter and ycenter column names in the table returned by aperture_photometry have been renamed to x_center and y_center, respectively. The old names are deprecated. [#2241]
  • The CircularMaskMixin, EllipticalMaskMixin, and RectangularMaskMixin classes are now deprecated. The mask generation is now handled internally by the PixelAperture base class. [#2242]
• photutils.background
  • Removed the deprecated edge_method keyword from Background2D. [#2102]
  • Removed the deprecated background_mesh_masked, background_rms_mesh_masked, and mesh_nmasked properties from Background2D. [#2102]
  • Removed the deprecated grid_mode keyword from BkgZoomInterpolator. [#2102]
  • The interpolator keyword argument for Background2D is now deprecated. When interpolator is eventually removed, the scipy.ndimage.zoom cubic spline interpolator will always be used to resize the low-resolution arrays. The behavior will be identical to the current default. [#2108]
  • The Background2D npixels_mesh and npixels_map properties have been renamed to n_pixels_mesh and n_pixels_map, respectively. The old names are deprecated. [#2241]
  • The BkgIDWInterpolator and BkgZoomInterpolator classes are now deprecated. [#2108]
  • The Background2D bkgrms_estimator keyword argument has been renamed to bkg_rms_estimator. The old name is deprecated. [#2241]
• photutils.centroids
  • The xpeak, ypeak, and search_boxsize keyword arguments for centroid_quadratic are now deprecated. Use centroid_sources to centroid sources at specific positions. [#2160]
• photutils.datasets
  • The get_path, load_spitzer_image, load_spitzer_catalog, and load_star_image functions are now deprecated and will be removed in a future version. [#2135]
• photutils.detection
  • find_peaks now returns a QTable instead of a Table. [#2201]
  • The sharplo and sharphi keyword arguments for DAOStarFinder and IRAFStarFinder are now deprecated. Use the sharpness_range=(lower, upper) tuple keyword instead. Set sharpness_range=None to disable sharpness filtering. [#2216]
  • The roundlo and roundhi keyword arguments for DAOStarFinder and IRAFStarFinder are now deprecated. Use the roundness_range=(lower, upper) tuple keyword instead. Set roundness_range=None to disable roundness filtering. [#2216]
  • The minsep_fwhm keyword argument for IRAFStarFinder is now deprecated. Use min_separation instead. [#2216]
  • The peakmax keyword argument for DAOStarFinder, IRAFStarFinder, and StarFinder is now deprecated. Use peak_max instead. [#2216]
  • The brightest keyword argument for DAOStarFinder, IRAFStarFinder, and StarFinder is now deprecated. Use n_brightest instead. [#2216]
  • The npeaks keyword argument for find_peaks is now deprecated. Use n_peaks instead. [#2241]
  • The default min_separation for DAOStarFinder, IRAFStarFinder, and StarFinder is now None, which computes a default separation of 2.5 * fwhm (or 2.5 * (min(kernel.shape) // 2) for StarFinder) consistent across all three star finders. [#2216]
  • The xcentroid and ycentroid column/attribute names for DAOStarFinder, IRAFStarFinder, and StarFinder catalog classes are deprecated. Use x_centroid and y_centroid instead. The cutout_xcentroid and cutout_ycentroid attributes are also deprecated in favor of cutout_x_centroid and cutout_y_centroid. [#2241]
  • The IRAFStarFinder and StarFinder pa attribute/column has been renamed to orientation. The old name is deprecated. [#2241]
  • The npix column/attribute in DAOStarFinder and IRAFStarFinder catalogs has been renamed to n_pixels. The old name is deprecated. [#2241]
  • The IRAFStarFinder and StarFinder orientation (was pa) values are now always returned as a Quantity array in the range [0, 360) degrees. [#2224, #2225]
• photutils.isophote
  • The Isophote and IsophoteList grad_error and grad_r_error attributes have been renamed to gradient_err and gradient_rel_err, respectively. The old names are deprecated. [#2241]
  • The EllipseSample gradient_error and gradient_relative_error attributes have been renamed to gradient_err and gradient_rel_err, respectively. The old names are deprecated. [#2241]
  • The grad_error and grad_rerror column names in the isophote output table have been renamed to gradient_err and gradient_rel_err, respectively. The old names are deprecated. [#2241]
  • The nclip parameter in Ellipse.fit_image, Ellipse.fit_isophote, and EllipseSample has been renamed to n_clip. The old name is deprecated. [#2241]
  • The Isophote and IsophotList niter, ndata, and nflag attributes have been renamed to n_iter, n_data, and n_flag, respectively. The old names are deprecated. [#2241]
• photutils.profiles
  • Cached Gaussian fits to the radial profile are now automatically invalidated when the profile normalization changes, so the fit is always consistent with the current profile. [#2185]
• photutils.psf
  • The photutils.psf.matching subpackage has been moved to photutils.psf_matching. Importing from the old location is deprecated. [#2167]
  • Removed the deprecated IntegratedGaussianPRF and PRFAdapter classes. [#2103]
  • The grid_from_epsfs helper function is now deprecated. Instead, use GriddedPSFModel directly. [#2111]
  • The EPSFFitter class is now deprecated. Use the fitter, fit_shape, and fitter_maxiters parameters of EPSFBuilder instead. [#2159]
  • Removed the ModelImageMixin class. [#2133]
  • Removed the ModelGridPlotMixin class. [#2137]
  • Removed the norm_radius keyword from EPSFBuilder. [#2158]
  • Removed the deprecated FittableImageModel and EPSFModel classes. Use ImagePSF instead. [#2158]
  • EPSFBuilder now returns an EPSFBuildResult dataclass containing the ePSF, fitted stars, iteration count, convergence status, and excluded star diagnostics. Tuple unpacking is still supported for backward compatibility. [#2158]
  • LinkedEPSFStar no longer inherits from EPSFStars. [#2158]
  • The npixfit column in PSFPhotometry results has been renamed to n_pixels_fit. The old name is deprecated. [#2241]
  • The NPIXFIT_PARTIAL (npixfit_partial) PSF flag has been renamed to N_PIXELS_FIT_PARTIAL (n_pixels_fit_partial). The old name is deprecated. [#2241]
  • The PSFPhotometry and IterativePSFPhotometry localbkg_estimator keyword argument has been renamed to local_bkg_estimator. The old name is deprecated. [#2241]
  • The PSFPhotometry and IterativePSFPhotometry include_localbkg keyword argument in make_model_image and make_residual_image has been renamed to include_local_bkg. The old name is deprecated. [#2241]
• photutils.psf_matching
  • Renamed create_matching_kernel to make_kernel. The old name is deprecated. [#2171]
  • make_kernel now raises ValueError if PSFs are not 2D, have even dimensions, or do not have the same shape. [#2170]
  • resize_psf now raises ValueError if the PSF is not 2D, has even dimensions, or if pixel scales are not positive. [#2170]
  • make_kernel now raises TypeError if the window parameter is not callable. [#2170]
• photutils.segmentation
  • The SourceCatalog orientation property is now always returned in the range [0, 360) degrees. [#2224]
  • The SegmentationImage nlabels, data_ma, deblended_labels_map, and deblended_labels_inverse_map attributes have been renamed to n_labels, data_masked, deblended_label_to_parent, and parent_to_deblended_labels, respectively. The old names are deprecated. [#2241]
  • The Segment data_ma attribute has been renamed to data_masked. The old name is deprecated. [#2241]
  • The SourceCatalog data, error, background, and segment attributes have been renamed to data_cutout, error_cutout, background_cutout, and segment_cutout, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog data_ma, error_ma, background_ma, and segment_ma attributes have been renamed to data_cutout_masked, error_cutout_masked, background_cutout_masked, and segment_cutout_masked, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog convdata and convdata_ma attributes have been renamed to conv_data_cutout and conv_data_cutout_masked, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog cutout_minval_index and cutout_maxval_index attributes have been renamed to cutout_min_value_index and cutout_max_value_index, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog minval_index, maxval_index, minval_xindex, minval_yindex, maxval_xindex, and maxval_yindex attributes have been renamed to min_value_index, max_value_index, min_value_xindex, min_value_yindex, max_value_xindex, and max_value_yindex, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog covar_sigx2, covar_sigxy, and covar_sigy2 attributes/columns have been renamed to covariance_xx, covariance_xy, and covariance_yy, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog cxx, cxy, and cyy attributes/columns have been renamed to ellipse_cxx, ellipse_cxy, and ellipse_cyy, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog segment_fluxerr and kron_fluxerr attributes/columns have been renamed to segment_flux_err and kron_flux_err, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog fluxfrac_radius attribute has been renamed to flux_radius. The old name is deprecated. [#2241]
  • The SourceCatalog get_label and get_labels methods have been renamed to select_label and select_labels, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog add_extra_property, remove_extra_property, remove_extra_properties, and rename_extra_property methods have been renamed to add_property, remove_property, remove_properties, and rename_property, respectively. The extra_properties attribute has been renamed to custom_properties. The old names are deprecated. [#2241]
  • The SourceCatalog nlabels and localbkg_width attributes have been renamed to n_labels and local_bkg_width, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog semimajor_sigma and semiminor_sigma attributes/columns have been renamed to semimajor_axis and semiminor_axis, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog xcentroid, ycentroid, xcentroid_win, ycentroid_win, xcentroid_quad, and ycentroid_quad attributes/columns have been renamed to x_centroid, y_centroid, x_centroid_win, y_centroid_win, x_centroid_quad, and y_centroid_quad, respectively. The old names are deprecated. [#2241]
  • The SourceCatalog segment_img, localbkg_width, apermask_method, and detection_cat keyword arguments have been renamed to segmentation_image, local_bkg_width, aperture_mask_method, and detection_catalog, respectively. The old names are deprecated. [#2241]
  • The SourceFinder npixels, nlevels, and nproc attributes have been renamed to n_pixels, n_levels, and n_processes, respectively. The old names are deprecated. [#2241]
  • The nsigma parameter in detect_threshold has been renamed to n_sigma. The old name is deprecated. [#2241]
  • The npixels parameter in detect_sources has been renamed to n_pixels. The old name is deprecated. [#2241]
  • The segment_img, npixels, nlevels, and nproc parameters in deblend_sources have been renamed to segmentation_image, n_pixels, n_levels, and n_processes, respectively. The old names are deprecated. [#2241]
  • The npixels, nlevels, and nproc parameters in SourceFinder have been renamed to n_pixels, n_levels, and n_processes, respectively. The old names are deprecated. [#2241]
• photutils.utils
  • The ImageDepth nsigma, napers, and niters parameters have been renamed to n_sigma, n_apertures, and n_iters, respectively. The old names are deprecated. The napers_used attribute has also been renamed to n_apertures_used. [#2241]
  • The make_random_cmap ncolors parameter has been renamed to n_colors. The old name is deprecated. [#2241]
  • The ShepardIDWInterpolator reg parameter in __call__ has been renamed to regularization. The old name is deprecated. [#2241]

2.3.0 (2025-09-15)

General

• The minimum required NumPy is now 1.25. [#2043]
• The minimum required SciPy is now 1.11.1. [#2043]
• The minimum required Matplotlib is now 3.8. [#2043]
• The minimum required scikit-image is now 0.21. [#2043]

New Features

• photutils.isophote
  • build_ellipse_model is now Cythonized and considerably faster. [#2046]
  • build_ellipse_model also has an additional optional keyword argument sma_interval, which was previously hardcoded. [#2046]
• photutils.psf
  • PSFPhotometry and IterativePSFPhotometry now raise an error if the input error array contains non-finite or zero values. [#2022]
  • GriddedPSFModel can now be used with a single input ePSF model, which will be equivalent to ImagePSF. [#2034]
  • The finder callable input to PSFPhotometry and IterativePSFPhotometry is no longer restricted to have x and y column names of 'xcentroid' and 'ycentroid'. The allowed column names are now the same as those allowed in the init_params table. [#2072]
  • Added a group_warning_threshold keyword to PSFPhotometry and IterativePSFPhotometry. [#2081]
  • The PSFPhotometry and IterativePSFPhotometry classes no longer fail for invalid sources, defined as those that have no overlap with the input data, are completely masked, or have too few unmasked pixels for a fit. These classes have new flags (64, 128, 256, respectively) for these invalid conditions. [#2084, #2085]
  • The PSFPhotometry and IterativePSFPhotometry classes have new results_to_init_params and results_to_model_params methods for outputting fit results in different formats. [#2084]
  • When using Astropy 7.0+, the PSFPhotometry and IterativePSFPhotometry fitter object now modifies the PSF model in place instead of creating a copy, improving performance and significantly reducing memory usage in some cases. [#2093]
  • PSFPhotometry and IterativePSFPhotometry now return a reduced chi-squared statistic (reduced_chi2 column in the results table). [#2086]
  • The PSF photometry classes now use a dynamically generated "flat" model instead of a compound model for grouped sources. This eliminates recursion limits and significantly reduces memory usage for large groups. [#2100]
• photutils.segmentation
  • An optional array keyword was added to the SourceCatalog make_cutouts method. [#2023]
  • Added a group keyword to the SegmentationImage to_regions method. [#2060, #2065]
  • Added a decode_psf_flags utility function for decoding PSF photometry bit flags. [#2090]
  • Added a PSF_FLAGS object to hold all PSF photometry bit flags in one place. PSF_FLAGS provides readable, named constants for each bit flag and helper utilities for decoding bit flags. [#2091]

Bug Fixes

• photutils.centroids
  • Fixed an issue with the initial Gaussian theta units in centroid_2dg. [#2013]
  • Fixed a corner-case issue where zero-sum arrays with ndim > 2 input to centroid_com would return only two np.nan coordinates instead of matching the dimensionality of the input array. [#2045]
• photutils.datasets
  • Fixed a bug in make_model_image where the output image would not have units in the case where the input params had units and none of the models overlapped the image shape. [#2082]
  • Fixed a bug in make_model_image where an error would be raised if any row in the input parameters table contained non-finite model parameters. Such sources are now silently ignored. [#2083]
• photutils.psf
  • Fixed a bug in fit_2dgaussian and fit_fwhm where the fit would fail if there were NaN values in the input data. [#2030]
  • Fixed the check in GriddedPSFModel for rectangular pixel grids. [#2035]
  • Fixed a bug in PSFPhotometry where the 'group_id' column would be ignored if included in the init_params table. [#2070]
  • Fixed a bug in PSFPhotometry where the output flux_err column would not have units if the input data had units and the flux model parameter was fixed in value. [#2072]
  • Fixed a bug in PSFPhotometry and IterativePSFPhotometry where an error would be raised if the x or y columns in init_params had units. [#2079]
  • Fixed a bug in PSFPhotometry and IterativePSFPhotometry for the boundary conditions where flag=2 would be set. [#2080]
  • Fixed a bug in EPSFBuilder where the output PSF would have the wrong shape if the input stars were non-square cutouts. [#2089, #2092]
  • Fixed a bug in the calculation of the PSFPhotometry and IterativePSFPhotometry qfit and cfit to not include the fit weights. [#2099]
• photutils.segmentation
  • Fixed an issue where a newly-defined extra property of a SourceCatalog with overwrite=True would not be added to the extra_properties attribute. [#2039]
  • Fixed an issue where the SegmentationImage segments attribute would fail if any source segment was non-contiguous. [#2060]

API Changes

• photutils.background
  • An explicit ValueError is now raised if the input data to Background2D contains all non-finite values. [#2062]
• photutils.psf
  • The GriddedPSFModel data and grid_xypos attributes are now read-only. [#2036]
  • The PSFPhotometry fit_param attribute is now deprecated. Use the new results_to_init_params method instead. [#2084]
  • The deprecated PSFPhotometry fit_results attribute has been removed. [#2084]
• photutils.segmentation
  • The SegmentationImage polygons list may now include either Shapely Polygon or MultiPolygon (non-contiguous) objects. [#2060]
  • The SegmentationImage to_patches and plot_patches methods now return matplotlib.patches.PathPatch objects. [#2060]
  • The SegmentationImage to_regions method now returns PolygonPixelRegion regions that have the segment label stored in the object meta dictionary. [#2060]

2.2.0 (2025-02-18)

New Features

• photutils.aperture
  • Add an aperture_to_region function to convert an Aperture object to an astropy Region or Regions object. [#2009]
• photutils.profiles
  • Added data_radius and data_profile attributes to the RadialProfile class for calculating the raw radial profile. [#2001]
• photutils.segmentation
  • Added a to_regions method to SegmentationImage that converts the segment outlines to a regions.Regions object. [#2010]

Bug Fixes

• photutils.segmentation
  • Fixed an issue where the SegmentationImage polygons attribute would raise an error if any source segment contained a hole. [#2005]

API Changes

• photutils.aperture
  • The theta attribute of EllipticalAperture, EllipticalAnnulus, RectangularAperture, and RectangularAnnulus is now always returned as an angular Quantity. [#2008]

2.1.0 (2025-01-06)

General

• The minimum required Python is now 3.11. [#1958]
• The minimum required gwcs is now 0.20. [#1961]

New Features

• photutils.aperture
  • The aperture_photometry output table will now include a sky_center column if wcs is input, even if the input aperture is not a sky aperture. [#1965]
• photutils.datasets
  • A params_map keyword was added to make_model_image to allow a custom mapping between model parameter names and column names in the parameter table. [#1994]
• photutils.detection
  • The find_peaks border_width keyword can now accept two values, indicating the border width along the y and x edges, respectively. [#1957]
• photutils.morphology
  • An optional mask keyword was added to the gini function. [#1979]
• photutils.segmentation
  • Added deblended_labels, deblended_labels_map, and deblended_labels_inverse_map properties to SegmentationImage to identify and map any deblended labels. [#1988]

Bug Fixes

• photutils.segmentation
  • Fixed a bug where the table output from the SourceCatalog to_table method could have column names with a np.str_ representation instead of str representation when using NumPy 2.0+. [#1956]
  • Fixed a bug to ensure that the dtype of the SegmentationImage labels always matches the image dtype. [#1986]
  • Fixed an issue with the source labels after source deblending when using relabel=False. [#1988]

API Changes

• photutils.aperture
  • The xcenter and ycenter columns in the table returned by aperture_photometry no longer have (pixel) units for consistency with other tools. [#1993]
• photutils.detection
  • When exclude_border is set to True in the DAOStarFinder and StarFinder classes, the excluded border region can be different along the x and y edges if the kernel shape is rectangular. [#1957]
  • Detected sources that match interval ends for sharpness, roundness, and maximum peak values (sharplo, sharphi, roundlo, roundhi, and peakmax) are now included in the returned table of detected sources by DAOStarFinder and IRAFStarFinder. [#1978]
  • Detected sources that match the maximum peak value (peakmax) are now included in the returned table of detected sources by StarFinder. [#1990]
• photutils.morphology
  • The gini function now returns zero instead of NaN if the (unmasked) data values sum to zero. [#1979]
• photutils.psf
  • The 'viridis' color map is now the default in the GriddedPSFModel plot_grid method when deltas=True. [#1954]
  • The GriddedPSFModel plot_grid color bar now matches the height of the displayed image. [#1955]

2.0.2 (2024-10-24)

Bug Fixes

• Due to an upstream bug in bottleneck with float32 arrays, bottleneck nan-functions are now used internally only for float64 arrays. Performance may be impacted for computations involving arrays with dtype other than float64. Affected functions are used in the aperture, background, detection, profiles, psf, and segmentation subpackages. This change has no impact if bottleneck is not installed.
• photutils.background
  • Fixed a bug in Background2D where an error would be raised when using the BkgIDWInterpolator interpolator when any mesh was excluded, e.g., due to an input mask. [#1940]
• photutils.detection
  • Fixed a bug in the star finders (DAOStarFinder, IRAFStarFinder, and StarFinder) when exclude_border=True. Also, fixed an issue with exclude_border=True where if all sources were in the border region then an error would be raised. [#1943]

2.0.1 (2024-10-16)

Bug Fixes

• photutils.background
  • Fixed a bug in SExtractorBackground where the dimensionality of the returned value would not be preserved if the output was a single value. [#1934]
  • Fixed an issue in Background2D where if the box_size equals the input array shape, the input data array could be modified. [#1935]

2.0.0 (2024-10-14)

General

• The regions package is now an optional dependency. [#1813]
• The minimum required Astropy is now 5.3. [#1839]
• SciPy is now a required dependency. [#1880]
• The minimum required SciPy is now 1.10. [#1880]
• The minimum required NumPy is now 1.24. [#1881]
• The minimum required Matplotlib is now 3.7. [#1881]
• The minimum required GWCS is now 0.19. [#1881]
• Importing tools from all subpackages now requires including the subpackage name. Also, PSF matching tools must now be imported from photutils.psf.matching instead of photutils.psf. [#1879, #1904]

New Features

• photutils.aperture
  • The metadata in the tables generated by aperture_photometry and ApertureStats now include the aperture name and shape parameters. [#1849]
  • aperture_photometry and ApertureStats now accept supported regions.Region objects, i.e., those corresponding to circular, elliptical, and rectangular apertures. [#1813, #1852]
  • A new region_to_aperture convenience function has been added to convert supported regions.Region objects to Aperture objects. [#1813, #1852]
• photutils.background
  • The Background2D class has been refactored to significantly reduce its memory usage. In some cases, it is also significantly faster. [#1870, #1872, #1873]
  • A new npixels_mesh property was added to Background2D that gives a 2D array of the number of pixels used to compute the statistics in the low-resolution grid. [#1870]
  • A new npixels_map property was added to Background2D that gives a 2D array of the number of pixels used to compute the statistics in each mesh, resized to the shape of the input data. [#1871]
• photutils.centroids
  • Quantity arrays can now be input to centroid_1dg and centroid_2dg. [#1861]
• photutils.datasets
  • Added a new params_table_to_models function to create a list of models from a table of model parameters. [#1896]
• photutils.psf
  • Added new xy_bounds keyword to PSFPhotometry and IterativePSFPhotometry to allow one to bound the x and y model parameters during the fitting. [#1805]
  • The extract_stars function can now accept NDData inputs with uncertainty types other than weights. [#1821]
  • Added new GaussianPSF, CircularGaussianPSF, GaussianPRF, CircularGaussianPRF, and MoffatPSF PSF model classes. [#1838, #1898, #1918]
  • Added new AiryDiskPSF PSF model class. [#1843, #1918]
  • Added new CircularGaussianSigmaPRF PSF model class. [#1845, #1918]
  • The IntegratedGaussianPRF model now supports units. [#1838]
  • A new results attribute was added to PSFPhotometry to store the returned table of fit results. [#1858]
  • Added new fit_fwhm convenience function to estimate the FWHM of one or more sources in an image by fitting a circular 2D Gaussian PSF model. [#1859, #1887, #1899, #1918]
  • Added new fit_2dgaussian convenience function to fit a circular 2D Gaussian PSF to one or more sources in an image. [#1859, #1887, #1899]
  • Added new ImagePSF model class to represent a PSF model as an image. [#1890]
  • The GriddedPSFModel model now has a bounding_box method to return the bounding box of the model. [#1891]
  • The GriddedPSFModel class has been refactored to significantly improve its performance. In typical PSF photometry use cases, it is now about 4 times faster than previous versions. [#1903]
• photutils.segmentation
  • Reduced the memory usage and improved the performance of source deblending with deblend_sources and SourceFinder. [#1924, #1925, #1926]
  • Improved the accuracy of the progress bar in deblend_sources and SourceFinder when using multiprocessing. Also added the source ID label number to the progress bar. [#1925, #1926]

Bug Fixes

• photutils.aperture
  • Fixed a bug checking that the subpixels keyword is a strictly positive integer. [#1816]
• photutils.datasets
  • Fixed an issue in make_model_image where if the bbox_factor was input and the model bounding box did not have a factor keyword then an error would be raised. [#1921]
• photutils.detection
  • Fixed an issue where DAOStarFinder would not return any sources if the input threshold was set to zero due to the flux being non-finite. [#1882]
• photutils.isophote
  • Fixed a bug in build_ellipse_model where if high_harmonics=True, the harmonics were not correctly added to the model. [#1810]
• photutils.psf
  • Fixed a bug in make_psf_model where if the input model had amplitude units, an error would be raised. [#1894]

API Changes

• The sklearn version information has been removed from the meta attribute in output tables. sklearn was removed as an optional dependency in 1.13.0. [#1807]
• photutils.background
  • The Background2D background_mesh and background_rms_mesh properties will have units if the input data has units. [#1870]
  • The Background2D edge_method keyword is now deprecated. When edge_method is eventually removed, the 'pad' option will always be used. [#1870]
  • The Background2D background_mesh_masked, background_rms_mesh_masked, and mesh_nmasked properties are now deprecated. [#1870]
  • To reduce memory usage, Background2D no longer keeps a cached copy of the returned background and background_rms properties. [#1870]
  • The Background2D data, mask, total_mask, nboxes, box_npixels, and nboxes_tot attributes have been removed. [#1870]
  • The BkgZoomInterpolator grid_mode keyword is now deprecated. When grid_mode is eventually removed, the True option will always be used. [#1870]
  • The Background2D background, background_rms, background_mesh, and background_rms_mesh properties now have the same dtype as the input data. [#1922]
• photutils.centroids
  • For consistency with other fitting functions (including PSF fitting), the centroid_1dg and centroid_2dg functions now fit only a 1D or 2D Gaussian model, respectively, excluding any constant component. The input data are required to be background-subtracted. [#1861]
  • The fitter used in centroid_1dg and centroid_2dg was changed from LevMarLSQFitter to TRFLSQFitter. LevMarLSQFitter uses the legacy SciPy function scipy.optimize.leastsq, which is no longer recommended. [#1917]
• photutils.datasets
  • The deprecated make module has been removed. Instead of importing functions from photutils.datasets.make, import functions from photutils.datasets. [#1884]
  • The deprecated make_model_sources_image, make_gaussian_prf_sources_image, make_gaussian_sources_table, make_test_psf_data, make_random_gaussians_table, and make_imagehdu functions have been removed. [#1884]
• photutils.detection
  • The deprecated sky keyword in DAOStarFinder and IRAFStarFinder has been removed. Also, there will no longer be a sky column in the output table. [#1884]
  • The DAOStarFinder flux and mag columns were changed to give sensible values. Previously, the flux value was defined by the original DAOFIND algorithm as a measure of the intensity ratio of the amplitude of the best fitting Gaussian function at the object position to the detection threshold. A daofind_mag column was added for comparison to the original IRAF DAOFIND algorithm. [#1885]
• photutils.isophote
  • The build_ellipse_model function now raises a ValueError if the input isolist is empty. [#1809]
• photutils.profiles
  • The fitter used in RadialProfile to fit the profile with a Gaussian was changed from LevMarLSQFitter to TRFLSQFitter. LevMarLSQFitter uses the legacy SciPy function scipy.optimize.leastsq, which is no longer recommended. [#1899]
• photutils.psf
  • The IntegratedGaussianPRF class now must be initialized using keyword-only arguments. [#1838]
  • The IntegratedGaussianPRF class has been moved to the new functional_models module. [#1838]
  • The models and griddedpsfmodel modules have been renamed to image_models and gridded_models, respectively. [#1838]
  • The IntegratedGaussianPRF model class has been renamed to CircularGaussianPRF. IntegratedGaussianPRF is now deprecated. [#1845]
  • Some PSF tools have moved to new modules. The PRFAdapter class and the make_psf_model and grid_from_epsfs functions have been moved to the new model_helpers module. The make_psf_model_image function has been moved to the new simulations module. It is recommended that all of these tools be imported from photutils.psf without using the submodule name. [#1854, #1901]
  • The PSFPhotometry fit_results attribute has been renamed to fit_info. fit_results is now deprecated. [#1858]
  • The PRFAdapter class has been deprecated. Instead, use a ImagePSF model derived from the discretize_model function in astropy.convolution. [#1865]
  • The FittableImageModel and EPSFModel classes have been deprecated. Instead, use the new ImagePSF model class. [#1890]
  • The default fitter for PSFPhotometry, IterativePSFPhotometry, and EPSFFitter was changed from LevMarLSQFitter to TRFLSQFitter. LevMarLSQFitter uses the legacy SciPy function scipy.optimize.leastsq, which is no longer recommended. [#1899]
  • psf_shape is now an optional keyword in the make_model_image and make_residual_image methods of PSFPhotometry and IterativePSFPhotometry. The value defaults to using the model bounding box to define the shape and is required only if the PSF model does not have a bounding box attribute. [#1921]
• photutils.psf.matching
  • PSF matching tools must now be imported from photutils.psf.matching instead of photutils.psf. [#1904]
• photutils.segmentation
  • The SegmentationImage relabel_consecutive, resassign_label(s), keep_label(s), remove_label(s), remove_border_labels, and remove_masked_labels methods now keep the original dtype of the segmentation image instead of always changing it to int (int64). [#1878, #1923]
  • The detect_sources and deblend_sources functions now return a SegmentationImage instance whose data dtype is np.int32 instead of int (int64) unless more than (2**32 - 1) labels are needed. [#1878]

1.13.0 (2024-06-28)

General

• scikit-learn has been removed as an optional dependency. [#1774]

New Features

• photutils.datasets
  • Added a make_model_image function for generating simulated images with model sources. This function has more options and is significantly faster than the now-deprecated make_model_sources_image function. [#1759, #1790]
  • Added a make_model_params function to make a table of randomly generated model positions, fluxes, or other parameters for simulated sources. [#1766, #1796]
• photutils.detection
  • The find_peaks function now supports input arrays with units. [#1743]
  • The Table returned from find_peaks now has an id column that contains unique integer IDs for each peak. [#1743]
  • The DAOStarFinder, IRAFStarFinder, and StarFinder classes now support input arrays with units. [#1746]
• photutils.profiles
  • Added an unnormalize method to RadialProfile and CurveOfGrowth to return the profile to the state before any normalize calls were run. [#1732]
  • Added calc_ee_from_radius and calc_radius_from_ee methods to CurveOfGrowth. [#1733]
• photutils.psf
  • Added an include_localbkg keyword to the IterativePSFPhotometry make_model_image and make_residual_image methods. [#1756]
  • Added "x_fit", "xfit", "y_fit", "yfit", "flux_fit", and "fluxfit" as allowed column names in the init_params table input to the PSF photometry objects. [#1765]
  • Added a make_psf_model_image function to generate a simulated image from PSF models. [#1785, #1796]
  • PSFPhotometry now has a new fit_params attribute containing a table of the fit model parameters and errors. [#1789]
  • The PSFPhotometry and IterativePSFPhotometry init_params table now allows the user to input columns for model parameters other than x, y, and flux. The column names must match the parameter names in the PSF model. They can also be suffixed with either the "_init" or "_fit" suffix. [#1793]

Bug Fixes

• photutils.aperture
  • Fixed an issue in ApertureStats where in very rare cases the covariance calculation could take a long time. [#1788]
• photutils.background
  • No longer warn about NaNs in the data if those NaNs are masked in coverage_mask passed to Background2D. [#1729]
• photutils.psf
  • Fixed an issue where IterativePSFPhotometry would fail if the input data was a Quantity array. [#1746]
  • Fixed the IntegratedGaussianPRF class bounding_box limits to always be symmetric. [#1754]
  • Fixed an issue where IterativePSFPhotometry could sometimes issue a warning when merging tables if mode='all'. [#1761]
  • Fixed a bug where the first matching column in the init_params table was not used in PSFPhotometry and IterativePSFPhotometry. [#1765]
  • Fixed an issue where IterativePSFPhotometry could sometimes raise an error about non-overlapping data. [#1778]
  • Fixed an issue with unit handling in PSFPhotometry and IterativePSFPhotometry. [#1792]
  • Fixed an issue in IterativePSFPhotometry where the fit_results attribute was not cleared between repeated calls. [#1793]
• photutils.segmentation
  • Fixed an issue in SourceCatalog where in very rare cases the covariance calculation could take a long time. [#1788]

API Changes

• The photutils.test function has been removed. Instead use the pytest --pyargs photutils command. [#1725]
• photutils.datasets
  • The photutils.datasets subpackage has been reorganized and the make module has been deprecated. Instead of importing functions from photutils.datasets.make, import functions from photutils.datasets. [#1726]
  • The make_model_sources_image function has been deprecated in favor of the new make_model_image function. The new function has more options and is significantly faster. [#1759]
  • The randomly-generated optional noise in the simulated example images make_4gaussians_image and make_100gaussians_image is now slightly different. The noise sigma is the same, but the pixel values differ. [#1760]
  • The make_gaussian_prf_sources_image function is now deprecated. Use the make_model_psf_image function or the new make_model_image function instead. [#1762]
  • The make_gaussian_sources_table function now includes an "id" column and always returns both 'flux' and 'amplitude' columns. [#1763]
  • The make_model_sources_table function now includes an "id" column. [#1764]
  • The make_gaussian_sources_table function is now deprecated. Use the make_model_sources_table function instead. [#1764]
  • The make_test_psf_data function is now deprecated. Use the new make_model_psf_image function instead. [#1785]
• photutils.detection
  • The sky keyword in DAOStarFinder and IRAFStarFinder is now deprecated and will be removed in a future version. [#1747]
  • Sources that have non-finite properties (e.g., centroid, roundness, sharpness, etc.) are automatically excluded from the output table in DAOStarFinder, IRAFStarFinder, and StarFinder. [#1750]
• photutils.psf
  • PSFPhotometry and IterativePSFPhotometry now raise a ValueError if the input psf_model is not two-dimensional with n_inputs=2 and n_outputs=1. [#1741]
  • The IntegratedGaussianPRF class bounding_box is now a method instead of an attribute for consistency with Astropy models. The method has a factor keyword to scale the bounding box. The default scale factor is 5.5 times sigma. [#1754]
  • The IterativePSFPhotometry 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. [#1756]
  • IterativePSFPhotometry will now only issue warnings after all iterations are completed. [#1767]
  • The IterativePSFPhotometry psfphot attribute has been removed. Instead, use the fit_results attribute, which contains a list of PSFPhotometry instances for each fit iteration. [#1771]
  • The group_size column has been moved to come immediately after the group_id column in the output table from PSFPhotometry and IterativePSFPhotometry. [#1772]
  • The PSFPhotometry init_params table was moved from the fit_results dictionary to an attribute. [#1773]
  • Removed local_bkg, psfcenter_indices, fit_residuals, npixfit, and nmodels keys from the PSFPhotometry fit_results dictionary. [#1773]
  • Removed the deprecated BasicPSFPhotometry, IterativelySubtractedPSFPhotometry, DAOPhotPSFPhotometry, DAOGroup, DBSCANGroup, and GroupStarsBase, and NonNormalizable classes and the prepare_psf_model, get_grouped_psf_model, and subtract_psf functions. [#1774]
  • A ValueError is now raised if the shape of the error array does not match the data array when calling the PSF-fitting classes. [#1777]
  • The fit_param_errs key was removed from the PSFPhotometry fit_results dictionary. The fit parameter errors are now stored in the fit_params table. [#1789]
  • The cfit column in the PSFPhotometry and IterativePSFPhotometry result table will now be NaN for sources whose initial central pixel is masked. [#1789]

1.12.0 (2024-04-12)

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]

1.11.0 (2024-02-16)

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 PSFPhotometry 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 PSFPhotometry 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]

1.10.0 (2023-11-21)

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]

1.9.0 (2023-08-14)

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]

1.8.0 (2023-05-17)

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]

1.7.0 (2023-04-05)

General

• The rasterio and shapely packages are now optional dependencies. [#1509]

New Features

• photutils.aperture
  • Significantly improved the performance of aperture_photometry and the PixelAperture do_photometry method for large arrays. [#1485]
  • Significantly improved the performance of the PixelAperture area_overlap method, especially for large arrays. [#1490]
• photutils.profiles
  • Added a new profiles subpackage containing RadialProfile and CurveOfGrowth classes. [#1494, #1496, #1498, #1499]
• photutils.psf
  • Significantly improved the performance of evaluating and fitting GriddedPSFModel instances. [#1503]
• photutils.segmentation
  • Added a size keyword to the SegmentationImage make_source_mask method. [#1506]
  • Significantly improved the performance of SegmentationImage make_source_mask when using square footprints for source dilation. [#1506]
  • Added the polygons property and to_patches and plot_patches methods to SegmentationImage. [#1509]
  • Added polygon keyword to the Segment class. [#1509]

Bug Fixes

• photutils.centroids
  • Fixed an issue where centroid_quadratic would sometimes fail if the input data contained NaNs. [#1495]
• photutils.detection
  • Fixed an issue with the starfinders (DAOStarFinder, IRAFStarFinder, and StarFinder) where an exception was raised if exclude_border=True and there were no detections. [#1512].
• photutils.isophote
  • Fixed a bug where the upper harmonics (a3, a4, b3, and b4) had the incorrect sign. [#1501]
  • Fixed a bug in the calculation of the upper harmonic errors (a3_err, a4_err, b3_err, and b4_err). [#1501].
• photutils.psf
  • Fixed an issue where the PSF-photometry progress bar was not shown. [#1517]
  • Fixed an issue where all PSF uncertainties were excluded if the last star group had no covariance matrix. [#1519]
• photutils.utils
  • Fixed a bug in the calculation of ImageCutout xyorigin when using the 'partial' mode when the cutout extended beyond the right or top edge. [#1508]

API Changes

• photutils.aperture
  • The ApertureStats local_bkg keyword can now be broadcast for apertures with multiple positions. [#1504]
• photutils.centroids
  • The centroid_sources function will now raise an error if the cutout mask contains all True values. [#1516]
• photutils.datasets
  • Removed the deprecated load_fermi_image function. [#1479]
• photutils.psf
  • Removed the deprecated sandbox classes DiscretePRF and Reproject. [#1479]
• photutils.segmentation
  • Removed the deprecated make_source_mask function in favor of the SegmentationImage.make_source_mask method. [#1479]
  • The SegmentationImage imshow method now uses "nearest" interpolation instead of "none" to avoid rendering issues with some backends. [#1507]
  • The repr() notebook output for the Segment class now includes a SVG polygon representation of the segment if the rasterio and shapely packages are installed. [#1509]
  • Deprecated the SegmentationImage outline_segments method. Use the plot_patches method instead. [#1509]

1.6.0 (2022-12-09)

General

• Following NEP 29, the minimum required Numpy is now 1.20. [#1442]
• The minimum required Matplotlib is now 3.3.0. [#1442]
• The minimum required scikit-image is now 0.18.0. [#1442]
• The minimum required scikit-learn is now 1.0. [#1442]

New Features

• photutils.aperture
  • The ApertureStats class now accepts astropy NDData objects as input. [#1409]
  • Improved the performance of aperture photometry by 10-25% (depending on the number of aperture positions). [#1438]
• photutils.psf
  • Added a progress bar for fitting PSF photometry [#1426]
  • Added a subshape keyword to the PSF-fitting classes to define the shape over which the PSF is subtracted. [#1477]
• photutils.segmentation
  • Added the ability to slice SegmentationImage objects. [#1413]
  • Added mode and fill_value keywords to SourceCatalog make_cutouts method. [#1420]
  • Added segment_area source property and wcs, localbkg_width, apermask_method, and kron_params attributes to SourceCatalog. [#1425]
  • Added the ability to use Quantity arrays with detect_threshold, detect_sources, deblend_sources, and SourceFinder. [#1436]
  • The progress bar used when deblending sources now is prepended with "Deblending". [#1439]
  • Added "windowed" centroids to SourceCatalog. [#1447, #1468]
  • Added quadratic centroids to SourceCatalog. [#1467, #1469]
  • Added a progress_bar option to SourceCatalog for displaying progress bars when calculating some source properties. [#1471]
• photutils.utils
  • Added xyorigin attribute to CutoutImage. [#1419]
  • Added ImageDepth class. [#1434]

Bug Fixes

• photutils.aperture
  • Fixed a bug in the PixelAperture area_overlap method so that the returned value does not inherit the data units. [#1408]
  • Fixed an issue in ApertureStats get_ids for the case when the ID numbers are not sorted (due to slicing). [#1423]
• photutils.datasets
  • Fixed a bug in the various load functions where FITS files were not closed. [#1455]
• photutils.segmentation
  • Fixed an issue in the SourceCatalog kron_photometry, make_kron_apertures, and plot_kron_apertures methods where the input minimum Kron and circular radii would not be applied. Instead the instance-level minima would always be used. [#1421]
  • Fixed an issue where the SourceCatalog plot_kron_apertures method would raise an error for a scalar SourceCatalog. [#1421]
  • Fixed an issue in SourceCatalog get_labels for the case when the labels are not sorted (due to slicing). [#1423]

API Changes

• Deprecated axes keyword in favor of ax for consistency with other packages. [#1432]
• Importing tools from all subpackages now requires including the subpackage name.
• photutils.aperture
  • Inputting PixelAperture positions as an Astropy Quantity in pixel units is no longer allowed. [#1398]
  • Inputting SkyAperture shape parameters as an Astropy Quantity in pixel units is no longer allowed. [#1398]
  • Removed the deprecated BoundingBox as_patch method. [#1462]
• photutils.centroids
  • Removed the deprecated oversampling keyword in centroid_com. [#1398]
• photutils.datasets
  • Deprecated the load_fermi_image function. [#1455]
• photutils.psf
  • Removed the deprecated flux_residual_sigclip keyword in EPSFBuilder. Use sigma_clip instead. [#1398]
  • PSF photometry classes will no longer emit a RuntimeWarning if the fitted parameter variance is negative. [#1458]
• photutils.segmentation
  • Removed the deprecated sigclip_sigma and sigclip_iters keywords in detect_threshold. Use the sigma_clip keyword instead. [#1398]
  • Removed the mask_value, sigclip_sigma, and sigclip_iters keywords in detect_threshold. Use the mask or sigma_clip keywords instead. [#1398]
  • Removed the deprecated the filter_fwhm and filter_size keywords in make_source_mask. Use the kernel keyword instead. [#1398]
  • If detection_cat is input to SourceCatalog, then the detection catalog source centroids and morphological/shape properties will be returned instead of calculating them from the input data. Also, if detection_cat is input, then the input wcs, apermask_method, and kron_params keywords will be ignored. [#1425]

1.5.0 (2022-07-12)

General

• Added tqdm as an optional dependency. [#1364]

New Features

• photutils.psf
  • Added a mask keyword when calling the PSF-fitting classes. [#1350, #1351]
  • The EPSFBuilder progress bar will use tqdm if the optional package is installed. [#1367]
• photutils.segmentation
  • Added SourceFinder class, which is a convenience class combining detect_sources and deblend_sources. [#1344]
  • Added a sigma_clip keyword to detect_threshold. [#1354]
  • Added a make_source_mask method to SegmentationImage. [#1355]
  • Added a make_2dgaussian_kernel convenience function. [#1356]
  • Allow SegmentationImage.make_cmap background_color to be in any matplotlib color format. [#1361]
  • Added an imshow convenience method to SegmentationImage. [#1362]
  • Improved performance of deblend_sources. [#1364]
  • Added a progress_bar keyword to deblend_sources. [#1364]
  • Added a 'sinh' mode to deblend_sources. [#1368]
  • Improved the resetting of cached SegmentationImage properties so that custom (non-cached) attributes can be kept. [#1368]
  • Added a nproc keyword to enable multiprocessing in deblend_sources and SourceFinder. [#1372]
  • Added a make_cutouts method to SourceCatalog for making custom-shaped cutout images. [#1376]
  • Added the ability to set a minimum unscaled Kron radius in SourceCatalog. [#1381]
• photutils.utils
  • Added a circular_footprint convenience function. [#1355]
  • Added a CutoutImage class. [#1376]

Bug Fixes

• photutils.psf
  • Fixed a warning message in EPSFFitter. [#1382]
• photutils.segmentation
  • Fixed an issue in generating watershed markers used for source deblending. [#1383]

API Changes

• photutils.centroids
  • Changed the axes order of oversampling keyword in centroid_com when input as a tuple. [#1358]
  • Deprecated the oversampling keyword in centroid_com. [#1377]
• photutils.psf
  • Invalid data values (i.e., NaN or inf) are now automatically masked when performing PSF fitting. [#1350]
  • Deprecated the sandbox classes DiscretePRF and Reproject. [#1357]
  • Changed the axes order of oversampling keywords when input as a tuple. [#1358]
  • Removed the unused shift_val keyword in EPSFBuilder and EPSFModel. [#1377]
  • Renamed the flux_residual_sigclip keyword (now deprecated) to sigma_clip in EPSFBuilder. [#1378]
  • The EPSFBuilder progress bar now requires that the optional tqdm package be installed. [#1379]
  • The tools in the PSF package now require keyword-only arguments. [#1386]
• photutils.segmentation
  • Removed the deprecated circular_aperture method from SourceCatalog. [#1329]
  • The SourceCatalog plot_kron_apertures method now sets a default kron_apers value. [#1346]
  • deblend_sources no longer allows an array to be input as a segmentation image. It must be a SegmentationImage object. [#1347]
  • SegmentationImage no longer allows array-like input. It must be a numpy ndarray. [#1347]
  • Deprecated the sigclip_sigma and sigclip_iters keywords in detect_threshold. Use the sigma_clip keyword instead. [#1354]
  • Deprecated the make_source_mask function in favor of the SegmentationImage.make_source_mask method. [#1355]
  • Deprecated the kernel keyword in detect_sources and deblend_sources. Instead, if filtering is desired, input a convolved image directly into the data parameter. [#1365]
  • Sources with a data minimum of zero are now treated the same as negative minima (i.e., the mode is changed to "linear") for the "exponential" deblending mode. [#1368]
  • A single warning (as opposed to 1 per source) is now raised about negative/zero minimum data values using the 'exponential' deblending mode. The affected labels is available in a new "info" attribute. [#1368]
  • If the mode in deblend_sources is "exponential" or "sinh" and there are too many potential deblended sources within a given source (watershed markers), a warning will be raised and the mode will be changed to "linear". [#1369]
  • The SourceCatalog make_circular_apertures and make_kron_apertures methods now return a single aperture (instead of a list with one item) for a scalar SourceCatalog. [#1376]
  • The SourceCatalog kron_params keyword now has an optional third item representing the minimum circular radius. [#1381]
  • The SourceCatalog kron_radius is now set to the minimum Kron radius (the second element of kron_params) if the data or radially weighted data sum to zero. [#1381]
• photutils.utils
  • The colormap returned from make_random_cmap now has colors in RGBA format. [#1361]

1.4.0 (2022-03-25)

General

• The minimum required Python is now 3.8. [#1279]
• The minimum required Numpy is now 1.18. [#1279]
• The minimum required Astropy is now 5.0. [#1279]
• The minimum required Matplotlib is now 3.1. [#1279]
• The minimum required scikit-image is now 0.15.0 [#1279]
• The minimum required gwcs is now 0.16.0 [#1279]

New Features

• photutils.aperture
  • Added a copy method to Aperture objects. [#1304]
  • Added the ability to compare Aperture objects for equality. [#1304]
  • The theta keyword for EllipticalAperture, EllipticalAnnulus, RectangularAperture, and RectangularEllipse can now be an Astropy Angle or Quantity in angular units. [#1308]
  • Added an ApertureStats class for computing statistics of unmasked pixels within an aperture. [#1309, #1314, #1315, #1318]
  • Added a dtype keyword to the ApertureMask to_image method. [#1320]
• photutils.background
  • Added an alpha keyword to the Background2D.plot_meshes method. [#1286]
  • Added a clip keyword to the BkgZoomInterpolator class. [#1324]
• photutils.segmentation
  • Added SegmentationImage cmap attribute containing a default colormap. [#1319]
  • Improved the performance of SegmentationImage and SourceCatalog, especially for large data arrays. [#1320]
  • Added a convolved_data keyword to SourceCatalog. This is recommended instead of using the kernel keyword. [#1321]

Bug Fixes

• photutils.aperture
  • Fixed a bug in aperture_photometry where an error was not raised if the data and error arrays have different units. [#1285].
• photutils.background
  • Fixed a bug in Background2D where using the pad edge method would result in incorrect image padding if only one of the axes needed padding. [#1292]
• photutils.centroids
  • Fixed a bug in centroid_sources where setting error, xpeak, or ypeak to None would result in an error. [#1297]
  • Fixed a bug in centroid_quadratic where inputting a mask would alter the input data array. [#1317]
• photutils.segmentation
  • Fixed a bug in SourceCatalog where a UFuncTypeError would be raised if the input data had an integer dtype [#1312].

API Changes

• photutils.aperture
  • A ValueError is now raised if non-positive sizes are input to sky-based apertures. [#1295]
  • The BoundingBox.plot() method now returns a matplotlib.patches.Patch object. [#1305]
  • Inputting PixelAperture positions as an Astropy Quantity in pixel units is deprecated. [#1310]
  • Inputting SkyAperture shape parameters as an Astropy Quantity in pixel units is deprecated. [#1310]
• photutils.background
  • Removed the deprecated background_mesh_ma and background_rms_mesh_ma Background2D properties. [#1280]
  • By default, BkgZoomInterpolator uses clip=True to prevent the interpolation from producing values outside the given input range. If backwards-compatibility is needed with older Photutils versions, set clip=False. [#1324]
• photutils.centroids
  • Removed the deprecated centroid_epsf and gaussian1d_moments functions. [#1280]
  • Importing tools from the centroids subpackage now requires including the subpackage name. [#1280]
• photutils.morphology
  • Importing tools from the morphology subpackage now requires including the subpackage name. [#1280]
• photutils.segmentation
  • Removed the deprecated source_properties function and the SourceProperties and LegacySourceCatalog classes. [#1280]
  • Removed the deprecated the filter_kernel keyword in the detect_sources, deblend_sources, and make_source_mask functions. [#1280]
  • A TypeError is raised if the input array to SegmentationImage does not have integer type. [#1319]
  • A SegmentationImage may contain an array of all zeros. [#1319]
  • Deprecated the mask_value keyword in detect_threshold. Use the mask keyword instead. [#1322]
  • Deprecated the filter_fwhm and filter_size keywords in make_source_mask. Use the kernel keyword instead. [#1322]

1.3.0 (2021-12-21)

General

• The metadata in output tables now contains version information for all dependencies. [#1274]

New Features

• photutils.centroids
  • Extra keyword arguments can be input to centroid_sources that are then passed on to the centroid_func if supported. [#1276, #1278]
• photutils.segmentation
  • Added copy method to SourceCatalog. [#1264]
  • Added kron_photometry method to SourceCatalog. [#1264]
  • Added add_extra_property, remove_extra_property, remove_extra_properties, and rename_extra_property methods and extra_properties attribute to SourceCatalog. [#1264, #1268]
  • Added name and overwrite keywords to SourceCatalog circular_photometry and fluxfrac_radius methods. [#1264]
  • SourceCatalog fluxfrac_radius was improved for cases where the source flux doesn't monotonically increase with increasing radius. [#1264]
  • Added meta and properties attributes to SourceCatalog. [#1268]
  • The SourceCatalog output table (using to_table) meta dictionary now includes a field for the date/time. [#1268]
  • Added SourceCatalog make_kron_apertures method. [#1268]
  • Added SourceCatalog plot_circular_apertures and plot_kron_apertures methods. [#1268]

Bug Fixes

• photutils.segmentation
  • If detection_catalog is input to SourceCatalog then the detection centroids are used to calculate the circular_aperture, circular_photometry, and fluxfrac_radius. [#1264]
  • Units are applied to SourceCatalog circular_photometry output if the input data has units. [#1264]
  • SourceCatalog circular_photometry returns scalar values if catalog is scalar. [#1264]
  • SourceCatalog fluxfrac_radius returns a Quantity with pixel units. [#1264]
  • Fixed a bug where the SourceCatalog detection_catalog was not indexed/sliced when SourceCatalog was indexed/sliced. [#1268]
  • SourceCatalog circular_photometry now returns NaN for completely-masked sources. [#1268]
  • SourceCatalog kron_flux is always NaN for sources where kron_radius is NaN. [#1268]
  • SourceCatalog fluxfrac_radius now returns NaN if kron_flux is zero. [#1268]

API Changes

• photutils.centroids
  • A ValueError is now raised in centroid_sources if the input xpos or ypos is outside of the input data. [#1276]
  • A ValueError is now raised in centroid_quadratic if the input xpeak or ypeak is outside of the input data. [#1276]
  • NaNs are now returned from centroid_sources where the centroid failed. This is usually due to a box_size that is too small when using a fitting-based centroid function. [#1276]
• photutils.segmentation
  • Renamed the SourceCatalog circular_aperture method to make_circular_apertures. The old name is deprecated. [#1268]
  • The SourceCatalog kron_params keyword must have a minimum circular radius that is greater than zero. The default value is now 1.0. [#1268]
  • detect_sources now uses astropy.convolution.convolve, which allows for masking pixels. [#1269]

1.2.0 (2021-09-23)

General

• The minimum required scipy version is 1.6.0 [#1239]

New Features

• photutils.aperture
  • Added a mask keyword to the area_overlap method. [#1241]
• photutils.background
  • Improved the performance of Background2D by up to 10-50% when the optional bottleneck package is installed. [#1232]
  • Added a masked keyword to the background classes MeanBackground, MedianBackground, ModeEstimatorBackground, MMMBackground, SExtractorBackground, BiweightLocationBackground, StdBackgroundRMS, MADStdBackgroundRMS, and BiweightScaleBackgroundRMS. [#1232]
  • Enable all background classes to work with Quantity inputs. [#1233]
  • Added a markersize keyword to the Background2D method plot_meshes. [#1234]
  • Added __repr__ methods to all background classes. [#1236]
  • Added a grid_mode keyword to BkgZoomInterpolator. [#1239]
• photutils.detection
  • Added a xycoords keyword to DAOStarFinder and IRAFStarFinder. [#1248]
• photutils.psf
  • Enabled the reuse of an output table from BasicPSFPhotometry and its subclasses as an initial guess for another photometry run. [#1251]
  • Added the ability to skip the group_maker step by inputing an initial guess table with a group_id column. [#1251]

Bug Fixes

• photutils.aperture
  • Fixed a bug when converting between pixel and sky apertures with a gwcs object. [#1221]
• photutils.background
  • Fixed an issue where Background2D could fail when using the 'pad' edge method. [#1227]
• photutils.detection
  • Fixed the DAOStarFinder import deprecation message. [#1195]
• photutils.morphology
  • Fixed an issue in data_properties where a scalar background input would raise an error. [#1198]
• photutils.psf
  • Fixed an issue in prepare_psf_model when xname or yname was None where the model offsets were applied in the wrong direction, resulting in the initial photometry guesses not being improved by the fit. [#1199]
• photutils.segmentation
  • Fixed an issue in SourceCatalog where the user-input mask was ignored when apermask_method='correct' for Kron-related calculations. [#1210]
  • Fixed an issue in SourceCatalog where the segment array could incorrectly have units. [#1220]
• photutils.utils
  • Fixed an issue in ShepardIDWInterpolator to allow its initialization with scalar data values and coordinate arrays having more than one dimension. [#1226]

API Changes

• photutils.aperture
  • The ApertureMask.get_values() function now returns an empty array if there is no overlap with the data. [#1212]
  • Removed the deprecated BoundingBox.slices and PixelAperture.bounding_boxes attributes. [#1215]
• photutils.background
  • Invalid data values (i.e., NaN or inf) are now automatically masked in Background2D. [#1232]
  • The background classes MeanBackground, MedianBackground, ModeEstimatorBackground, MMMBackground, SExtractorBackground, BiweightLocationBackground, StdBackgroundRMS, MADStdBackgroundRMS, and BiweightScaleBackgroundRMS now return by default a numpy.ndarray with np.nan values representing masked pixels instead of a masked array. A masked array can be returned by setting masked=True. [#1232]
  • Deprecated the Background2D attributes background_mesh_ma and background_rms_mesh_ma. They have been renamed to background_mesh_masked and background_rms_mesh_masked. [#1232]
  • By default, BkgZoomInterpolator now uses grid_mode=True. For zooming 2D images, this keyword should be set to True, which makes the interpolator's behavior consistent with scipy.ndimage.map_coordinates, skimage.transform.resize, and OpenCV (cv2.resize). If backwards-compatibility is needed with older Photutils versions, set grid_mode=False. [#1239]
• photutils.centroids
  • Deprecated the gaussian1d_moments and centroid_epsf functions. [#1240]
• photutils.datasets
  • Removed the deprecated random_state keyword in the apply_poisson_noise, make_noise_image, make_random_models_table, and make_random_gaussians_table functions. [#1244]
  • make_random_models_table and make_random_gaussians_table now return an astropy QTable with version metadata. [#1247]
• photutils.detection
  • DAOStarFinder, IRAFStarFinder, and find_peaks now return an astropy QTable with version metadata. [#1247]
  • The StarFinder label column was renamed to id for consistency with the other star finder classes. [#1254]
• photutils.isophote
  • The Isophote to_table method nows return an astropy QTable with version metadata. [#1247]
• photutils.psf
  • BasicPSFPhotometry, IterativelySubtractedPSFPhotometry, and DAOPhotPSFPhotometry now return an astropy QTable with version metadata. [#1247]
• photutils.segmentation
  • Deprecated the filter_kernel keyword in the detect_sources, deblend_sources, and make_source_mask functions. It has been renamed to simply kernel for consistency with SourceCatalog. [#1242]
  • Removed the deprecated random_state keyword in the make_cmap method. [#1244]
  • The SourceCatalog to_table method nows return an astropy QTable with version metadata. [#1247]
• photutils.utils
  • Removed the deprecated check_random_state function. [#1244]
  • Removed the deprecated random_state keyword in the make_random_cmap function. [#1244]

1.1.0 (2021-03-20)

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]

1.0.2 (2021-01-20)

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]

1.0.1 (2020-09-24)

Bug Fixes

• photutils.psf
  • Fixed checks on oversampling factors. [#1086]

1.0.0 (2020-09-22)

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]

0.7.2 (2019-12-09)

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]

0.7.1 (2019-10-09)

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]

0.7 (2019-08-14)

General

• Any WCS object that supports the astropy shared interface for WCS is now supported. [#899]
• Added a new photutils.__citation__ and photutils.__bibtex__ attributes which give a citation for photutils in bibtex format. [#926]

New Features

• photutils.aperture
  • Added parameter validation for all aperture classes. [#846]
  • Added from_float, as_artist, union and intersection methods to BoundingBox class. [#851]
  • Added shape and isscalar properties to Aperture objects. [#852]
  • Significantly improved the performance (~10-20 times faster) of aperture photometry, especially when using errors and Quantity inputs with many aperture positions. [#861]
  • aperture_photometry now supports NDData with StdDevUncertainty to input errors. [#866]
  • The mode keyword in the to_sky and to_pixel aperture methods was removed to implement the shared WCS interface. All WCS transforms now include distortions (if present). [#899]
• photutils.datasets
  • Added make_gwcs function to create an example gwcs.wcs.WCS object. [#871]
• photutils.isophote
  • Significantly improved the performance (~5 times faster) of ellipse fitting. [#826]
  • Added the ability to individually fix the ellipse-fitting parameters. [#922]
• photutils.psf
  • Added new centroiding function centroid_epsf. [#816]
• photutils.segmentation
  • Significantly improved the performance of relabeling in segmentation images (e.g., remove_labels, keep_labels). [#810]
  • Added new background_area attribute to SegmentationImage. [#825]
  • Added new data_ma attribute to Segment. [#825]
  • Added new SegmentationImage methods: find_index, find_indices, find_areas, check_label, keep_label, remove_label, and reassign_labels. [#825]
  • Added __repr__ and __str__ methods to SegmentationImage. [#825]
  • Added slices, indices, and filtered_data_cutout_ma attributes to SourceProperties. [#858]
  • Added __repr__ and __str__ methods to SourceProperties and SourceCatalog. [#858]
  • Significantly improved the performance of calculating the background_at_centroid property in SourceCatalog. [#863]
  • The default output table columns (source properties) are defined in a publicly-accessible variable called photutils.segmentation.properties.DEFAULT_COLUMNS. [#863]
  • Added the gini source property representing the Gini coefficient. [#864]
  • Cached (lazy) properties can now be reset in SegmentationImage subclasses. [#916]
  • Significantly improved the performance of deblend_sources. It is ~40-50% faster for large images (e.g., 4k x 4k) with a few thousand of sources. [#924]
• photutils.utils
  • Added NoDetectionsWarning class. [#836]

Bug Fixes

• photutils.aperture
  • Fixed an issue where the ApertureMask.cutout method would drop the data units when copy=True. [#842]
  • Fixed a corner-case issue where aperture photometry would return NaN for non-finite data values outside the aperture but within the aperture bounding box. [#843]
  • Fixed an issue where the celestial_center column (for sky apertures) would be a length-1 array containing a SkyCoord object instead of a length-1 SkyCoord object. [#844]
• photutils.isophote
  • Fixed an issue where the linear fitting mode was not working. [#912]
  • Fixed the radial gradient computation [#934].
• photutils.psf
  • Fixed a bug in the EPSFStar register_epsf and compute_residual_image computations. [#885]
  • A ValueError is raised if aperture_radius is not input and cannot be determined from the input psf_model. [#903]
  • Fixed normalization of ePSF model, now correctly normalizing on undersampled pixel grid. [#817]
• photutils.segmentation
  • Fixed an issue where deblend_sources could fail for sources with labels that are a power of 2 and greater than 255. [#806]
  • SourceProperties and source_properties will no longer raise an exception if a source is completely masked. [#822]
  • Fixed an issue in SourceProperties and source_properties where inf values in the data array were not automatically masked. [#822]
  • error and background arrays are now always masked identically to the input data. [#822]
  • Fixed the perimeter property to take into account the source mask. [#822]
  • Fixed the background_at_centroid source property to use bilinear interpolation. [#822]
  • Fixed SegmentationImage outline_segments to include outlines along the image boundaries. [#825]
  • Fixed SegmentationImage.is_consecutive to return True only if the labels are consecutive and start with label=1. [#886]
  • Fixed a bug in deblend_sources where sources could be deblended too much when connectivity=8. [#890]
  • Fixed a bug in deblend_sources where the contrast parameter had little effect if the original segment contained three or more sources. [#890]
• photutils.utils
  • Fixed a bug in filter_data where units were dropped for data Quantity objects. [#872]

API Changes

• photutils.aperture
  • Deprecated inputting aperture pixel positions shaped as 2xN. [#847]
  • Renamed the celestial_center column to sky_center in the aperture_photometry output table. [#848]
  • Aperture objects defined with a single (x, y) position (input as 1D) are now considered scalar objects, which can be checked with the new isscalar Aperture property. [#852]
  • Non-scalar Aperture objects can now be indexed, sliced, and iterated. [#852]
  • Scalar Aperture objects now return scalar positions and bounding_boxes properties and its to_mask method returns an ApertureMask object instead of a length-1 list containing an ApertureMask. [#852]
  • Deprecated the Aperture mask_area method. [#853]
  • Aperture area is now an attribute instead of a method. [#854]
  • The Aperture plot keyword ax was deprecated and renamed to axes. [#854]
  • Deprecated the units keyword in aperture_photometry and the PixelAperture.do_photometry method. [#866, #861]
  • Deprecated PrimaryHDU, ImageHDU, and HDUList inputs to aperture_photometry. [#867]
  • The aperture_photometry function moved to a new photutils.aperture.photometry module. [#876]
  • Renamed the bounding_boxes attribute for pixel-based apertures to bbox for consistency. [#896]
  • Deprecated the BoundingBox as_patch method (instead use as_artist). [#851]
• photutils.background
  • The Background2D plot_meshes keyword ax was deprecated and renamed to axes. [#854]
• photutils.datasets
  • The make_noise_image type keyword was deprecated and renamed to distribution. [#877]
• photutils.detection
  • Removed deprecated subpixel keyword for find_peaks. [#835]
  • DAOStarFinder, IRAFStarFinder, and find_peaks now return None if no source/peaks are found. Also, for this case a NoDetectionsWarning is issued. [#836]
  • Renamed the snr (deprecated) keyword to nsigma in detect_threshold. [#917]
• photutils.isophote
  • Isophote central values and intensity gradients are now returned to the output table. [#892]
  • The EllipseSample update method now needs to know the fix/fit state of each individual parameter. This can be passed to it via a Geometry instance, e.g., update(geometry.fix). [#922]
• photutils.psf
  • FittableImageModel and subclasses now allow for different oversampling factors to be specified in the x and y directions. [#834]
  • Removed pixel_scale keyword from EPSFStar, EPSFBuilder, and EPSFModel. [#815]
  • Added oversampling keyword to centroid_com. [#816]
  • Removed deprecated Star, Stars, and LinkedStar classes. [#894]
  • Removed recentering_boxsize and center_accuracy keywords and added norm_radius and shift_value keywords in EPSFBuilder. [#817]
  • Added norm_radius and shift_value keywords to EPSFModel. [#817]
• photutils.segmentation
  • Removed deprecated SegmentationImage attributes data_masked, max, and is_sequential and methods area and relabel_sequential. [#825]
  • Renamed SegmentationImage methods cmap (deprecated) to make_cmap and relabel (deprecated) to reassign_label. The new reassign_label method gains a relabel keyword. [#825]
  • The SegmentationImage segments and slices attributes now have the same length as labels (no None placeholders). [#825]
  • detect_sources now returns None if no sources are found. Also, for this case a NoDetectionsWarning is issued. [#836]
  • The SegmentationImage input data array must contain at least one non-zero pixel and must not contain any non-finite values. [#836]
  • A ValueError is raised if an empty list is input into SourceCatalog or no valid sources are defined in source_properties. [#836]
  • Deprecated the values and coords attributes in SourceProperties. [#858]
  • Deprecated the unused mask_value keyword in make_source_mask. [#858]
  • The bbox property now returns a BoundingBox instance. [#863]
  • The xmin/ymin and xmax/ymax properties have been deprecated with the replacements having a bbox_ prefix (e.g., bbox_xmin). [#863]
  • The orientation property is now returned as a Quantity instance in units of degrees. [#863]
  • Renamed the snr (deprecated) keyword to nsigma in make_source_mask. [#917]
• photutils.utils
  • Renamed random_cmap to make_random_cmap. [#825]
  • Removed deprecated cutout_footprint function. [#835]
  • Deprecated the wcs_helpers functions pixel_scale_angle_at_skycoord, assert_angle_or_pixel, assert_angle, and pixel_to_icrs_coords. [#846]
  • Removed deprecated interpolate_masked_data function. [#895]
  • Deprecated the mask_to_mirrored_num function. [#895]
  • Deprecated the get_version_info, filter_data, and std_blocksum functions. [#918]

0.6 (2018-12-11)

General

• Versions of Numpy <1.11 are no longer supported. [#783]

New Features

• photutils.detection
  • DAOStarFinder and IRAFStarFinder gain two new parameters: brightest to keep the top brightest (based on the flux) objects in the returned catalog (after all other filtering has been applied) and peakmax to exclude sources with peak pixel values larger or equal to peakmax. [#750]
  • Added a mask keyword to DAOStarFinder and IRAFStarFinder that can be used to mask regions of the input image. [#759]
• photutils.psf
  • The Star, Stars, and LinkedStars classes are now deprecated and have been renamed EPSFStar, EPSFStars, and LinkedEPSFStars, respectively. [#727]
  • Added a GriddedPSFModel class for spatially-dependent PSFs. [#772]
  • The pixel_scale keyword in EPSFStar, EPSFBuilder and EPSFModel is now deprecated. Use the oversampling keyword instead. [#780]

API Changes

• photutils.detection
  • The find_peaks function now returns an empty astropy.table.Table instead of an empty list if the input data is an array of constant values. [#709]
  • The find_peaks function will no longer issue a RuntimeWarning if the input data contains NaNs. [#712]
  • If no sources/peaks are found, DAOStarFinder, IRAFStarFinder, and find_peaks now will return an empty table with column names and types. [#758, #762]
• photutils.psf
  • The photutils.psf.funcs.py module was renamed photutils.psf.utils.py. The prepare_psf_model and get_grouped_psf_model functions were also moved to this new utils.py module. [#777]

Bug Fixes

• photutils.aperture
  • If a single aperture is input as a list into the aperture_photometry function, then the output columns will be called aperture_sum_0 and aperture_sum_err_0 (if errors are used). Previously these column names did not have the trailing "_0". [#779]
• photutils.segmentation
  • Fixed a bug in the computation of sky_bbox_ul, sky_bbox_lr, sky_bbox_ur in the SourceCatalog. [#716]

Other Changes and Additions

• Updated background and detection functions that call astropy.stats.SigmaClip or astropy.stats.sigma_clipped_stats to support both their iters (for astropy < 3.1) and maxiters keywords. [#726]

0.5 (2018-08-06)

General

• Versions of Python <3.5 are no longer supported. [#702, #703]
• Versions of Numpy <1.10 are no longer supported. [#697, #703]
• Versions of Pytest <3.1 are no longer supported. [#702]
• pytest-astropy is now required to run the test suite. [#702, #703]
• The documentation build now uses the Sphinx configuration from sphinx-astropy rather than from astropy-helpers. [#702]

New Features

• photutils.aperture
  • Added plot and to_aperture methods to BoundingBox. [#662]
  • Added default theta value for elliptical and rectangular apertures. [#674]
• photutils.centroids
  • Added a centroid_sources function to calculate centroid of many sources in a single image. [#656]
  • An n-dimensional array can now be input into the centroid_com function. [#685]
• photutils.datasets
  • Added a load_simulated_hst_star_image function to load a simulated HST WFC3/IR F160W image of stars. [#695]
• photutils.detection
  • Added a centroid_func keyword to find_peaks. The subpixels keyword is now deprecated. [#656]
  • The find_peaks function now returns SkyCoord objects in the table instead of separate RA and Dec. columns. [#656]
  • The find_peaks function now returns an empty Table and issues a warning when no peaks are found. [#668]
• photutils.psf
  • Added tools to build and fit an effective PSF (EPSFBuilder and EPSFFitter). [#695]
  • Added extract_stars function to extract cutouts of stars used to build an ePSF. [#695]
  • Added EPSFModel class to hold a fittable ePSF model. [#695]
• photutils.segmentation
  • Added a mask keyword to the detect_sources function. [#621]
  • Renamed SegmentationImage max attribute to max_label. max is deprecated. [#662]
  • Added a Segment class to hold the cutout image and properties of single labeled region (source segment). [#662]
  • Deprecated the SegmentationImage area method. Instead, use the areas attribute. [#662]
  • Renamed SegmentationImage data_masked attribute to data_ma. data_masked is deprecated. [#662]
  • Renamed SegmentationImage is_sequential attribute to is_consecutive. is_sequential is deprecated. [#662]
  • Renamed SegmentationImage relabel_sequential attribute to relabel_consecutive. relabel_sequential is deprecated. [#662]
  • Added a missing_labels property to SegmentationImage. [#662]
  • Added a check_labels method to SegmentationImage. The check_label method is deprecated. [#662]
• photutils.utils
  • Deprecated the cutout_footprint function. [#656]

Bug Fixes

• photutils.aperture
  • Fixed a bug where quantity inputs to the aperture classes would sometimes fail. [#693]
• photutils.detection
  • Fixed an issue in detect_sources where in some cases sources with a size less than npixels could be returned. [#663]
  • Fixed an issue in DAOStarFinder where in some cases a few too many sources could be returned. [#671]
• photutils.isophote
  • Fixed a bug where isophote fitting would fail when the initial center was not specified for an image with an elongated aspect ratio. [#673]
• photutils.segmentation
  • Fixed deblend_sources when other sources are in the neighborhood. [#617]
  • Fixed source_properties to handle the case where the data contain one or more NaNs. [#658]
  • Fixed an issue with deblend_sources where sources were not deblended where the data contain one or more NaNs. [#658]
  • Fixed the SegmentationImage areas attribute to not include the zero (background) label. [#662]

Other Changes and Additions

• photutils.isophote
  • Corrected the units for isophote sarea in the documentation. [#657]

0.4 (2017-10-30)

General

• Dropped python 3.3 support. [#542]
• Dropped numpy 1.8 support. Minimal required version is now numpy 1.9. [#542]
• Dropped support for astropy 1.x versions. Minimal required version is now astropy 2.0. [#575]
• Dropped scipy 0.15 support. Minimal required version is now scipy 0.16. [#576]
• Explicitly require six as dependency. [#601]

New Features

• photutils.aperture
  • Added BoundingBox class, used when defining apertures. [#481]
  • Apertures now have __repr__ and __str__ defined. [#493]
  • Improved plotting of annulus apertures using Bezier curves. [#494]
  • Rectangular apertures now use the true minimal bounding box. [#507]
  • Elliptical apertures now use the true minimal bounding box. [#508]
  • Added a to_sky method for pixel apertures. [#512]
• photutils.background
  • Mesh rejection now also applies to pixels that are masked during sigma clipping. [#544]
• photutils.datasets
  • Added new make_wcs and make_imagehdu functions. [#527]
  • Added new show_progress keyword to the load_* functions. [#590]
• photutils.isophote
  • Added a new photutils.isophote subpackage to provide tools to fit elliptical isophotes to a galaxy image. [#532, #603]
• photutils.segmentation
  • Added a cmap method to SegmentationImage to generate a random matplotlib colormap. [#513]
  • Added sky_centroid and sky_centroid_icrs source properties. [#592]
  • Added new source properties representing the sky coordinates of the bounding box corner vertices (sky_bbox_ll, sky_bbox_ul sky_bbox_lr, and sky_bbox_ur). [#592]
  • Added new SourceCatalog class to hold the list of SourceProperties. [#608]
  • The properties_table function is now deprecated. Use the SourceCatalog.to_table() method instead. [#608]
• photutils.psf
  • Uncertainties on fitted parameters are added to the final table. [#516]
  • Fitted results of any free parameter are added to the final table. [#471]

API Changes

• photutils.aperture
  • The ApertureMask apply() method has been renamed to multiply(). [#481].
  • The ApertureMask input parameter was renamed from mask to data. [#548]
  • Removed the pixelwise_errors keyword from aperture_photometry. [#489]
• photutils.background
  • The Background2D keywords exclude_mesh_method and exclude_mesh_percentile were removed in favor of a single keyword called exclude_percentile. [#544]
  • Renamed BiweightMidvarianceBackgroundRMS to BiweightScaleBackgroundRMS. [#547]
  • Removed the SigmaClip class. astropy.stats.SigmaClip is a direct replacement. [#569]
• photutils.datasets
  • The make_poisson_noise function was renamed to apply_poisson_noise. [#527]
  • The make_random_gaussians function was renamed to make_random_gaussians_table. The parameter ranges must now be input as a dictionary. [#527]
  • The make_gaussian_sources function was renamed to make_gaussian_sources_image. [#527]
  • The make_random_models function was renamed to make_random_models_table. [#527]
  • The make_model_sources function was renamed to make_model_sources_image. [#527]
  • The unit, hdu, wcs, and wcsheader keywords in photutils.datasets functions were removed. [#527]
  • 'photutils-datasets' was added as an optional location in the get_path function. This option is used as a fallback in case the 'remote' location (astropy data server) fails. [#589]
• photutils.detection
  • The daofind and irafstarfinder functions were removed. [#588]
• photutils.psf
  • IterativelySubtractedPSFPhotometry issues a "no sources detected" warning only on the first iteration, if applicable. [#566]
• photutils.segmentation
  • The 'icrs_centroid', 'ra_icrs_centroid', and 'dec_icrs_centroid' source properties are deprecated and are no longer default columns returned by properties_table. [#592]
  • The properties_table function now returns a QTable. [#592]
• photutils.utils
  • The background_color keyword was removed from the random_cmap function. [#528]
  • Deprecated unused interpolate_masked_data(). [#526, #611]

Bug Fixes

• photutils.segmentation
  • Fixed deblend_sources so that it correctly deblends multiple sources. [#572]
  • Fixed a bug in calculation of the sky_centroid_icrs (and deprecated icrs_centroid) property where the incorrect pixel origin was being passed. [#592]
• photutils.utils
  • Added a check that data and bkg_error have the same units in calc_total_error. [#537]

0.3.2 (2017-03-31)

General

• Fixed file permissions in the released source distribution.

0.3.1 (2017-03-02)

General

• Dropped numpy 1.7 support. Minimal required version is now numpy 1.8. [#327]
• photutils.datasets
  • The load_* functions that use remote data now retrieve the data from data.astropy.org (the astropy data repository). [#472]

Bug Fixes

• photutils.background
  • Fixed issue with Background2D with edge_method='pad' that occurred when unequal padding needed to be applied to each axis. [#498]
  • Fixed issue with Background2D that occurred when zero padding needed to apply along only one axis. [#500]
• photutils.geometry
  • Fixed a bug in circular_overlap_grid affecting 32-bit machines that could cause errors circular aperture photometry. [#475]
• photutils.psf
  • Fixed a bug in how FittableImageModel represents its center. [#460]
  • Fix bug which modified user's input table when doing forced photometry. [#485]

0.3 (2016-11-06)

New Features

• photutils.aperture
  • Added new origin keyword to aperture plot methods. [#395]
  • Added new id column to aperture_photometry output table. [#446]
  • Added __len__ method for aperture classes. [#446]
  • Added new to_mask method to PixelAperture classes. [#453]
  • Added new ApertureMask class to generate masks from apertures. [#453]
  • Added new mask_area() method to PixelAperture classes. [#453]
  • The aperture_photometry() function now accepts a list of aperture objects. [#454]
• photutils.background
  • Added new MeanBackground, MedianBackground, MMMBackground, SExtractorBackground, BiweightLocationBackground, StdBackgroundRMS, MADStdBackgroundRMS, and BiweightMidvarianceBackgroundRMS classes. [#370]
  • Added axis keyword to new background classes. [#392]
  • Added new removed_masked, meshpix_threshold, and edge_method keywords for the 2D background classes. [#355]
  • Added new std_blocksum function. [#355]
  • Added new SigmaClip class. [#423]
  • Added new BkgZoomInterpolator and BkgIDWInterpolator classes. [#437]
• photutils.datasets
  • Added load_irac_psf function. [#403]
• photutils.detection
  • Added new make_source_mask convenience function. [#355]
  • Added filter_data function. [#398]
  • Added DAOStarFinder and IRAFStarFinder as OOP interfaces for daofind and irafstarfinder, respectively, which are now deprecated. [#379]
• photutils.psf
  • Added BasicPSFPhotometry, IterativelySubtractedPSFPhotometry, and DAOPhotPSFPhotometry classes to perform PSF photometry in crowded fields. [#427]
  • Added DAOGroup and DBSCANGroup classes for grouping overlapping sources. [#369]
• photutils.psf_match
  • Added create_matching_kernel and resize_psf functions. Also, added CosineBellWindow, HanningWindow, SplitCosineBellWindow, TopHatWindow, and TukeyWindow classes. [#403]
• photutils.segmentation
  • Created new photutils.segmentation subpackage. [#442]
  • Added copy and area methods and an areas property to SegmentationImage. [#331]

API Changes

• photutils.aperture
  • Removed the effective_gain keyword from aperture_photometry. Users must now input the total error, which can be calculated using the calc_total_error function. [#368]
  • aperture_photometry now outputs a QTable. [#446]
  • Renamed source_id keyword to indices in the aperture plot() method. [#453]
  • Added mask and unit keywords to aperture do_photometry() methods. [#453]
• photutils.background
  • For the background classes, the filter_shape keyword was renamed to filter_size. The background_low_res and background_rms_low_res class attributes were renamed to background_mesh and background_rms_mesh, respectively. [#355, #437]
  • The Background2D method and backfunc keywords have been removed. In its place one can input callable objects via the sigma_clip, bkg_estimator, and bkgrms_estimator keywords. [#437]
  • The interpolator to be used by the Background2D class can be input as a callable object via the new interpolator keyword. [#437]
• photutils.centroids
  • Created photutils.centroids subpackage, which contains the centroid_com, centroid_1dg, and centroid_2dg functions. These functions now return a two-element numpy ndarray. [#428]
• photutils.detection
  • Changed finding algorithm implementations (daofind and starfind) from functional to object-oriented style. Deprecated old style. [#379]
• photutils.morphology
  • Created photutils.morphology subpackage. [#428]
  • Removed marginalize_data2d function. [#428]
  • Moved cutout_footprint from photutils.morphology to photutils.utils. [#428]
  • Added a function to calculate the Gini coefficient (gini). [#343]
• photutils.psf
  • Removed the effective_gain keyword from psf_photometry. Users must now input the total error, which can be calculated using the calc_total_error function. [#368]
• photutils.segmentation
  • Removed the effective_gain keyword from SourceProperties and source_properties. Users must now input the total error, which can be calculated using the calc_total_error function. [#368]
• photutils.utils
  • Renamed calculate_total_error to calc_total_error. [#368]

Bug Fixes

• photutils.aperture
  • Fixed a bug in aperture_photometry so that single-row output tables do not return a multidimensional column. [#446]
• photutils.centroids
  • Fixed a bug in centroid_1dg and centroid_2dg that occurred when the input data contained invalid (NaN or inf) values. [#428]
• photutils.segmentation
  • Fixed a bug in SourceProperties where error and background units were sometimes dropped. [#441]

0.2.2 (2016-07-06)

General

• Dropped numpy 1.6 support. Minimal required version is now numpy 1.7. [#327]
• Fixed configparser for Python 3.5. [#366, #384]

Bug Fixes

• photutils.detection
  • Fixed an issue to update segmentation image slices after deblending. [#340]
  • Fixed source deblending to pass the pixel connectivity to the watershed algorithm. [#347]
  • SegmentationImage properties are now cached instead of recalculated, which significantly improves performance. [#361]
• photutils.utils
  • Fixed a bug in pixel_to_icrs_coords where the incorrect pixel origin was being passed. [#348]

0.2.1 (2016-01-15)

Bug Fixes

• photutils.background
  • Added more robust version checking of Astropy. [#318]
• photutils.detection
  • Added more robust version checking of Astropy. [#318]
• photutils.segmentation
  • Fixed issue where SegmentationImage slices were not being updated. [#317]
  • Added more robust version checking of scikit-image. [#318]

0.2 (2015-12-31)

General

• Photutils has the following requirements:
  • Python 2.7 or 3.3 or later
  • Numpy 1.6 or later
  • Astropy v1.0 or later

New Features

• photutils.detection
  • find_peaks now returns an Astropy Table containing the (x, y) positions and peak values. [#240]
  • find_peaks has new mask, error, wcs and subpixel precision options. [#244]
  • detect_sources will now issue a warning if the filter kernel is not normalized to 1. [#298]
  • Added new deblend_sources function, an experimental source deblender. [#314]
• photutils.morphology
  • Added new GaussianConst2D (2D Gaussian plus a constant) model. [#244]
  • Added new marginalize_data2d function. [#244]
  • Added new cutout_footprint function. [#244]
• photutils.segmentation
  • Added new SegmentationImage class. [#306]
  • Added new check_label, keep_labels, and outline_segments methods for modifying SegmentationImage. [#306]
• photutils.utils
  • Added new random_cmap function to generate a colormap comprised of random colors. [#299]
  • Added new ShepardIDWInterpolator class to perform Inverse Distance Weighted (IDW) interpolation. [#307]
  • The interpolate_masked_data function can now interpolate higher-dimensional data. [#310]

API Changes

• photutils.segmentation
  • The relabel_sequential, relabel_segments, remove_segments, remove_border_segments, and remove_masked_segments functions are now SegmentationImage methods (with slightly different names). [#306]
  • The SegmentProperties class has been renamed to SourceProperties. Likewise, the segment_properties function has been renamed to source_properties. [#306]
  • The segment_sum and segment_sum_err attributes have been renamed to source_sum and source_sum_err, respectively. [#306]
  • The background_atcentroid attribute has been renamed to background_at_centroid. [#306]

Bug Fixes

• photutils.aperture
  • Fixed an issue where np.nan or np.inf were not properly masked. [#267]
• photutils.geometry
  • overlap_area_triangle_unit_circle handles correctly a corner case in some i386 systems where the area of the aperture was not computed correctly. [#242]
  • rectangular_overlap_grid and elliptical_overlap_grid fixes to normalization of subsampled pixels. [#265]
  • overlap_area_triangle_unit_circle handles correctly the case where a line segment intersects at a triangle vertex. [#277]

Other Changes and Additions

• Updated astropy-helpers to v1.1. [#302]

0.1 (2014-12-22)

Photutils 0.1 was released on December 22, 2014. It requires Astropy version 0.4 or later.