Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/raster/KernelFilter.java @ 801:d766fe2d917a
More javadoc.
gnv-artifacts/trunk@883 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
---|---|
date | Tue, 06 Apr 2010 16:53:43 +0000 |
parents | 6cff63d0c434 |
children | f953c9a559d8 |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/raster/KernelFilter.java Tue Apr 06 13:07:11 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/raster/KernelFilter.java Tue Apr 06 16:53:43 2010 +0000 @@ -5,6 +5,7 @@ import org.w3c.dom.Element; /** + * An implemenation of raster filters based on given kernels. * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> */ public class KernelFilter @@ -12,15 +13,33 @@ { private static Logger log = Logger.getLogger(KernelFilter.class); + /** + * Implemens a factory which produces KernelFilters with Gauss kernels. + */ public static class GaussFactory implements Filter.Factory { + /** + * Default sigma of Gauss kernel: {@value} + */ public static final double DEFAULT_SIGMA = 1.0d; + /** + * Default radius of Gauss kernel: {@value} + */ public static final int DEFAULT_RADIUS = 5; + /** + * Configured sigma. + */ protected double sigma; + /** + * Configured radius. + */ protected int radius; + /** + * Default constructor. + */ public GaussFactory() { sigma = DEFAULT_SIGMA; radius = DEFAULT_RADIUS; @@ -54,11 +73,21 @@ } } // class GaussFactory + /** + * The kernel used by this filter. + */ protected Raster.Kernel kernel; + /** + * Default constructor. + */ public KernelFilter() { } + /** + * Constructor to create a filter with a given kernel. + * @param kernel The kernel to be used. + */ public KernelFilter(Raster.Kernel kernel) { this.kernel = kernel; }