octave_packages/optiminterp-0.3.3/optiminterp1.m

   1 ## Copyright (C) 2006 Alexander Barth
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation; either version 2 of the License, or
   6 ## (at your option) any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful,
   9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 ## GNU General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this program; If not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Loadable Function} {[@var{fi},@var{vari}]} = optiminterp1(@var{x},@var{f},@var{var},@var{lenx},@var{m},@var{xi})
  18 ## Performs a local 1D-optimal interpolation (objective analysis).
  19 ##
  20 ## Every elements in @var{f} corresponds to a data point (observation)
  21 ## at location @var{x},@var{y} with the error variance @var{var}.
  22 ##
  23 ## @var{lenx} is correlation length in x-direction.
  24 ## @var{m} represents the number of influential points.
  25 ##
  26 ## @var{xi} is the data points where the field is
  27 ## interpolated. @var{fi} is the interpolated field and @var{vari} is
  28 ## its error variance.
  29 ##
  30 ## The background field of the optimal interpolation is zero.
  31 ## For a different background field, the background field
  32 ## must be subtracted from the observation, the difference
  33 ## is mapped by OI onto the background grid and finally the
  34 ## background is added back to the interpolated field.
  35 ## @end deftypefn
  36
  37
  38
  39 function [fi,vari] = optiminterp1(x,f,var,lenx,m,xi)
  40
  41 [fi,vari] = optiminterpn(x,f,var,lenx,m,xi);