Skip to content

Latest commit

 

History

History
210 lines (160 loc) · 6.08 KB

CHANGELOG.rst

File metadata and controls

210 lines (160 loc) · 6.08 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

When updating this file, please add an entry for your change under Not Yet Released and one of the following headings:

  • Added - for new features.
  • Changed - for changes in existing functionality.
  • Deprecated - for soon-to-be removed features.
  • Removed - for now removed features.
  • Fixed - for any bug fixes.
  • Security - in case of vulnerabilities.

If the heading does not yet exist under Not Yet Released, then add it as a 3rd level heading, underlined with pluses (see examples below).

When preparing for a public release add a new 2nd level heading, underlined with dashes under Not Yet Released with the version number and the release date, in year-month-day format (see examples below).

Not Yet Released

0.11.0 (2021-12-02)

Added

  • fft_clean was added to the console programs list. Still very experimental.

Changed

  • Updated EDR_Stats to be consistent with upstream EDR_Stats Pipeline version 3.0.0 (2021/09/08). This handles the new LUT settings.
  • Updated HiCal to be consistent with upstream HiCal Pipeline version 4.2.3 (2021/11/17).
  • Updated HiStitch to be consistent with upstream HiStitch Pipeline version 2.21.2 (2021/09/09). This change defaults to balance processing for all CCDs and corrects an indexing bug.

Fixed

  • HiCal now deals with missing fields in the output of histats.
  • lisfix now does not try to fit a slope to a column with masked values.
  • bitflips now raises more descriptive exceptions when given poor data.

0.10.0 (2021-08-05)

Added

  • fft_clean functionality added for more testing, but not integrated with HiCal or hiproc.

Fixed

  • EDR_Stats was failing when some histats return values were None. Now properly just saves a "None" for SNR.
  • HiCal multiprocessing approach was failing when a Channel was bypassed, essentially breaking the whole run.
  • When the HiStitch function was called externally, a missing channel wasn't handled properly. When called from the HiStitch console script, it was fine.
  • hiproc adjusted to take advantage of the above two fixes to HiCal and HiStitch.
  • HiccdStitch now tolerant against the new ISIS stats return of the "N/A" string for missing values.

0.9.0 (2021-07-08)

Added

  • HiJACK now retains pre- and post-HiJACK flat files by default.
  • HiJACK now has a --plotflats argument that can be used to plot the new flat files after a run of HiJACK.
  • Added new rjplot program to plot the contents of the jitter and smear output files created by resolve_jitter.

Fixed

  • In certain conditions an array can have zero length, and when it does, one shouldn't try and index it in a logging statement.

0.8.1 (2021-07-06)

Added

  • Additional logging of the HiPrecisionInit output during a hiproc run, which was previously obscured.

Fixed

  • In some legitimate cases, some elements returned from ISIS histat would be missing (e.g. in the case of no valid pixels in the CAL_BUFFER area, there is no returned value of "Average"), but were not handled properly (Issue #3). More robust handling was added.

0.8.0 (2021-06-30)

Changed

  • bitflips.py: Removed the span check when considering end values, which may affect how the algorithm deals with "mostly good" DN histograms, such that it should now correctly handle mesa-shaped DN histograms and not chop them in the middle.

0.7.1 (2021-06-21)

Fixed

  • The new-in-0.7.0 multiprocessing requires that the multidict package be installed (for pvl to use), and it wasn't included in the requirements. If you have 0.7.0, a simple "conda install multidict" should get you working.

0.7.0 (2021-06-15)

Added

  • Improved documentation
  • environment.yml for conda development
  • Added Python-based multiprocessing capabilities to EDR_Stats, HiCal, and hiproc.

Changed

  • Incorporated changes from upstream to HiCal to make bitflip and lisfix settings on by default.

Fixed

  • resolve_jitter output header lines properly commented, now doesn't bomb HiJACK's run of hijitter.
  • now, additionally supporting ISIS 4.1.1 through 5.0.0
  • Upstream addressed a bug in analyze_cubenorm_stats() that we had noticed, so now fixed here, too.
  • MANIFEST.in did not properly include the "data" directory, so that was a problem.

0.6.1 (2021-03-23)

Added

  • lisfix will return a non-zero exit code if it chooses not to fix the input cube.

Changed

  • Updated documentation in various places.

0.6.0 (2021-03-18)

Added

  • More complete documentation for the programs and their parameters.

Changed

  • Implemented better handling for configuration files so that they will get distributed with the package.

0.5.0 (2021-03-05)

Added

  • lisfix: Added the lisfix module.
  • bitflips: Sometimes the very end of the histogram (although not a formal minima) is the appropriate choice, and is now considered.
  • bitflips: Added capability to ignore minor maxima at the ends of the histogram to "roll down" to a better solution.

Changed

  • name change of project from pyrise to hiproc.
  • bitflips: Changed the default medstd_limit from 300 to 400 DN.

Fixed

  • bitflips: There were a variety of edge cases that resulted in errors. The appropriate guardrails, handlers, and recovery logic has now been added.
  • HiStitch: The equalize and balance parameters cannot both be true.

0.4.0 (2020-09-22)

  • Tremendous amount of re-working in bitflips to improve performance.
  • Format cleanup

0.3.0 (2020-05-16)

  • Confirmed that EDR_Stats and HiCal produce identical output cubes.

0.2.0 (2020-05-06)

  • Updated with bit-flip correction.

0.1.0 2020-03-21

  • First shared on GitHub