renamed function, added test, beautified line-wraps

Author: RainerHeintzmann

src/czt.jl

@@ -1,7 +1,7 @@
 export czt, iczt
 
 """
-    czt_1d(xin , scaled , d; kill_wrap=false, pad_value=zero(eltype(xin)))
+    czt_1d(xin , scaled , d; remove_wrap=false, pad_value=zero(eltype(xin)))
 
 Chirp z transform along a single direction d of an ND array `xin` into the ND array 'xout'.
 Note that xin and xout can be the same array for inplace operations.
@@ -14,11 +14,11 @@ This code is based on a 2D Matlab version of the CZT, written by H. Gross et al.
 + `xin`: array to transform
 + `scaled`: factor to zoom into during the 1-dimensional czt. 
 + `d`: single dimension to transform (as a tuple)
-+ `kill_wrap`: if true, the wrapped places will be set to pad_value
-+ `pad_value`: the value that the wrap-around will be set to if `kill_wrap` is `true`. 
++ `remove_wrap`: if true, the wrapped places will be set to pad_value
++ `pad_value`: the value that the wrap-around will be set to if `remove_wrap` is `true`. 
 
 """
-function czt_1d(xin, scaled, d; kill_wrap=false, pad_value=zero(eltype(xin)))
+function czt_1d(xin, scaled, d; remove_wrap=false, pad_value=zero(eltype(xin)))
     sz=size(xin)
     # returns the real datatype
     rtype = real(eltype(xin))  
@@ -74,7 +74,7 @@ function czt_1d(xin, scaled, d; kill_wrap=false, pad_value=zero(eltype(xin)))
             NDTools.slice(xout,d, o) .-= NDTools.slice(xin,d, 1) .* (1im).^mod(o-midp,4)
         end
     end
-    if kill_wrap && (scaled < 1.0)
+    if remove_wrap && (scaled < 1.0)
         nsz = Tuple(d == nd ? ceil(Int64, scaled * size(xin,d)) : size(xin,nd) for nd=1:ndims(xin))
         return select_region(select_region(xout, new_size=nsz), new_size=size(xout), pad_value=pad_value)
     else
@@ -84,7 +84,7 @@ function czt_1d(xin, scaled, d; kill_wrap=false, pad_value=zero(eltype(xin)))
 end
 
 """
-    czt(xin , scale, dims=1:length(size(xin)), kill_wrap=false)
+    czt(xin , scale, dims=1:length(size(xin)), remove_wrap=false)
 Chirp z transform of the ND array `xin`
 This code is based on a 2D Matlab version of the CZT, written by H. Gross.
 The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be bigger than one.
@@ -97,7 +97,7 @@ The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be
 + `xin`: array to transform
 + `scale`: a tuple of factors (one for each dimension) to zoom into during the czt. 
 + `dims`: a tuple of dimensions over which to apply the czt.
-+ `kill_wrap`: if true, the wrapped places will be set to zero. Note that the `pad_value` argument is only allowed for 1d czts to not cause confusion.
++ `remove_wrap`: if true, the wrapped places will be set to zero. Note that the `pad_value` argument is only allowed for 1d czts to not cause confusion.
 
 #Example:
 ```jdoctest
@@ -134,16 +134,17 @@ julia> zoomed = real.(ift(xft))
   0.0239759   -0.028264    0.0541186  -0.0116475   -0.261294   0.312719  -0.261294  -0.0116475    0.0541186  -0.028264
 ```
 """
-function czt(xin::Array{T,N}, scale, dims=1:length(size(xin)); kill_wrap=false)::Array{complex(T),N} where {T,N}
+function czt(xin::Array{T,N}, scale, dims=1:length(size(xin)); 
+            remove_wrap=false)::Array{complex(T),N} where {T,N}
     xout = xin
     for d in dims
-        xout = czt_1d(xout, scale[d], d; kill_wrap=kill_wrap)
+        xout = czt_1d(xout, scale[d], d; remove_wrap=remove_wrap)
     end
     return xout
 end
 
 """
-    iczt(xin , scale, dims=1:length(size(xin)); kill_wrap=false)
+    iczt(xin , scale, dims=1:length(size(xin)); remove_wrap=false)
 Inverse chirp z transform of the ND array `xin`
 This code is based on a 2D Matlab version of the CZT, written by H. Gross.
 The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be bigger than one.
@@ -154,7 +155,8 @@ The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be
 + `xin`: array to transform
 + `scale`: a tuple of factors (one for each dimension) of the the inverse czt. 
 + `dims`: a tuple of dimensions over which to apply the inverse czt.
-+ `kill_wrap`: if true, the wrapped places will be set to zero. Note that the `pad_value` argument is only allowed for 1d czts to not cause confusion.
++ `remove_wrap`: if true, the wrapped places will be set to zero. 
+                 Note that the `pad_value` argument is only allowed for 1d czts to not cause confusion.
 
 #See also: czt, czt_1d
 
@@ -193,6 +195,6 @@ julia> iczt(xft,(1.2,1.3))
  -0.0965531+0.0404296im  -0.159713+0.0637132im    0.48095+0.0775406im    0.67753-0.263814im        0.77553-0.121603im    0.660335-0.00736904im   0.495205-0.135059im   -0.163859+0.125535im
  ```
 """
-function iczt( xin , scale, dims=1:length(size(xin)); kill_wrap=false)
-    conj(czt(conj(xin), scale, dims; kill_wrap=kill_wrap)) / prod(size(xin))
+function iczt( xin , scale, dims=1:length(size(xin)); remove_wrap=false)
+    conj(czt(conj(xin), scale, dims; remove_wrap=remove_wrap)) / prod(size(xin))
 end