JuliaImages / JuliaImages/juliaimages.github.io
Ordering of axes & dimensions
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 33
- Forks
- 52
- PR merge metrics
- No merged PRs in 30d
Description
Really enjoying the API of this package.
A bit confused by https://juliaimages.org/latest/pkgs/axes/#Names-and-locations. By convention, x is horizontal and y is vertical. But this does not seem to be the case:
A = rand(10,20,5);
axisA = AxisArray(A, (:x, :y, :z), (1μm, 2μm, 3μm))
Gray.(axisA[:,:,1])
# a horizontal rectangle appears
Perhaps documentation should use (:y, :x, :z)?
Contributor guide
No contributing guide indexed for this repository
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 with the “Names and locations” section at the linked documentation page and reproduce the AxisArray example with the stated x, y, and z axes. Check whether the rendered rectangle matches the documented convention, then update the example or its explanation so the axis ordering and expected orientation are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100