Discussion about gauss_f

[roflmaostc]

Hi!
See:

PSFDistiller.jl/src/utils.jl

Line 36 in c5074a4

function gaussf(img::AbstractArray{T}, sigma=1.0; dtype=Float32) where (T <: Real)

I would probably implement it like:

function filter_gauss(img::AbstractArray{T}, sigma=one(T), dims=1:ndims(img)) where (T <: Real)
    shiftdims = dims[2:end]
    f = rfft(img, dims)
    return irfft(f .* ifftshift(gaussian(T, size(f), 
                                                     offset=CtrRFT, 
                                                     sigma=size(img) ./ (T(2π) .*sigma)),
                                      shiftdims), 
                     size(img, dims[1]), dims)
end

[RainerHeintzmann]

Hi. Strictly speaking a Gaussian filter is seperable. So ideally it should be implemented as a separable convolution. Why did you rename it and why did you remove the dtype argument, which should however be a dispatch type in my code to be fast. The user should be able to call gaussf on an Int array type and obtain a Float32 arraytype.

[roflmaostc]

Keywords don't participate in dispatch unfortunately.

For me the new name is more clear.

[roflmaostc]

rfft of an int array already throws an error, so this works anyway only for floating

[RainerHeintzmann]

The name gaussf stems from the name in DipImage and has now been used already by some other packages. I would therefore recommend to stick to it. As for the dispatch, we could make two versions, one with and one without the type dispatch. I vaguely remember that some other functions also have a named dtype argument. I wonder, how they deal with the dispatch problem.
The fact that rfft throws an error is good, but I thought that is may be a nice feature that Gaussian filtering by default casts to Float32. But I guess one could require the user to write gaussf(Float32.(image)). So do we move this function to FourierTools.jl?

[roflmaostc]

Any objections to this implementation?

function filter_gauss(img::AbstractArray{T}, sigma=one(T), dims=1:ndims(img)) where (T <: Real)
    shiftdims = dims[2:end]
    f = rfft(img, dims)
    return irfft(f .* ifftshift(gaussian(T, size(f), 
                                                     offset=CtrRFT, 
                                                     sigma=size(img) ./ (T(2π) .*sigma)),
                                      shiftdims), 
                     size(img, dims[1]), dims)
end

[RainerHeintzmann]

If you really want to rename it, I suggest "filter_gaussian" to be more in agreemend with the English term "Gaussian filter" and with the function "gaussian" which the implementation uses.

The IndexFunArrays.jl function needs a named argument sigma, whereas this one is not named. Would it be more compatible (nargs... forwarding) and more explicit to leave it named also for this implementation?

As for the implementation, it is good. It would break compatibility with the previous version where I up-casted, but that can be tolerated, especially since the name changes and it is moved to FourierTools.jl.

[roflmaostc]

function filter_gaussian(img::AbstractArray{T};
                              sigma=one(T), dims=1:ndims(img)) where (T <: Real)
    shiftdims = dims[2:end]
    f = rfft(img, dims)
    return irfft(f .* ifftshift(gaussian(T, size(f), 
                                                     offset=CtrRFT, 
                                                     sigma=size(img) ./ (T(2π) .*sigma)),
                                      shiftdims), 
                     size(img, dims[1]), dims)
end

[RainerHeintzmann]

great!. Should one also include the option for Gaussian low-pass (this one), high-pass and band-pass?