diff --git a/CHANGELOG.rst b/CHANGELOG.rst index e69de29..9145638 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -0,0 +1,42 @@ +Stixpy 0.1.3 (2024-07-16) +========================= + +Features +-------- + +- Add a custom coordinate frame :class:`stixpy.coordinate.frames.STIXImaging` and the associated transformations (`~stixpy.coordinates.transforms.stixim_to_hpc`, `~stixpy.coordinates.transforms.hpc_to_stixim`) to and from `~sunpy.coordinates.frames.Helioprojective`. + Also add a `stixpy.map.stix.STIXMap` for `~sunpy.map.Map` source which properly displays the :class:`stixpy.coordinate.frames.STIXImaging` coordinate frame. (`#90 `__) +- Merged `stixpy.calibration.get_visibility_info_giordano` and `stixpy.calibration.get_visibility_info` into `stixpy.calibration.get_uv_points_data` and removed `stixpy.calibration.correct_phase_projection`. (`#98 `__) +- Update livetime correction parameter `eta`, `tau` and add code to calculate pileup 'beta' :func:`stixpy.calibration.livetime.pileup_correction_factor`. (`#100 `__) +- Add background subtraction step to imaging demo, update `EnergyEdgeMasks`. (`#106 `__) +- Update imaging demo to use images and construct `~sunpy.map.Map` using `~stixpy.coordinates.frames.STIXImaging` and `~sunpy.map.header_helper.make_fitswcs_header`. (`#107 `__) +- Update :func:`~stixpy.coordinates.transforms.get_hpc_info` to use mean or interpolate pointing and location data based on number of data points in given timerange. Add function cache for aux data frequenly needed during coordinate transforms. (`#111 `__) +- Make the imaging demo compatible with :class:`~xrayvision.visibility.Visibilities` (`#123 `__) +- Update code and examples to use new :class:`~xrayvision.visibility.Visibilities`, tidy API of `~stixpy.imaging.em.em`. (`#124 `__) +- Add missing QL products `~stixpy.product.sources.quicklook.QLVariance`, `~stixpy.product.sources.quicklook.QLFlareFlag`, and `~stixpy.product.sources.quicklook.QLTMStatusFlareList` to Product. Also added some useful properties to the for status words. (`#125 `__) + + +Bug Fixes +--------- + +- Fix ELUT correction when the requested data has less then than 32 energy channels. (`#106 `__) +- Update `~stixpy.calibration.energy.get_elut` to use correct science energy channels for given date. (`#107 `__) +- Fix a bug where the incorrect unit was set on :class:`~stixpy.timeseries.quicklook.QLLightCurve`, :class:`~stixpy.timeseries.quicklook.QLBackground` and :class:`~stixpy.timeseries.quicklook.QLVariance`. (`#118 `__) +- Fix bug where coordinate transforms did not support arrays of coordinates or times. To so support both integrated (e.g. images) and instantaneous (e.g. coarse flare flag) a new property `obstime_end` was added to `~stixpy.coordinates.frames.STIXImaging` when set if possible mean pointing and position information are use for transformations other wise they are interpolated between the two nearest data points. (`#128 `__) +- Fix typo in `~stixpy.product.sources.science.ScienceData` 'durtaion' -> 'duration'. (`#132 `__) +- Fix some inconsistencies on the data units in plots, also return handle to the image from `~stixpy.product.sources.science.SpectrogramPlotMixin.plot_spectrogram`. (`#134 `__) +- Fix bug reintroduce by last fix in `~stixpy.imaging.em.em`, update code in `~stixpy.calibration.visibility.calibrate_visibility` and imaging demo to use Tx, Ty rather than Ty, Tx as before. (`#137 `__) + + +Improved Documentation +---------------------- + +- Update README, fix graphviz RTD configuration, configure theme logo text. (`#89 `__) +- Correct calculation of the HPC coordinate of the center of the STIX pointing in the imaging demo. (`#112 `__) +- Update imaging demo for latest changes in `xrayvision `_. (`#115 `__) + + +Trivial/Internal Changes +------------------------ + +- Format code with ruff and turn on ruff format in pre-commit. (`#116 `__) diff --git a/changelog/100.feature.rst b/changelog/100.feature.rst deleted file mode 100644 index 6e52d80..0000000 --- a/changelog/100.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Update livetime correction parameter `eta`, `tau` and add code to calculate pileup 'beta' :func:`stixpy.calibration.livetime.pileup_correction_factor`. diff --git a/changelog/106.bugfix.rst b/changelog/106.bugfix.rst deleted file mode 100644 index 0511860..0000000 --- a/changelog/106.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix ELUT correction when the requested data has less then than 32 energy channels. diff --git a/changelog/106.feature.rst b/changelog/106.feature.rst deleted file mode 100644 index 839c716..0000000 --- a/changelog/106.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Add background subtraction step to imaging demo, update `EnergyEdgeMasks`. diff --git a/changelog/107.bugfix.rst b/changelog/107.bugfix.rst deleted file mode 100644 index 66dde93..0000000 --- a/changelog/107.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Update `~stixpy.calibration.energy.get_elut` to use correct science energy channels for given date. diff --git a/changelog/107.feature.rst b/changelog/107.feature.rst deleted file mode 100644 index 71132ba..0000000 --- a/changelog/107.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Update imaging demo to use images and construct `~sunpy.map.Map` using `~stixpy.coordinates.frames.STIXImaging` and `~sunpy.map.header_helper.make_fitswcs_header`. diff --git a/changelog/111.feature.rst b/changelog/111.feature.rst deleted file mode 100644 index 40c4591..0000000 --- a/changelog/111.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Update :func:`~stixpy.coordinates.transforms.get_hpc_info` to use mean or interpolate pointing and location data based on number of data points in given timerange. Add function cache for aux data frequenly needed during coordinate transforms. diff --git a/changelog/112.doc.rst b/changelog/112.doc.rst deleted file mode 100644 index de914cc..0000000 --- a/changelog/112.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Correct calculation of the HPC coordinate of the center of the STIX pointing in the imaging demo. diff --git a/changelog/115.doc.rst b/changelog/115.doc.rst deleted file mode 100644 index b152e1c..0000000 --- a/changelog/115.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Update imaging demo for latest changes in `xrayvision `_. diff --git a/changelog/116.trivial.rst b/changelog/116.trivial.rst deleted file mode 100644 index 91e52a8..0000000 --- a/changelog/116.trivial.rst +++ /dev/null @@ -1 +0,0 @@ -Format code with ruff and turn on ruff format in pre-commit. diff --git a/changelog/118.bugfix.rst b/changelog/118.bugfix.rst deleted file mode 100644 index fd2f311..0000000 --- a/changelog/118.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix a bug where the incorrect unit was set on :class:`~stixpy.timeseries.quicklook.QLLightCurve`, :class:`~stixpy.timeseries.quicklook.QLBackground` and :class:`~stixpy.timeseries.quicklook.QLVariance`. diff --git a/changelog/123.feature.rst b/changelog/123.feature.rst deleted file mode 100644 index 3d0b4ec..0000000 --- a/changelog/123.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Make the imaging demo compatible with :class:`~xrayvision.visibility.Visibilities` diff --git a/changelog/124.feature.rst b/changelog/124.feature.rst deleted file mode 100644 index ebf6e2d..0000000 --- a/changelog/124.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Update code and examples to use new :class:`~xrayvision.visibility.Visibilities`, tidy API of `~stixpy.imaging.em.em`. diff --git a/changelog/125.feature.rst b/changelog/125.feature.rst deleted file mode 100644 index 78997da..0000000 --- a/changelog/125.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Add missing QL products `~stixpy.product.sources.quicklook.QLVariance`, `~stixpy.product.sources.quicklook.QLFlareFlag`, and `~stixpy.product.sources.quicklook.QLTMStatusFlareList` to Product. Also added some useful properties to the for status words. diff --git a/changelog/128.bugfix.rst b/changelog/128.bugfix.rst deleted file mode 100644 index ed5ef5f..0000000 --- a/changelog/128.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix bug where coordinate transforms did not support arrays of coordinates or times. To so support both integrated (e.g. images) and instantaneous (e.g. coarse flare flag) a new property `obstime_end` was added to `~stixpy.coordinates.frames.STIXImaging` when set if possible mean pointing and position information are use for transformations other wise they are interpolated between the two nearest data points. diff --git a/changelog/132.bugfix.rst b/changelog/132.bugfix.rst deleted file mode 100644 index 494d19c..0000000 --- a/changelog/132.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix typo in `~stixpy.product.sources.science.ScienceData` 'durtaion' -> 'duration'. diff --git a/changelog/134.bugfix.rst b/changelog/134.bugfix.rst deleted file mode 100644 index 39c3e88..0000000 --- a/changelog/134.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix some inconsistencies on the data units in plots, also return handle to the image from `~stixpy.product.sources.science.SpectrogramPlotMixin.plot_spectrogram`. diff --git a/changelog/137.bugfix.rst b/changelog/137.bugfix.rst deleted file mode 100644 index 4fc7177..0000000 --- a/changelog/137.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fix bug reintroduce by last fix in `~stixpy.imaging.em.em`, update code in `~stixpy.calibration.visibility.calibrate_visibility` and imaging demo to use Tx, Ty rather than Ty, Tx as before. diff --git a/changelog/89.doc.rst b/changelog/89.doc.rst deleted file mode 100644 index 7d6151c..0000000 --- a/changelog/89.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Update README, fix graphviz RTD configuration, configure theme logo text. diff --git a/changelog/90.feature.rst b/changelog/90.feature.rst deleted file mode 100644 index a9cbb95..0000000 --- a/changelog/90.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Add a custom coordinate frame :class:`stixpy.coordinate.frames.STIXImaging` and the associated transformations (`~stixpy.coordinates.transforms.stixim_to_hpc`, `~stixpy.coordinates.transforms.hpc_to_stixim`) to and from `~sunpy.coordinates.frames.Helioprojective`. -Also add a `stixpy.map.stix.STIXMap` for `~sunpy.map.Map` source which properly displays the :class:`stixpy.coordinate.frames.STIXImaging` coordinate frame. diff --git a/changelog/98.feature.rst b/changelog/98.feature.rst deleted file mode 100644 index b89eb23..0000000 --- a/changelog/98.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Merged `stixpy.calibration.get_visibility_info_giordano` and `stixpy.calibration.get_visibility_info` into `stixpy.calibration.get_uv_points_data` and removed `stixpy.calibration.correct_phase_projection`.