permuteddimsview -> PermutedDimsArray

[vtjeng]

Summary

permutteddimsview is deprecated.

ImageCore.jl/src/deprecations.jl

Line 88 in c4d3bc9

Base.@deprecate_binding permuteddimsview PermutedDimsArray

We remove all references to this function (other than in tests specifically for deprecation), replacing it with PermutedDimsarray instead.

As part of this work, we re-ran the code in docs/src/views.md and updated it.

In particular, we remove a section that is now irrelevant ("A note on the return types from the views"). Here is the code that was written for that section:

Updated

Return types from views

DocTestSetup = quote
    using Colors, ImageCore
end

Consider the following examples with different input images.

In both instances, using the channelview returns a reinterpret
(but with different type parameters).

julia> img = [RGB(1,0,0) RGB(0,1,0);
              RGB(0,0,1) RGB(0,0,0)]
2×2 Array{RGB{N0f8},2} with eltype RGB{Normed{UInt8,8}}:
 RGB{N0f8}(1.0,0.0,0.0)  RGB{N0f8}(0.0,1.0,0.0)
 RGB{N0f8}(0.0,0.0,1.0)  RGB{N0f8}(0.0,0.0,0.0)

julia> cv = channelview(img)
3×2×2 reinterpret(N0f8, ::Array{RGB{N0f8},3}):
[:, :, 1] =
 1.0  0.0
 0.0  0.0
 0.0  1.0

[:, :, 2] =
 0.0  0.0
 1.0  0.0
 0.0  0.0

julia> img0 = rand(RGB{Float64}, 3, 2)
3×2 Array{RGB{Float64},2} with eltype RGB{Float64}:
 RGB{Float64}(0.721651,0.436883,0.0249213)  RGB{Float64}(0.838438,0.741055,0.289334)
 RGB{Float64}(0.314968,0.175824,0.392317)   RGB{Float64}(0.984615,0.186958,0.328459)
 RGB{Float64}(0.982128,0.922775,0.704911)   RGB{Float64}(0.967755,0.488064,0.780718)

julia> imgs = view(img0, 1:2:3, :)
2×2 view(::Array{RGB{Float64},2}, 1:2:3, :) with eltype RGB{Float64}:
 RGB{Float64}(0.721651,0.436883,0.0249213)  RGB{Float64}(0.838438,0.741055,0.289334)
 RGB{Float64}(0.982128,0.922775,0.704911)   RGB{Float64}(0.967755,0.488064,0.780718)

julia> channelview(imgs)
3×2×2 reinterpret(Float64, reshape(view(::Array{RGB{Float64},2}, 1:2:3, :), 1, 2, 2)):
[:, :, 1] =
 0.721651   0.982128
 0.436883   0.922775
 0.0249213  0.704911

[:, :, 2] =
 0.838438  0.967755
 0.741055  0.488064
 0.289334  0.780718

[codecov]

Codecov Report

Merging #143 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #143   +/-   ##
=======================================
  Coverage   55.14%   55.14%           
=======================================
  Files          10       10           
  Lines         457      457           
=======================================
  Hits          252      252           
  Misses        205      205           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c4d3bc9...92d830b. Read the comment docs.

[vtjeng]

@timholy It looks like I'm failing several unit tests here that aren't related to the code change. Specifically, starting at https://github.com/JuliaImages/ImageCore.jl/pull/143/checks?check_run_id=1173227622#step:5:318,

All errors:
===========================================
ArgumentError: Package ImageIO not found in current path:
- Run `import Pkg; Pkg.add("ImageIO")` to install the ImageIO package.

===========================================
ArgumentError: Package QuartzImageIO not found in current path:
- Run `import Pkg; Pkg.add("QuartzImageIO")` to install the QuartzImageIO package.

===========================================

UndefVarError: libwand not defined
===========================================
Fatal error:
4D inputs: Error During Test at /Users/runner/work/ImageCore.jl/ImageCore.jl/test/views.jl:235
  Got exception outside of a @test
  ArgumentError: Package ImageIO not found in current path:
  - Run `import Pkg; Pkg.add("ImageIO")` to install the ImageIO package.
...

Do you know what's going on here?

[johnnychen94]

This is due to the recent changes in BinaryBuilder and artifacts in julialang/julia, see also JuliaIO/ImageMagick.jl#189

I've disabled fail-fast in 16c688c, now I need to close and reopen to retrigger the test on the new base.

[johnnychen94]

Thanks for updating this.

I guess this documentation was written when @example feature is not yet implemented, would you mind to upgrade the code blocks with @example and jldoctest things? That could indeed help capture such kind of outdated docs in the future.

[vtjeng]

Okay, I've updated this and tested the doctests locally with

cd docs
julia --project --color=yes make.jl

This should be ready for another review.

[johnnychen94]

@vtjeng thank you very much for these updates!