Skip to content

Commit ed39f6f

Browse files
committed
docs: add sampled transfer functions documentation
feat: add documentation for sampled PSFs and OTFs fix: correct type parameter order in apply function signature chore: reorder documentation pages and update navigation structure
1 parent cff872a commit ed39f6f

File tree

5 files changed

+18
-4
lines changed

5 files changed

+18
-4
lines changed

docs/make.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,11 @@ makedocs(;
3232
"General Interface" => "pages/02_interface.md",
3333
"Transfer Functions" => [
3434
"Transfer Function Models" => "pages/03_model_tfs.md",
35-
"Transfer Functions Measurements" => "pages/04_measured_tfs.md"],
35+
"Transfer Functions Measurements" => "pages/04_measured_tfs.md",
36+
"Sampled Transfer Functions" => "pages/05_sampled_tfs.md",],
3637
"References" => [
37-
"API" => "pages/05_apireference.md",
38-
"Bibliography" => "pages/06_bibliography.md"
38+
"API" => "pages/06_apireference.md",
39+
"Bibliography" => "pages/07_bibliography.md"
3940
]],
4041
plugins=[bib, links],
4142
# NOTE: doctesting is done in the `runtests.jl` so it is not necessary to do here

docs/src/pages/05_sampled_tfs.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
```@meta
2+
CurrentModule = TransferFunctions
3+
```
4+
5+
# Sampled PSFs
6+
```@docs
7+
apply(::SampledOTF{N, OTF} where OTF<:TransferFunctions.OpticalTransferFunction{N}, ::AbstractArray{T, N}) where {N, T}
8+
```
9+
10+
# Sampled OTFs
11+
```@docs
12+
apply(::SampledPSF{N, PSF} where PSF<:TransferFunctions.PointSpreadFunction{N}, ::AbstractArray{T, N}) where {T, N}
13+
```
File renamed without changes.
File renamed without changes.

src/sampled-otf.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ julia> img = testimage("moonsurface.tiff");
204204
julia> blurred_img = apply(sampled_otf, img);
205205
```
206206
"""
207-
apply(tf::SampledOTF{N}, img::AbstractArray{T,N}) where {N,T} = ifft(fft(gray.(img)) .* otf(tf, size(img)))
207+
apply(tf::SampledOTF{N}, img::AbstractArray{T,N}) where {T,N} = ifft(fft(gray.(img)) .* otf(tf, size(img)))
208208

209209
# FIX: Add support for N-dim <30-11-23>
210210
# @traitfn function otf_support(

0 commit comments

Comments
 (0)