JuliaImages / JuliaImages/ImageDraw.jl
RectanglePoints confuses me
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 27
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
When using CartesianIndex to define a rectangle, the resulting rectangle is not bounded by the pixels mentioned in the CartesianIndex.
Example:
julia> RectanglePoints(CartesianIndex(1,2), CartesianIndex(3,4))
RectanglePoints(Point(1, 2), Point(3, 4))
But Point(1, 2) is the pixel with CartesianIndex(2,1).
The definition says:
RectanglePoints(p1::CartesianIndex{2}, p2::CartesianIndex{2}) = RectanglePoints(Point(p1[1], p1[2]), Point(p2[1], p2[2]))
To me it would make a lot more sense to define it as
RectanglePoints(p1::CartesianIndex{2}, p2::CartesianIndex{2}) = RectanglePoints(Point(p1[2], p1[1]), Point(p2[2], p2[1]))
Of course this would be breaking.
Am I just thinking about this the wrong way?
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 at the RectanglePoints constructor overload for CartesianIndex{2} and reproduce the example from the issue. Compare its coordinate ordering with the surrounding Point and CartesianIndex conventions and inspect relevant call sites before deciding whether the behavior should change. Done means an agreed, documented API decision with regression coverage, accounting for the breaking-change concern.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- computer-graphics
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100