[essimaging] `maximum_resolution_achievable` should not hardcode "time" as the "third" dimension
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 3
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 17
Description
Currently one of the arguments to maximum_resolution_achievable function (https://scipp.github.io/essimaging/generated/modules/ess.imaging.tools.resolution.maximum_resolution_achievable.html#ess.imaging.tools.resolution.maximum_resolution_achievable) is the bin-edges of the time coordinate.
This is not very flexible, sometimes the third coordinate is wavelength or event_time_offset or maybe something different.
To fix this we should rename the argument and update the documentation, and maybe the implementation, to make it clear the third argument can be a non-time dimension.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at ess.imaging.tools.resolution.maximum_resolution_achievable and its generated documentation entry. Review how the third coordinate argument is named and used, then update the argument and documentation so it clearly supports wavelength, event_time_offset, or another non-time dimension.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100