Skip to content

Commit d1a4afb

Browse files
bug fixes according to discussion
1 parent 5d1e583 commit d1a4afb

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

docs/src/czt.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# CZTs
2-
Chirp Z Transformations:
2+
Chirp Z Transformations: Allows Fourier-transformation and at the same time zooming into the result,
3+
which is why it is also called the Zoomed-FFT algorithm.
4+
The algorithm is based on a publication [Rabiner, Schafer, Rader, The Cirp z-Transform Algorithm, IEEE Trans AU 17(1969) p. 86] and a matlab Version written by the group of H. Gross. It currently needs three FFTs to perform its work.
5+
As one of these FFTs only depends on the datasize and zoom parameters, it can be moved to a plan in future implementations.
36

47
```@docs
58
FourierTools.czt

src/czt.jl

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,11 @@ The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be
9696
9797
# Arguments:
9898
+ `xin`: array to transform
99-
+ `scale`: a tuple of factors (one for each dimension) to zoom into during the czt. Note that a factor of nothing (or 1.0) needs to be provided, if a dimension is not transformed.
99+
+ `scale`: a tuple of factors (one for each dimension) to zoom into during the czt.
100+
Note that a factor of nothing (or 1.0) needs to be provided, if a dimension is not transformed.
100101
+ `dims`: a tuple of dimensions over which to apply the czt.
101-
+ `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.
102+
+ `remove_wrap`: if true, the wrapped places will be set to zero.
103+
Note that the `pad_value` argument is only allowed for czt_1d to not cause confusion.
102104
103105
#Example:
104106
```jdoctest
@@ -163,7 +165,8 @@ The tuple `scale` defines the zoom factors in the Fourier domain. Each has to be
163165
164166
# Arguments:
165167
+ `xin`: array to transform
166-
+ `scale`: a tuple of factors (one for each dimension) of the the inverse czt. Note that a factor of nothing (or 1.0) needs to be provided, if a dimension is not transformed.
168+
+ `scale`: a tuple of factors (one for each dimension) of the the inverse czt.
169+
Note that a factor of nothing (or 1.0) needs to be provided, if a dimension is not transformed.
167170
+ `dims`: a tuple of dimensions over which to apply the inverse czt.
168171
+ `remove_wrap`: if true, the wrapped places will be set to zero.
169172
Note that the `pad_value` argument is only allowed for 1d czts to not cause confusion.

src/resampling.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ By default the first pixel maintains its position. However, this leads to a shif
138138
`keep_singleton=true` will not upsample dimensions of size one.
139139
Note that upsample2 is based on Fourier-shifting and you may have to deal with wrap-around problems.
140140
141-
```jdoctest
141+
```jldoctest
142142
julia> upsample2(collect(collect(1.0:9.0)'))
143143
2×18 Matrix{Float64}:
144144
1.0 0.24123 2.0 3.24123 3.0 2.93582 4.0 5.0 5.0 5.0 6.0 7.06418 7.0 6.75877 8.0 9.75877 9.0 5.0
@@ -190,7 +190,7 @@ per entry along this dimension number.
190190
+ `new_size`: size of the result array. If not provided the same as the input size will be used.
191191
192192
# Examples
193-
```jdoctest
193+
```jldoctest
194194
julia> using TestImages, NDTools, View5D
195195
196196
julia> a = Float32.(testimage("resolution"));
@@ -297,7 +297,7 @@ using `resample_czt()` with separable quadratic zooms.
297297
298298
See also: `resample_czt()`
299299
# Examples
300-
```jdoctest
300+
```jldoctest
301301
julia> using TestImages, NDTools, View5D
302302
303303
julia> a = Float32.(testimage("resolution"))
@@ -344,7 +344,7 @@ the result has usually less artefacts, but the positions may be more less conven
344344
345345
See also: `resample`, `resample_czt`
346346
# Examples
347-
```jdoctest
347+
```jldoctest
348348
julia> using FourierTools, TestImages, NDTools, View5D, IndexFunArrays
349349
350350
julia> a = Float32.(testimage("resolution"));

0 commit comments

Comments
 (0)