Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.24 KB

README.md

File metadata and controls

67 lines (48 loc) · 2.24 KB
Raw

FINUFFT.jl

Build Status

This is a Julia interface to FINUFFT, a lightweight and fast nonuniform FFT (nufft) library released by the Flatiron Institute.

Installation

Julia 1.0 and 0.7: From the Pkg REPL mode (hit ] in REPL to enter), run

add FINUFFT
test FINUFFT

Julia 0.6: From the REPL, run

Pkg.add("FINUFFT")
Pkg.test("FINUFFT")

This should download, build and test FINUFFT v1.0, as long as you have gcc and curl installed. The FFTW library is downloaded locally by the build script, using Conda.jl

Developed and tested on Linux. Also works on Max OS X, but build script is hardwired to use GCC 8 (g++-8 and gcc-8).

Usage

This module provides functions nufft1d1, nufft1d2, ..., nufft3d3, nufft1d1!, nufft1d2!, ..., nufft3d3!, and finufft_default_opts that call the interface defined in https://finufft.readthedocs.io/en/latest/usage.html

  • Function calls mimic the C/C++ interface, with the exception that you don't need to pass the dimensions of any arrays in the argument (they are inferred using size()).
  • The functions named nufftDdN return the output array.
  • The functions named nufftDdN! take the output array as an argument. This needs to be preallocated.
  • The last argument of the nufft routines is the options struct, which is optional. Default values are used if it is omitted.
  • finufft_default_opts() returns an options struct with default values.

Example:

using FINUFFT

# nonuniform data
nj = 100
x = pi*(1.0 .- 2.0*rand(nj))
c = rand(nj) + 1im*rand(nj)

# Parameters
ms = 20 # Output size
tol = 1e-10 # Tolerance

# Output as return value
fk = nufft1d1(x, c, 1, tol, ms)

# Preallocate output and pass as argument
out = Array{ComplexF64}(undef, ms)
nufft1d1!(x, c, 1, tol, out)

# Call using modified opts 
opts = finufft_default_opts()
opts.debug = 1
fk2 = nufft1d1(x, c, 1, tol, ms, opts)

The advanced interfaces finufft2d1many and finufft2d2many have not been implemented yet.

More examples

See test/runtests.jl

TODO

  • Implement advanced interface