Changeset 338

Timestamp:

Sep 22, 2004, 9:40:30 AM (20 years ago)

Author:

ole

Message:

Comments

File:

• inundation/ga/storm_surge/pyvolution/least_squares.py (modified) (3 diffs)

inundation/ga/storm_surge/pyvolution/least_squares.py

@@ -1 +1 @@
 """Least squares smooting and interpolation.
+
+   Implements a penalised least-squares fit and associated interpolations.
+
+   The panalty term (or smoothing term) is controlled by the smoothing
+   parameter alpha.
+   With a value of alpha=0, the fit function will attempt
+   to interpolate as closely as possible in the least-squares sense.
+   With values alpha > 0, a certain amount of smoothing will be applied.
+   A positive alpha is essential in cases where there are too few
+   data points.
+   A negative alpha is not allowed.
+   A typical value of alpha is 1.0e-6
+          
 
    Ole Nielsen, Stephen Roberts, Duncan Gray, Christopher Zoppou
@@ -34 +47 @@
           (or an nx2 Numeric array)
 
-          alpha: Smoothing parameter
-          
+          alpha: Smoothing parameter.
+
           point_attributes: Vector or array of data at the point_coordinates.
     """
@@ -302 +315 @@
 
      
-    #FIXME: We may need a method 'evaluate(self):' that will interpolate
+    #FIXME: We will need a method 'evaluate(self):' that will interpolate
     #a computed surface living on the mesh onto a collection of
     #arbitrary data points