Skip to content

Commit 6d3d0dd

Browse files
committed
FastGauss: improve javadoc
1 parent 64429bb commit 6d3d0dd

File tree

3 files changed

+15
-6
lines changed

3 files changed

+15
-6
lines changed

src/main/java/net/imglib2/algorithm/convolution/fast_gauss/FastGauss.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@
2323
* Faster alternative to {@link net.imglib2.algorithm.gauss3.Gauss3}.
2424
* It's especially faster if sigma is larger than 3.
2525
* <p>
26-
* It is normally expensive to calculate the exact result of the gauss convolution.
26+
* It's expensive to calculate the exact result of the gaussian blur.
2727
* That's why approximations are almost always used.
2828
* {@link net.imglib2.algorithm.gauss3.Gauss3} does an approximation
29-
* by cutting of the gauss kernel at 3*sigma + 1.
30-
* {@link FastGauss} uses a different approach known as Fast Gauss
31-
* Transformation. The runtime is thereby independent of sigma.
29+
* by cutting off the gauss kernel at 3*sigma + 1.
30+
* {@link FastGauss} uses a different approach known as fast Gauss
31+
* transformation. It's runtime is independent of sigma.
32+
* <p>
33+
* See {@link FastGaussCalculator} for more details.
3234
*
3335
* @author Vladimir Ulman
3436
* @author Matthias Arzt

src/main/java/net/imglib2/algorithm/convolution/fast_gauss/FastGaussCalculator.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
package net.imglib2.algorithm.convolution.fast_gauss;
22

33
/**
4-
* Fast algorithm to calculate an good approximation of the gauss convolution.
4+
* This class implements the fast Gauss transform to calculate a gaussian blur.
5+
* The approach is very different from an algorithm using a truncated convolution kernel.
6+
* Especially the runtime is independent of sigma.
7+
* <p>
8+
* The implemented algorithm is described in detail in:
9+
* Charalampidis, Dimitrios. "Recursive implementation of the Gaussian filter using
10+
* truncated cosine functions." IEEE Transactions on Signal Processing 64.14
11+
* (2016): 3554-3565.
512
*
613
* @author Vladimir Ulman
714
* @author Matthias Arzt

src/main/java/net/imglib2/algorithm/convolution/fast_gauss/FastGaussConvolverRealType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
/**
1111
* Implementation of {@link LineConvolverFactory} that uses {@link FastGaussCalculator}
12-
* to calculate a fast gauss convolution.
12+
* to calculate a fast Gauss transform.
1313
*
1414
* @author Vladimir Ulman
1515
* @author Matthias Arzt

0 commit comments

Comments
 (0)