Release History

0.4.3.dev40+g6290738 (2023-03-20)

Backwards Incompatible Changes

  • The following helper functions in sunkit_image.colaginment have been removed, with no replacement. This is because they are designed to be internal helper functions. If you need to use them in your own code create a copy of the functions from the sunkit-image source code.

    • parabolic_turning_point

    • calculate_clipping

    • check_for_nonfinite_entries

    • get_correlation_shifts

    • clip_edges

    • find_best_match_location

    • calculate_shift (#100)

  • Made the following functions in sunkit_image.trace private:

    1. curvature_radius (renamed to _curvature_radius)

    2. erase_loop_in_image (renamed to _erase_loop_in_image)

    3. initial_direction_finding (renamed to _initial_direction_finding)

    4. loop_add (renamed to _loop_add)

    These were never intended to be used by users but for the user-facing functions. (#136)


Improved Documentation

0.4.2 (2022-05-24)

Breaking Changes

  • Minimum version of sunpy required is now 4.0.0

0.4.1 (2022-04-05)


0.4.0 (2022-03-11)


0.3.2 (2022-03-08)

Trivial/Internal Changes

  • Minor changes to ensure that sunkit-image is buildable on conda-forge.

0.3.1 (2021-11-19)

  • Fixed a bug where a UnitConversionError was thrown if a non-dimensionless Quantity object was input for the signal in cross_correlation. (#72)

  • Fixed a bug where the way we dealt with Quantity objects was inconsistent with Array objects in newer versions of numpy. The pre_check_hook option keyword argument has also been removed from time_lag and post_check_hook has been renamed to array_check and now accepts two arguments. (#72)

Trivial/Internal Changes

  • A warning is now raised if the input data to mgn contain any NaNs. (#73)

0.3.0 (2021-06-02)


  • The sunkit_image.time_lag module provides functions for computing the cross-correlation, time lag, and peak cross-correlation for N-dimensional time series. (#61)

  • Increased the minimum version of “sunpy” to 3.0.0, the new LTS release

0.2.0 (2021-05-04)


Bug Fixes

  • Increased the minimum version of “skimage” to 0.18.0, preventing faulty code in sunkit-image.utils.points_in_poly(). (#59)

Trivial/Internal Changes

  • Added multiple unit tests to increase code coverage. (#59)

  • Increased minimum supported version of sunpy to 2.0.0

  • Many internal package updates to documentation, the continuous integration and etc.

0.1.0 (2020-04-30)


  • Added a class (sunkit_image.utils.noise.NoiseLevelEstimation) for noise level estimation of an image. (#12)

  • Added a new function (sunkit_image.radial.fnrgf) to normalize the radial brightness gradient using a Fourier approximation. (#17)

  • Added a function (sunkit_image.enhance.mgn) for applying Multi-scale Gaussian Normalization to an image (numpy.ndarray). (#30)

  • Added a new function (sunkit_image.trace.occult2) to automatically trace out loops/curved structures in an image. (#31)

  • Added an implementation of the Automated Swirl Detection Algorithm (ASDA). (#40)

Improved Documentation

Trivial/Internal Changes

  • Transferred sunkit_image.utils.noise.NoiseLevelEstimation from class object into a series of functions. (#38)