diff gnv-artifacts/src/main/java/de/intevation/gnv/math/AreaInterpolation.java @ 808:2e951160c43d

Finished the javadoc of the math package. gnv-artifacts/trunk@890 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Thu, 08 Apr 2010 16:35:02 +0000
parents d766fe2d917a
children 22c18083225e
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/AreaInterpolation.java	Thu Apr 08 15:24:45 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/AreaInterpolation.java	Thu Apr 08 16:35:02 2010 +0000
@@ -15,36 +15,75 @@
 import org.apache.log4j.Logger;
 
 /**
- *  @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
+ * Does an area interpolation for "Horizontalschnitte".
+ *
+ * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public class AreaInterpolation
 implements   Serializable
 {
     private static Logger log = Logger.getLogger(AreaInterpolation.class);
 
+    /**
+     * The generated raster.
+     */
     protected double [] raster;
 
+    /**
+     * The width of the raster.
+     */
     protected int width;
+    /**
+     * The height of the raster.
+     */
     protected int height;
 
+    /**
+     * Default constructor.
+     */
     public AreaInterpolation() {
     }
 
+    /**
+     * Returns the width of the generated raster.
+     * @return the width of the raster.
+     */
     public int getWidth() {
         return width;
     }
 
+    /**
+     * Returns the height of the raster.
+     * @return The height of the raster.
+     */
     public int getHeight() {
         return height;
     }
 
+    /**
+     * The generated raster.
+     * @return
+     */
     public double [] getRaster() {
         return raster;
     }
 
+    /**
+     * Epsilon for numerical stability.
+     */
     public static final double EPS = 1e-6d;
 
 
+    /**
+     * Fills a raster by interpolating the input values.
+     * @param points The attributed input values.
+     * @param boundingBox The world area where to interpolate.
+     * @param samples The width and height of the raster.
+     * @param depth The callback to query the depth at a given point.
+     * @param extrapolationRounds Number of extrapolation point layers
+     * to generate before doing the interpolation.
+     * @return true if the interpolation succeeds else false.
+     */
     public boolean interpolate(
         List<? extends Point2d> points,
         Envelope                boundingBox,
@@ -160,4 +199,4 @@
         return true;
     }
 }
-// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org