Skip to content

Latest commit

 

History

History
1904 lines (1214 loc) · 54.8 KB

CHANGES.rst

File metadata and controls

1904 lines (1214 loc) · 54.8 KB

2.0.0 (unreleased)

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.background
    • Added an alpha keyword to the Background2D.plot_meshes method. [#1286]

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

API Changes

  • photutils.background
    • Removed the deprecated background_mesh_ma and background_rms_mesh_ma Background2D properties. [#1280]
  • photutils.centroid
    • 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]

1.3.0 (2021-12-21)

General

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

New Features

  • photutils.centroid
    • 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-compatiblity is needed with older Photutils' versions, set grid_mode=False. [#1239]
  • photutils.centroid
    • 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_phometry 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.centroid
    • 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.centroid
    • 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_poission_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.