Add WCS.celestial examples to the docs
- Dominant language
- Python
- Stars
- 127
- Forks
- 74
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 2
Description
Sometimes users will encounter this error:
```
NotImplementedError: Currently only data with a 2-d celestial WCS can be reprojected using flux-conserving algorithm
```
when trying to reproject 2D data with extra dimensions in the WCS. The solution is very easy, just use `wcs.celestial`, i.e., the celestial subset of the WCS, instead of the full 3D or 4D WCS. There's presently no example of this in the reproject docs (at least as far as I could see by searching), so we should add one.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the existing reproject documentation examples and locate the section covering flux-conserving reprojection. Add an example showing that 2D data with extra WCS dimensions can be handled with wcs.celestial, and confirm the documented example addresses the reported NotImplementedError.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100