Skip to content

Commit f1fa677

Browse files
updated docs and removed export
1 parent 5f27c6c commit f1fa677

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

docs/src/utils.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@ FourierTools.select_region
66
FourierTools.center_set!
77
FourierTools.get_indices_around_center
88
FourierTools.center_extract
9+
FourierTools.odd_view
10+
FourierTools.fourier_reverse!
911
```

src/utils.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export rft_size, fft_center, fftpos
22
export expanddims, fourierspace_pixelsize, realspace_pixelsize
33
export δ
4-
export odd_view, fourier_reverse!
4+
export fourier_reverse!
55

66

77
#get_RFT_scale(real_size) = 0.5 ./ (max.(real_size ./ 2, 1)) # The same as the FFT scale but for the full array in real space!
@@ -403,10 +403,11 @@ end
403403
"""
404404
odd_view(arr)
405405
406-
creates a view of `arr` the for each even dimension excludes the
406+
creates a view of `arr` that for each even dimension excludes the
407407
starting index yielding a view of the array with only odd dimensions.
408408
This is useful for operations in Fourier-space which should leave the first index unaltered
409409
such as reverse!
410+
Note that an array reversal can also be achieved by using two ffts instead of one fft and one ifft.
410411
411412
# Examples
412413
```jldoctest

0 commit comments

Comments
 (0)