Removed
fix_observer_locationas it is no longer needed. (#346)Due to the temporary shutdown of the JSOC, many of the functions within
aiapyare currently not functioning as they rely on the JSOC to retrieve data.In an effort to enable other sources of data to be provided to the broken functions, the following breaking changes have been made:
- aiapy.calibrate.correct_degradation: The "calibration_version" keyword has been removed and "correction_table" is now a required argument. To get a correction table, one can use the aiapy.calibrate.util.get_correction_table. This allows one to select between, JSOC, SSW, or a custom correction table. For SSW, the correction table will be the latest version of the SSW correction table (V10). If you want to use the JSOC, you can pass in "jsoc" as a string argument.
- aiapy.calibrate.estimate_error: "error_table" is now a required argument. To get the error table, one can use the aiapy.calibrate.util.get_error_table. By default, this function will fetch the most recent version of the error table (V3) from SSW.
- aiapy.response.channel.Channel.eve_correction: "correction_table" is now a required argument.
- As in aiapy.calibrate.correct_degradation, one can use the aiapy.calibrate.util.get_correction_table to get the correction table.
- aiapy.calibrate.update_pointing: "pointing_table" is now a required argument. To get the pointing table, one can use aiapy.calibrate.util.get_pointing_table. This function now has a "source" keyword which can be used to select between "JSOC" (plus a start and end time) and "LMSAL" to get a copy of the pointing information dated from 11/20/2024 stored on LMSAL servers.
Note that many of the files from SSW are not updated with any frequency and provide worse results than using the data from the JSOC. (#346)
- Use ~sunpy.map.GenericMap.reference_date when constructing an observer coordinate and in place
of pulling
T_OBSdirectly from the header. (#345)
- Fixed Spike issue with data being loaded as floats.
- All inputs and outputs that previously used "counts" or "ct" now use "DN". (#338)
- Minimum version of
sunpysupported is nowsunpy6.0.0
- Removed the
aiapy.calibrate.normalize_exposurefunction. The same functionality can be achieved by dividing a ~sunpy.map.Map by the exposure time property,my_map / my_map.exposure_time. (#182) - All the functions in aiapy, that took keywords have been made to only accept them as keyword arguments. This means that you can no longer pass them as positional arguments. (#313)
- Removed
setup.cfgandsetup.pyfiles, this means you will need to use a modern version of pip (23.0 or above) to install this package now. (#313) - Increased the minimum version of Python to 3.10 (#313)
- Downgraded warning for Multiple Valid Epochs (aiapy.util.util._select_epoch_from_correction_table) to a logging debug message. (#318)
- Added extra mirrors to fetch files from SSW. (#322)
- Cleaned up notes on AIA data preparation and included respiking procedure in the list of steps. (#182)
- Transformed the documentation layout. (#318)
- Fixed incorrect IDL routine reference in the aiapy.calibrate.estimate_error documentation. (#322)
- Improved the "Requesting specific AIA images from the JSOC" Example to animate and use Fido instead of DRMS. (#323)
- Catch all erfa.core.ErfaWarning that are raised when we convert the times from the error and degradation tables into UTC while making them astropy.time.Time objects. (#324)
- Fixed mismatch with the sample data downloder.
- Fixed theme build to use the new sunpy theme.
- Fixed missing citation. (#177)
- Fixed missing citation. (#177)
- Removed kwargs from
correct_degradation,degradationto ensure that the correct keywords are passed into these functions and the function calls that require these keywords. (#170) - Several private internal functions now raise ValueError instead of IndexError, some of these will now be raised to the user when calling
correct_degradation, therefore any code that checks for this error type will need updating. (#170)
- Improve error message for degradation with incorrect response table version. (#170)
- Fixed download issue for error tables and parfive due to a mirror change. (#172)
- Added a warning about
registerthat it will not return a 4096 by 4096 Map, but most likely a 4094 by 4094 Map. (#170)
- Added several tests to ensure that
degradationworks on all wavelengths and the ones it does not, raise the correct error. (#170)
- Change SSW mirror due to the old one being down. (#167)
- Minimum version of
Pythonsupported is nowPython3.8.0. (#159) - Minimum version of
sunpysupported is nowsunpy4.0.0 LTS. (#159) - :func:`aiapy.calibrate.register`
use_scipykeyword has been removed and replaced with amethodkeyword that defaults to usescipyby default. It is also possible to usescikit-imageoropencvorcupy(provided you have either one installed.) (#159)
- Added a "cupy" method to :func:`aiapy.calibrate.register` that will use cupy to do the affine_transform. (#159)
- Fixes a bug where columns in the pointing table used to update the pointing information were being converted to masked float values. This bugfix ensures that any column used in the pointing update does not have a mask and any values that are masked are filled with NaN. This bug arises in astropy>=5.0. (#151)
- Fixed escaping of characters in equations in multiple docstrings. (#146)
- Fixes a bug in aiapy.calibrate.update_pointing concerning how the row in 3-hourly
master pointing table is chosen.
Previously, the row with
T_STARTclosest toDATE_OBSwas chosen. Now, the row corresponding toT_OBSgreater than or equal toT_STARTAND less thanT_STOPis chosen. (#137) - Update the
x0_mpandy0_mpkeywords when updating the pointing information in aiapy.calibrate.update_pointing. (#140)
- In the case where a submap is passed into aiapy.calibrate.fetch_spikes, create the full-frame WCS directly from the submap WCS rather than creating an intermediate dummy full-frame map. (#139)
- Fixed a bug in the units on the table returned by aiapy.calibrate.util.get_pointing_table.
The
X0andY0columns were incorrectly being assigned units of arcseconds instead of pixels. (#132) - Fixed an off-by-one bug in aiapy.calibrate.update_pointing where the
CRPIX1andCRPIX2keywords were not being properly updated from theX0andY0columns in the master pointing table. (#132)
- Fixed a compatibility issue with sunpy>=3.1 in which creating a full-frame WCS in aiapy.calibrate.fetch_spikes was throwing an exception. (#126)
- Added a check on aiapy.calibrate.update_pointing so that passing in a submap or a map not at the full AIA resolution, raises an exception. (#127)
- Pin minimum version of Python to 3.7 (#114)
- Pin minimum version of sunpy to 3.0.0 LTS.
- Added a new function :func:`aiapy.util.telescope_number` that returns the associated telscope number for a given filter wavelength. (#116)
- Added a new function :func:`aiapy.calibrate.util.get_error_table` to fetch and parse the table with the associate error parameters. This is used primarily in :func:`aiapy.calibrate.estimate_error`. (#116)
- Added a new function :func:`aiapy.calibrate.estimate_error` to calculate the error for
a given set of AIA counts and the associated channel.
This is an exact port of the IDL function
aia_bp_estimate_error. (#116)
- aiapy.calibrate.update_pointing now skips updating keywords if the pointing values are missing from the pointing table returned from JSOC. (#120)
- Pin sunpy dependency to
<=3.0to allow for backwards compatibility withsearch_metadata. (#111)
- Add a flag to :func:`aiapy.psf.deconvolve` that sets negative intensity values to zero before performing the deconvolution. (#107)
- Added a function (:func:`aiapy.util.sdo_location`) to obtain the SDO location at a given time. (#57)
- Added a function (:func:`aiapy.calibrate.respike`) for reinserting hot pixels into level 1 images. (#62)
- Updated default calibration version to 10. Added test for version 10 (#90)
- Updated default calibration version number for degradation correction. Added tests for multiple calibration versions (#74)
- Fixed a bug where an out of date calibration epoch was used if there were older duplicate versions available in the same epoch. (#90)
- aiapy.calibrate.util.get_pointing_table now raises a more user-friendly RuntimeError if no pointing information can be found during the requested times. Previously it would raise a KeyError. (#91)
- aiapy.calibrate.update_pointing now searches 12 hours either side of the map date for pointing information. This allows for some very rare instances where more than 3 hours elapses between pointing information updates. (#91)
No significant changes.
- :func:`aiapy.calibrate.register` now raises a warning if the level number is missing or is greater than 1. (#94)
- Added a function (
aiapy.calibrate.normalize_exposure) to normalize an image by its exposure time. (#78) - :func:`aiapy.calibrate.degradation` can now accept ~astropy.time.Time objects with length greater than 1. This makes it easier to compute the channel degradation over long intervals. (#80)
- Citation information for aiapy is now available from
aiapy.__citation__. (#82) - The pointing table can now be passed in as a keyword argument to :func:`aiapy.calibrate.update_pointing`. Added a :func:`aiapy.calibrate.util.get_pointing_table` to retrieve the 3-hour pointing table from JSOC over a given time interval. (#84)
- The
CROTA2keyword update in :func:`aiapy.calibrate.update_pointing` now includes the value ofSAT_ROTfrom the FITS header. Previously, the keyword was only being updated withINSTROT. (#84)
- Functionality for respiking level 1 images and fetching spike data from JSOC
- Updated calibration data now fetched from JSOC to account for instrument degradation
- Compatibility fix with sunpy > 2.0.0 which previously caused level 1.5 maps to expand by several pixels
- Functionality for fetching the location of SDO in time
- Update pointing keywords in the header using the 3-hour pointing values from the JSOC
- Correct Heliographic Stonyhurst observer location
- Register images by removing the roll angle, centering the image, and scaling to a common resolution (i.e. "aia_prep")
- Calculate wavelength response functions for all channels, including time-dependent effects
- Account for channel degradation in image correction
- Compute the point spread function and deconvolve an image with the point spread function (with optional GPU acceleration)