Add fractional Fourier transform docs

roflmaostc · roflmaostc · commit 11467f8b9ae3 · 2022-12-05T15:36:32.000+01:00
diff --git a/docs/make.jl b/docs/make.jl
@@ -13,6 +13,7 @@ makedocs(modules = [FourierTools],
             "Image Shearing with FFTs" => "shear.md",
             "Image Rotation with FFTs" => "rotate.md",
             "NFFT" => "nfft.md",
+            "Fractional Fourier Transform" => "fractional.md",
             "Utility Functions" => "utils.md",
          ]
         )
diff --git a/docs/src/fractional.md b/docs/src/fractional.md
@@ -0,0 +1,6 @@
+# Fractional Fourier Transforms 
+
+Implementation of the [Fast Fractional Fourier Transform](https://en.wikipedia.org/wiki/Fractional_Fourier_transform) based on [Javier García, David Mas, and Rainer G. Dorsch, "Fractional-Fourier-transform calculation through the fast-Fourier-transform algorithm," Appl. Opt. 35, 7013-7018 (1996)](https://opg.optica.org/ao/abstract.cfm?uri=ao-35-35-7013)
+```@docs
+FourierTools.frfft
+```

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ makedocs(modules = [FourierTools],`
`13`	`13`	`"Image Shearing with FFTs" => "shear.md",`
`14`	`14`	`"Image Rotation with FFTs" => "rotate.md",`
`15`	`15`	`"NFFT" => "nfft.md",`
	`16`	`+ "Fractional Fourier Transform" => "fractional.md",`
`16`	`17`	`"Utility Functions" => "utils.md",`
`17`	`18`	`]`
`18`	`19`	`)`