Skip to content

Update Zygote and NDTools compat #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update Zygote and NDTools compat #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d6e341
CompatHelper: bump compat for NDTools to 0.8, (keep existing compat)
Apr 6, 2025
b6aea44
Merge branch 'main' into compathelper/new_version/2025-04-06-01-09-33…
abhro May 15, 2025
d575108
Replace ignore => ignore_derivatives
ederag Jun 29, 2025
97998ce
Bump compat for Zygote to 0.7
ederag Jun 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ EllipsisNotation = "1"
FFTW = "1"
FourierTools = "0.4"
IndexFunArrays = "0.2"
NDTools = "0.5, 0.6, 0.7"
Zygote = "0.6.60"
NDTools = "0.5, 0.6, 0.7, 0.8"
Zygote = "0.6.60, 0.7"
julia = "1.9"

[extras]
Expand Down
8 changes: 4 additions & 4 deletions src/angular_spectrum.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ function _prepare_angular_spectrum(field::AbstractArray{CT}, z, λ, _L;
fieldp = padding ? pad(field, pad_factor2) : field

# helpful propagation variables
(; k, f_x, f_y, x, y) = Zygote.@ignore _propagation_variables(fieldp, λ, Lp)
(; k, f_x, f_y, x, y) = ChainRulesCore.@ignore_derivatives _propagation_variables(fieldp, λ, Lp)

# transfer function kernel of angular spectrum
H = exp.(1im .* k .* abs.(z) .* sqrt.(CT(1) .- abs2.(f_x .* λ) .- abs2.(f_y .* λ)))
Expand All @@ -40,13 +40,13 @@ function _prepare_angular_spectrum(field::AbstractArray{CT}, z, λ, _L;
# as addition we introduce a smooth bandlimit with a Hann window
# and fuzzy logic
Δu = 1 ./ Lp
u_limit = Zygote.@ignore 1 ./ (sqrt.((2 .* Δu .* z).^2 .+ 1) .* λ)
u_limit = ChainRulesCore.@ignore_derivatives 1 ./ (sqrt.((2 .* Δu .* z).^2 .+ 1) .* λ)

# y and x positions in real space, use correct spacing -> fftpos
y1 = similar(field, real(eltype(field)), (size(field, 1), 1))
Zygote.@ignore y1 .= (fftpos(L[1], size(field, 1), CenterFT))
ChainRulesCore.@ignore_derivatives y1 .= (fftpos(L[1], size(field, 1), CenterFT))
x1 = similar(field, real(eltype(field)), (1, size(field, 2)))
Zygote.@ignore x1 .= (fftpos(L[2], size(field, 2), CenterFT))'
ChainRulesCore.@ignore_derivatives x1 .= (fftpos(L[2], size(field, 2), CenterFT))'

params = Params(y1, x1, y1, x1, L, L)

Expand Down
6 changes: 3 additions & 3 deletions src/fraunhofer.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ function fraunhofer(U, z, λ, L; skip_final_phase=true)
L_new = λ * z / L * size(U, 1)
Ns = size(U)[1:2]

p = Zygote.@ignore plan_fft(U, (1,2))
p = ChainRulesCore.@ignore_derivatives plan_fft(U, (1,2))

if skip_final_phase
out = fftshift(p * ifftshift(U)) ./ √(size(U, 1) * size(U, 2))
else
k = eltype(U)(2π) / λ
# output coordinates
y = similar(U, real(eltype(U)), (Ns[1], 1))
Zygote.@ignore y .= (fftpos(L, Ns[1], CenterFT))
ChainRulesCore.@ignore_derivatives y .= (fftpos(L, Ns[1], CenterFT))
x = similar(U, real(eltype(U)), (1, Ns[2]))
Zygote.@ignore x .= (fftpos(L, Ns[2], CenterFT))'
ChainRulesCore.@ignore_derivatives x .= (fftpos(L, Ns[2], CenterFT))'
phasefactor = (-1im) .* exp.(1im * k / (2 * z) .* (x.^2 .+ y.^2))
out = phasefactor .* fftshift(p * ifftshift(U)) ./ √(size(U, 1) * size(U, 2))
end
Expand Down
6 changes: 3 additions & 3 deletions src/shifted_angular_spectrum.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ function _prepare_shifted_angular_spectrum(field::AbstractArray{CT}, z, λ, L,
field_new = padding ? pad(field, pad_factor2) : field

# helpful propagation variables
(; k, f_x, f_y, x, y) = Zygote.@ignore _propagation_variables(field_new, λ, L_new)
(; k, f_x, f_y, x, y) = ChainRulesCore.@ignore_derivatives _propagation_variables(field_new, λ, L_new)


H = exp.(1im .* k .* z .* (sqrt.(CT(1) .- abs2.(f_x .* λ .+ sxy[2]) .- abs2.(f_y .* λ .+ sxy[1]))
Expand All @@ -52,9 +52,9 @@ function _prepare_shifted_angular_spectrum(field::AbstractArray{CT}, z, λ, L,
shift = txy .* z

ya = similar(field_new, real(eltype(field)), (size(field_new, 1), 1))
Zygote.@ignore ya .= (fftpos(L_new[1], size(field_new, 1), CenterFT)) .+ shift[1]
ChainRulesCore.@ignore_derivatives ya .= (fftpos(L_new[1], size(field_new, 1), CenterFT)) .+ shift[1]
xa = similar(field_new, real(eltype(field)), (1, size(field_new, 2)))
Zygote.@ignore xa .= (fftpos(L_new[2], size(field_new, 2), CenterFT))' .+ shift[2]
ChainRulesCore.@ignore_derivatives xa .= (fftpos(L_new[2], size(field_new, 2), CenterFT))' .+ shift[2]

ramp_before = ifftshift(exp.(1im .* 2 .* T(π) ./ λ .* (sxy[2] .* x .+ sxy[1] .* y)), (1,2))
ramp_after = ifftshift(exp.(1im .* 2 .* T(π) ./ λ .* (sxy[2] .* xa .+ sxy[1] .* ya)), (1,2))
Expand Down
Loading