diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 81b4c65e..2266d027 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,3 +1,80 @@ +0.6.0 (2025-02-19) +================== + +Breaking Changes +---------------- + +- The ``Asda`` and ``Lamb_Oseen`` classes have been removed and replaced with functions that replicate the original process. + + The following function were renamed: + - ``gen_vel`` -> ``generate_velocity_field`` + - ``gamma_values`` -> ``calculate_gamma_values`` + - ``vortex_property`` -> ``get_vortex_properties`` + - ``get_grid`` -> ``get_vortex_meshgrid`` + - ``center_edge`` -> ``get_vortex_edges`` + - ``get_vtheta`` -> ``get_rotational_velocity`` + - ``get_vradial`` -> ``get_radial_velocity`` + - ``get_vxvy`` -> ``get_velocity_field`` + + Now to use, the properties that were previously stored within the class should now be passed through the arguments of the methods in case the method used these arguments. + + Example: + + ``lo.gen_vel(index[1], index[0])`` -> ``asda.generate_velocity_field(vx, vy, index[1], index[0], r)`` (`#185 `__) +- Now all inputs to `sunkit_image.enhance.mgn` beyond the input array are keyword arguments. (`#194 `__) +- Increased the minimum version of Python to 3.10. + This comes along with an increase in the dependencies versions. (`#194 `__) +- Increased the minimum required version of ``sunpy`` to the latest LTS version 6.0.0 (`#223 `__) +- All functions under (`sunkit_image.radial`) now have a settable fill value which now defaults to NaN instead of 0. (`#231 `__) +- The function ``set_attenuation_coefficients`` has been removed from the public API. + + Now you can pass in the inputs used by ``set_attenuation_coefficients`` directly into `sunkit_image.radial.fnrgf`, which now accepts ``mean_attenuation_range`` and ``std_attenuation_range``. (`#243 `__) + + +Removals +-------- + +- The coalignment methods ``calculate_solar_rotate_shift`` and ``mapsequence_coalign_by_rotation`` present in the `sunkit_image.coalignment` have been removed, with no replacement. + Correspondingly the gallery example ``Compensating for Solar Rotation`` making use of these methods are removed. + + If you wish to coalign differentially rotated maps, refer to this `example `__ in sunpy (`#206 `__) + + +New Features +------------ + +- Added the ability to call a Wavelets Optimized Whitening (WOW) algorithm from the `watroo `__ package. (`#188 `__) +- Added the `sunkit_image.stara` module which is an implementation of Sunspot Tracking And Recognition (STARA). + Added an example of plotting sunspots using the STARA :ref:`sphx_glr_generated_gallery_finding_sunspots_using_stara.py`. (`#195 `__) +- Added the Radial Histogram Equalizing Filter (RHEF) (`sunkit_image.radial.rhef`) to the `sunkit_image.radial` package. (`#205 `__) +- Added a gallery example :ref:`sphx_glr_generated_gallery_detecting_swirls.py` demonstrating the usage of the `sunkit_image.asda` module for detecting swirls in the solar atmosphere. (`#218 `__) + + +Bug Fixes +--------- + +- Removed the default normalization of the output maps from `sunkit_image.radial.nrgf` and `sunkit_image.radial.fnrgf`. (`#205 `__) +- Within `sunkit_image.enhance.mgn`, the input data is now cast to float32 to work around int/float being cast to each other causing an error. (`#215 `__) +- Improved the Radial Histogram Equalizing Filter (RHEF) (`sunkit_image.radial.rhef`) to work with images outside of SDO/AIA. (`#231 `__) + + +Documentation +------------- + +- Added a new example for `sunkit_image.radial.rhef` at :ref:`sphx_glr_generated_gallery_radial_histogram_equalization.py` + + Added RHEF to :ref:`sphx_glr_generated_gallery_radial_gradient_filters.py` as a comparison to the other filters. (`#205 `__) +- Updated all of the examples with cleaner plots and some minor english style tweaks. (`#212 `__) +- Added a new example showcasing advanced usage of Wavelets Optimized Whitening (WOW) at :ref:`sphx_glr_generated_gallery_advanced_wow.py` (`#238 `__) + + +Internal Changes +---------------- + +- Added explicit support for numpy 2.0. (`#209 `__) +- Added unit tests with a JSOC cutout file. (`#215 `__) + + 0.5.1 (2023-11-17) ================== diff --git a/changelog/185.breaking.rst b/changelog/185.breaking.rst deleted file mode 100644 index 99e58ec5..00000000 --- a/changelog/185.breaking.rst +++ /dev/null @@ -1,17 +0,0 @@ -The ``Asda`` and ``Lamb_Oseen`` classes have been removed and replaced with functions that replicate the original process. - -The following function were renamed: -- ``gen_vel`` -> ``generate_velocity_field`` -- ``gamma_values`` -> ``calculate_gamma_values`` -- ``vortex_property`` -> ``get_vortex_properties`` -- ``get_grid`` -> ``get_vortex_meshgrid`` -- ``center_edge`` -> ``get_vortex_edges`` -- ``get_vtheta`` -> ``get_rotational_velocity`` -- ``get_vradial`` -> ``get_radial_velocity`` -- ``get_vxvy`` -> ``get_velocity_field`` - -Now to use, the properties that were previously stored within the class should now be passed through the arguments of the methods in case the method used these arguments. - -Example: - -``lo.gen_vel(index[1], index[0])`` -> ``asda.generate_velocity_field(vx, vy, index[1], index[0], r)`` diff --git a/changelog/188.feature.rst b/changelog/188.feature.rst deleted file mode 100644 index 4601877e..00000000 --- a/changelog/188.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added the ability to call a Wavelets Optimized Whitening (WOW) algorithm from the `watroo `__ package. diff --git a/changelog/194.breaking.1.rst b/changelog/194.breaking.1.rst deleted file mode 100644 index de9b7c40..00000000 --- a/changelog/194.breaking.1.rst +++ /dev/null @@ -1 +0,0 @@ -Now all inputs to `sunkit_image.enhance.mgn` beyond the input array are keyword arguments. diff --git a/changelog/194.breaking.rst b/changelog/194.breaking.rst deleted file mode 100644 index 5526639b..00000000 --- a/changelog/194.breaking.rst +++ /dev/null @@ -1,2 +0,0 @@ -Increased the minimum version of Python to 3.10. -This comes along with an increase in the dependencies versions. diff --git a/changelog/195.feature.rst b/changelog/195.feature.rst deleted file mode 100644 index 64bed6be..00000000 --- a/changelog/195.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Added the `sunkit_image.stara` module which is an implementation of Sunspot Tracking And Recognition (STARA). -Added an example of plotting sunspots using the STARA :ref:`sphx_glr_generated_gallery_finding_sunspots_using_stara.py`. diff --git a/changelog/205.bugfix.rst b/changelog/205.bugfix.rst deleted file mode 100644 index a44dd50c..00000000 --- a/changelog/205.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Removed the default normalization of the output maps from `sunkit_image.radial.nrgf` and `sunkit_image.radial.fnrgf`. diff --git a/changelog/205.doc.rst b/changelog/205.doc.rst deleted file mode 100644 index 0a4ed021..00000000 --- a/changelog/205.doc.rst +++ /dev/null @@ -1,3 +0,0 @@ -Added a new example for `sunkit_image.radial.rhef` at :ref:`sphx_glr_generated_gallery_radial_histogram_equalization.py` - -Added RHEF to :ref:`sphx_glr_generated_gallery_radial_gradient_filters.py` as a comparison to the other filters. diff --git a/changelog/205.feature.rst b/changelog/205.feature.rst deleted file mode 100644 index 5bddaeb2..00000000 --- a/changelog/205.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added the Radial Histogram Equalizing Filter (RHEF) (`sunkit_image.radial.rhef`) to the `sunkit_image.radial` package. diff --git a/changelog/206.removal.rst b/changelog/206.removal.rst deleted file mode 100644 index 12d0f7ae..00000000 --- a/changelog/206.removal.rst +++ /dev/null @@ -1,4 +0,0 @@ -The coalignment methods ``calculate_solar_rotate_shift`` and ``mapsequence_coalign_by_rotation`` present in the `sunkit_image.coalignment` have been removed, with no replacement. -Correspondingly the gallery example ``Compensating for Solar Rotation`` making use of these methods are removed. - -If you wish to coalign differentially rotated maps, refer to this `example `__ in sunpy diff --git a/changelog/209.trivial.rst b/changelog/209.trivial.rst deleted file mode 100644 index ff977869..00000000 --- a/changelog/209.trivial.rst +++ /dev/null @@ -1 +0,0 @@ -Added explicit support for numpy 2.0. diff --git a/changelog/212.doc.rst b/changelog/212.doc.rst deleted file mode 100644 index fe82a04c..00000000 --- a/changelog/212.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Updated all of the examples with cleaner plots and some minor english style tweaks. diff --git a/changelog/215.bugfix.rst b/changelog/215.bugfix.rst deleted file mode 100644 index b4c8d07b..00000000 --- a/changelog/215.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Within `sunkit_image.enhance.mgn`, the input data is now cast to float32 to work around int/float being cast to each other causing an error. diff --git a/changelog/215.trivial.rst b/changelog/215.trivial.rst deleted file mode 100644 index e03fbfba..00000000 --- a/changelog/215.trivial.rst +++ /dev/null @@ -1 +0,0 @@ -Added unit tests with a JSOC cutout file. diff --git a/changelog/218.feature.rst b/changelog/218.feature.rst deleted file mode 100644 index 51a3b3c6..00000000 --- a/changelog/218.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added a gallery example :ref:`sphx_glr_generated_gallery_detecting_swirls.py` demonstrating the usage of the `sunkit_image.asda` module for detecting swirls in the solar atmosphere. diff --git a/changelog/223.breaking.rst b/changelog/223.breaking.rst deleted file mode 100644 index 8f8b177d..00000000 --- a/changelog/223.breaking.rst +++ /dev/null @@ -1 +0,0 @@ -Increased the minimum required version of ``sunpy`` to the latest LTS version 6.0.0 diff --git a/changelog/231.breaking.rst b/changelog/231.breaking.rst deleted file mode 100644 index e9b4709d..00000000 --- a/changelog/231.breaking.rst +++ /dev/null @@ -1 +0,0 @@ -All functions under (`sunkit_image.radial`) now have a settable fill value which now defaults to NaN instead of 0. diff --git a/changelog/231.bugfix.rst b/changelog/231.bugfix.rst deleted file mode 100644 index 887e5583..00000000 --- a/changelog/231.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Improved the Radial Histogram Equalizing Filter (RHEF) (`sunkit_image.radial.rhef`) to work with images outside of SDO/AIA. diff --git a/changelog/238.doc.rst b/changelog/238.doc.rst deleted file mode 100644 index b4da13b9..00000000 --- a/changelog/238.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Added a new example showcasing advanced usage of Wavelets Optimized Whitening (WOW) at :ref:`sphx_glr_generated_gallery_advanced_wow.py` diff --git a/changelog/243.breaking.rst b/changelog/243.breaking.rst deleted file mode 100644 index 63a23800..00000000 --- a/changelog/243.breaking.rst +++ /dev/null @@ -1,3 +0,0 @@ -The function ``set_attenuation_coefficients`` has been removed from the public API. - -Now you can pass in the inputs used by ``set_attenuation_coefficients`` directly into `sunkit_image.radial.fnrgf`, which now accepts ``mean_attenuation_range`` and ``std_attenuation_range``.