Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / optiminterp-0.3.3 / optiminterp3.m

diff --git a/octave_packages/optiminterp-0.3.3/optiminterp3.m b/octave_packages/optiminterp-0.3.3/optiminterp3.m
new file mode 100644 (file)
index 0000000..cf62ad3
--- /dev/null
+++ b/octave_packages/optiminterp-0.3.3/optiminterp3.m
@@ -0,0 +1,47 @@
+## Copyright (C) 2006 Alexander Barth
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; If not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Loadable Function} {[@var{fi},@var{vari}] = } optiminterp3(@var{x},@var{y},@var{z},@var{f},@var{var},@var{lenx},@var{leny},@var{lenz},@var{m},@var{xi},@var{yi},@var{zi})
+## Performs a local 3D-optimal interpolation (objective analysis).
+##
+## Every elements in @var{f} corresponds to a data point (observation)
+## at location  @var{x}, @var{y}, @var{z} with the error variance var
+##
+## @var{lenx},@var{leny} and @var{lenz} are correlation length in x-,y- and z-direction
+## respectively. 
+## @var{m} represents the number of influential points.
+##
+## @var{xi},@var{yi} and @var{zi} are the data points where the field is
+## interpolated. @var{fi} is the interpolated field and @var{vari} is 
+## its error variance.
+##
+##
+## The background field of the optimal interpolation is zero.
+## For a different background field, the background field
+## must be subtracted from the observation, the difference 
+## is mapped by OI onto the background grid and finally the
+## background is added back to the interpolated field.
+##
+## The error variance of the background field is assumed to 
+## have a error variance of one. 
+## @end deftypefn
+
+## Copyright (C) 2006, Alexander Barth
+## Author: Alexander Barth <barth.alexander@gmail.com>
+
+function [fi,vari] = optiminterp3(x,y,z,f,var,lenx,leny,lenz,m,xi,yi,zi)
+
+[fi,vari] = optiminterpn(x,y,z,f,var,lenx,leny,lenz,m,xi,yi,zi);