Add sensible error message for specutils loaders
#1709
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When users try to ingest a `spec1d` file into a Spectrum1D object, the current scheme ends badly with an obscure error message like: ``` OSError: Could not identify column containing the wavelength, frequency or energy ``` Because PypeIt `spec1d` files may have multiple extensions, by convention we load these into SpectrumList objects in specutils, even if there is only a single spectrum. This commit catches the case when a user tries to load a `spec1d` file into a Spectrum1D object. Previously, such an attempt ended up with specutils loading in the `spec1d` file as a tabular FITS format, then didn't know what to do about the spectral axis (leading to the above obscure error). This commit specifically includes a loader for `spec1d` files into Spectrum1D objects, but emits a sensible error message in this case rather than trying to actually load the file. As it happens, in order to properly do this, I needed to make an adjustment in specutils itself. A PR has been submitted (astropy/specutils#1068), but this commit should not be considered as a PypeIt PR until the specutils change has incorporated into an official release. At that time, the specutils optional dependency will need to have a minimum version specified. So... this commit will quietly sit in a branch until specutils makes its move. modified: pypeit/specutils/pypeit_loaders.py
modified: setup.cfg
modified: doc/releases/1.14.1dev.rst modified: setup.cfg
Codecov Report
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. @@ Coverage Diff @@
## specutil_wave #1709 +/- ##
=================================================
- Coverage 41.07% 41.06% -0.01%
=================================================
Files 190 190
Lines 43649 43652 +3
=================================================
Hits 17927 17927
- Misses 25722 25725 +3
|
profxj
approved these changes
Oct 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When users try to ingest a
spec1dfile into a Spectrum1D object, the currentscheme ends badly with an obscure error message like:
Because PypeIt
spec1dfiles may have multiple extensions, by convention weload these into SpectrumList objects in specutils, even if there is only a
single spectrum. This commit catches the case when a user tries to load a
spec1dfile into a Spectrum1D object. Previously, such an attempt ended upwith specutils loading in the
spec1dfile as a tabular FITS format, thendidn't know what to do about the spectral axis (leading to the above obscure
error).
This commit specifically includes a loader for
spec1dfiles into Spectrum1Dobjects, but emits a sensible error message in this case rather than trying to
actually load the file.
As it happens, in order to properly do this, I needed to make an adjustment in
specutilsitself. That PR (astropy/specutils#1068), wasfinally included in
specutilsversion 1.12 (released 2023-10-17).The
specutilsoptional dependency has been updated to require this version.