Fix small things

bionanoimaging · Mar 31, 2024 · 3d33774 · 3d33774 · roflmaostc · Mar 31, 2024
1 parent be5dba4
commit 3d33774
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 69 deletions.
diff --git a/Manifest.toml b/Manifest.toml
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "NDTools"
 uuid = "98581153-e998-4eef-8d0d-5ec2c052313d"
 authors = ["Rainer Heintzmann <[email protected]>", "Felix Wechsler <[email protected]>"]
-version = "0.5.3"
+version = "0.6.0"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

diff --git a/docs/src/dims.md b/docs/src/dims.md
@@ -6,4 +6,5 @@ expand_size
 select_sizes
 select_sizes_squeeze
 reorient
+idx_to_dim
 ```
diff --git a/src/generation_tools.jl b/src/generation_tools.jl
@@ -1,5 +1,5 @@
 ## generation_tools.jl
-export get_scan_pattern, ϕ_tuple, idx_to_dim
+export ϕ_tuple, idx_to_dim
 
 
 """
@@ -21,7 +21,7 @@ Arguments:
 ## conversion_tools.jl
 
 """
-    idx_to_dim(idx_arr)  # this should be a view
+    idx_to_dim(idx_arr) 
 
 Converts an N-dimensional array of NTuple to an N+1 dimensional array by orienting the (inner) tuple along the (outer) trailing+1 dimension.
 
@@ -41,7 +41,7 @@ julia> idx_to_dim([(x,y) for x in 1:3, y in 1:3])
  1  2  3
  1  2  3
  1  2  3
- ```
+```
 """
 function idx_to_dim(idx_arr::AbstractArray{T, N}) where {T, N} 
     out_arr = Array{typeof(idx_arr[1][1])}(undef, size(idx_arr)..., length(idx_arr[begin]))

diff --git a/src/selection_tools.jl b/src/selection_tools.jl
@@ -448,10 +448,11 @@ function select_region(src::AbstractArray{T,N}; M=nothing,
 end
 
 """
-function select_region(src::AbstractArray{T,N}, new_size; M=nothing, 
-    center=size(src).÷2 .+1, pad_value=zero(eltype(src)), dst_center = new_size .÷ 2 .+1) where {T,N}
+    select_region(src::AbstractArray{T,N}, new_size; M=nothing, 
+                  center=size(src).÷2 .+1, pad_value=zero(eltype(src)), dst_center = new_size .÷ 2 .+1) where {T,N}
+
 
-alias to select_region(src; new_size=new_size, center=center, pad_value=pad_value, dst_center=dst_center)
+Alias to `select_region(src; new_size=new_size, center=center, pad_value=pad_value, dst_center=dst_center)`
 """
 function select_region(src::AbstractArray{T,N}, new_size; M=nothing, 
     center=size(src).÷2 .+1, pad_value=zero(eltype(src)), dst_center = new_size .÷ 2 .+1) where {T,N}

diff --git a/test/selection_tools.jl b/test/selection_tools.jl
@@ -75,6 +75,7 @@
                 nc = Tuple(rand(1:5) for q in 1:d)
                 pad = rand()
                 @test all(select_region(a,new_size=nsz, center=nc, pad_value=pad) .== select_region(a,new_size=nsz, center=nc, pad_value=pad))
+                @test all(select_region(a, nsz, center=nc, pad_value=pad) .== select_region(a,new_size=nsz, center=nc, pad_value=pad))
                 @test all(select_region(a, nsz; center=nc, pad_value=pad) .== select_region(a,new_size=nsz, center=nc, pad_value=pad))
             end
         end
@@ -88,6 +89,7 @@
         function f(a,b) a.+=1 end # user-defined function
         @test all(select_region!(2 .*a, a, operator! = f) .== 2) # let the operator add one to destination
         @test select_region(collect(1:10), new_size=(5,), center=(1,), dst_center=(1,)) == collect(1:5)
+        @test select_region_view(collect(1:10), (5,), center=(1,), dst_center=(1,)) == collect(1:5)
         @test select_region_view(collect(1:10), new_size=(5,), center=(1,), dst_center=(1,)) == collect(1:5)
         @test select_region_view(collect(1:10), (5,); center=(1,), dst_center=(1,)) == collect(1:5) # test the alias
         a = ones(10,10)
@@ -96,6 +98,7 @@
         @test all(a[1:4,1:4] .== 1) # check part of the non-overwritten part
         a = ones(10,10)
         b = 4*ones(70,70)
+        select_region!(b, a, size(a), dst_center=(-20,20));
         select_region!(b, a, dst_center=(-20,20));
         @test all(a .== 4) # check the automatic selection of a large enough new_size
     end