Skip to content

Latest commit

 

History

History
193 lines (128 loc) · 5.19 KB

CHANGES.rst

File metadata and controls

193 lines (128 loc) · 5.19 KB

1.5.0 (unreleased)

New Features

API Changes

Bug Fixes

Other changes

1.4.1 (2024-06-20)

New Features

API Changes

Bug Fixes

  • Fix bug where Background one sided / two sided was not correctly assigning units to data. [#221]

Other changes

1.4.0 (2024-05-29)

New Features

  • Added 'interpolated_profile' option for HorneExtract. If The interpolated_profile option is used, the image will be sampled in various wavelength bins (set by n_bins_interpolated_profile), averaged in those bins, and samples are then interpolated between (linear by default, interpolation degree can be set with the interp_degree_interpolated_profile parameter) to generate a continuously varying spatial profile that can be evaluated at any wavelength. [#173]
  • Added a function to measure a cross-dispersion profile. A profile can be obtained at a single pixel/wavelength, or an average profile can be obtained from a range/set of wavelengths. [#214]

API Changes

  • Fit residuals exposed for wavelength calibration in WavelengthCalibration1D.fit_residuals. [#446]

Bug Fixes

  • Output 1D spectra from Background no longer include NaNs. Output 1D spectra from BoxcarExtract no longer include NaNs when none are present in the extraction window. NaNs in the window will still propagate to BoxcarExtract's extracted 1D spectrum. [#159]
  • Backgrounds using median statistic properly ignore zero-weighted pixels. [#159]
  • HorneExtract now accepts 'None' as a vaild option for bkgrd_prof. [#171]
  • Fix in FitTrace to set fully-masked column bin peaks to NaN. Previously, for peak_method='max' these were set to 0.0, and for peak_method='centroid' they were set to the number of rows in the image, biasing the final fit to all bin peaks. Previously for Gaussian, the entire fit failed. [#205, #206]
  • Fixed input of traces in Background. Added a condition to 'FlatTrace' that trace position must be a positive number. [#211]

Other changes

  • The following packages are now optional dependencies because they are not required for core functionality: matplotlib, photutils, synphot. To install them anyway, use the [all] specifier when you install specreduce; e.g.: pip install specreduce[all] [#202]

1.3.0 (2022-12-05)

New Features

  • The new FitTrace class (see "API Changes" below) introduces the ability to take a polynomial trace of an image [#128]

API Changes

  • Renamed KosmosTrace as FitTrace, a conglomerate class for traces that are fit to images instead of predetermined [#128]
  • The default number of bins for FitTrace is now its associated image's number of dispersion pixels instead of 20. Its default peak_method is now 'max' [#128]
  • All operations now accept Spectrum1D and Quantity-type images. All accepted image types are now processed internally as Spectrum1D objects [#144, #154]
  • All operations' image attributes are now coerced Spectrum1D objects [#144, #154]
  • HorneExtract can now handle non-flat traces [#148]

Bug Fixes

  • Fixed passing a single Trace object to Background [#146]
  • Moved away from creating image masks with numpy's mask_invalid() function after change to upstream API. This will make specreduce be compatible with numpy 1.24 or later. [#155]

1.2.0 (2022-10-04)

New Features

  • Background has new methods for exposing the 1D spectrum of the background or background-subtracted regions [#143]

Bug Fixes

  • Improved errors/warnings when background region extends beyond bounds of image [#127]
  • Fixed boxcar weighting bug that often resulted in peak pixels having weight above 1 and erroneously triggered overlapping background errors [#125]
  • Fixed boxcar weighting to handle zero width and edge of image cases [#141]

1.1.0 (2022-08-18)

New Features

  • peak_method as an optional argument to KosmosTrace [#115]

API Changes

  • HorneExtract no longer requires mask and unit arguments [#105]
  • BoxcarExtract and HorneExtract now accept parameters (and require the image and trace) at initialization, and allow overriding any input parameters when calling [#117]

Bug Fixes

  • Corrected the default mask created in HorneExtract/OptimalExtract when a user doesn't specify one and gives their image as a numpy array [#118]

1.0.0 (2022-03-29)

New Features

  • Added Trace classes
  • Added basic synthetic data routines
  • Added BoxcarExtract
  • Added HorneExtract, a.k.a. OptimalExtract
  • Added basic Background subtraction

Bug Fixes

  • Update codecov-action to v2
  • Change default branch from master to main
  • Test fixes; bump CI to python 3.8 and 3.9 and deprecate support for 3.7