octave-nkf: scripts/geometry/griddata3.m annotate

annotate scripts/geometry/griddata3.m @ 14001:5f0bb45e615c

doc: Update documentation for functions returning a graphics handle h (Bug #34761) * voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m, clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m, ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m, findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m, quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m, semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m, trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m: Update documentation for functions returning a graphics handle h.

author	Rik <octave@nomad.inbox5.com>
date	Tue, 06 Dec 2011 13:09:17 -0800
parents	e8564e8b0043
children	72c96de7a403

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11472 diff changeset	1 ## Copyright (C) 2007-2011 David Bateman
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	2 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	3 ## This file is part of Octave.
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	4 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6826 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6826 diff changeset	8 ## your option) any later version.
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	9 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	13 ## General Public License for more details.
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	14 ##
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6826 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6826 diff changeset	17 ## <http://www.gnu.org/licenses/>.
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	18
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	19 ## -- texinfo --
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	20 ## @deftypefn {Function File} {@var{vi} =} griddata3 (@var{x}, @var{y}, @var{z}, @var{v} @var{xi}, @var{yi}, @var{zi}, @var{method}, @var{options})
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	21 ##
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	22 ## Generate a regular mesh from irregular data using interpolation.
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	23 ## The function is defined by @code{@var{y} = f (@var{x},@var{y},@var{z})}.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	24 ## The interpolation points are all @var{xi}.
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	25 ##
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	26 ## The interpolation method can be @code{"nearest"} or @code{"linear"}.
8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	27 ## If method is omitted it defaults to @code{"linear"}.
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	28 ## @seealso{griddata, delaunayn}
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	29 ## @end deftypefn
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	30
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	31 ## Author: David Bateman <dbateman@free.fr>
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	32
7585 522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	33 function vi = griddata3 (x, y, z, v, xi, yi, zi, method, varargin)
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	34
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	35 if (nargin < 7)
8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	36 print_usage ();
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	37 endif
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	38
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	39 if (!all (size (x) == size (y) & size (x) == size(z) & size(x) == size (v)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	40 error ("griddata3: X, Y, Z, and V must be vectors of same length");
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	41 endif
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	42
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	43 ## meshgrid xi, yi and zi if they are vectors unless they
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	44 ## are vectors of the same length
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	45 if (isvector (xi) && isvector (yi) && isvector (zi)
8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	46 && (numel (xi) != numel (yi) \|\| numel (xi) != numel (zi)))
8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	47 [xi, yi, zi] = meshgrid (xi, yi, zi);
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	48 endif
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	49
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	50 if (any (size(xi) != size(yi)) \|\| any (size(xi) != size(zi)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	51 error ("griddata3: XI, YI and ZI must be vectors or matrices of same size");
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	52 endif
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	53
7585 522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	54 vi = griddatan ([x(:), y(:), z(:)], v(:), [xi(:), yi(:), zi(:)], varargin{:});
6826 8618f29520c6 [project @ 2007-08-24 16:02:07 by jwe] jwe parents: 6823 diff changeset	55 vi = reshape (vi, size (xi));
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	56
6823 9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	57 endfunction
9fddcc586065 [project @ 2007-08-24 08:27:27 by dbateman] dbateman parents: diff changeset	58
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	59
8153 ec0a13863eb7 Only run tests that depend on HDF5 and QHull if Octave was actually Soren Hauberg <hauberg@gmail.com> parents: 7585 diff changeset	60 %!testif HAVE_QHULL
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	61 %! old_state = rand ("state");
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	62 %! restore_state = onCleanup (@() rand ("state", old_state));
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	63 %! rand ("state", 0);
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	64 %! x = 2 * rand (1000, 1) - 1;
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	65 %! y = 2 * rand (1000, 1) - 1;
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	66 %! z = 2 * rand (1000, 1) - 1;
7585 522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	67 %! v = x.^2 + y.^2 + z.^2;
522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	68 %! [xi, yi, zi] = meshgrid (-0.8:0.2:0.8);
522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	69 %! vi = griddata3 (x, y, z, v, xi, yi, zi, 'linear');
522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	70 %! vv = vi - xi.^2 - yi.^2 - zi.^2;
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	71 %! assert (max (abs (vv(:))), 0, 0.1);
7585 522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	72
8153 ec0a13863eb7 Only run tests that depend on HDF5 and QHull if Octave was actually Soren Hauberg <hauberg@gmail.com> parents: 7585 diff changeset	73 %!testif HAVE_QHULL
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	74 %! old_state = rand ("state");
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	75 %! restore_state = onCleanup (@() rand ("state", old_state));
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	76 %! rand ("state", 0);
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	77 %! x = 2 * rand (1000, 1) - 1;
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	78 %! y = 2 * rand (1000, 1) - 1;
e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	79 %! z = 2 * rand (1000, 1) - 1;
7585 522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	80 %! v = x.^2 + y.^2 + z.^2;
522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	81 %! [xi, yi, zi] = meshgrid (-0.8:0.2:0.8);
522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	82 %! vi = griddata3 (x, y, z, v, xi, yi, zi, 'nearest');
522433b05f45 Fix griddata3 and add test code David Bateman <dbateman@free.fr> parents: 7418 diff changeset	83 %! vv = vi - xi.^2 - yi.^2 - zi.^2;
13747 e8564e8b0043 Restore random number state after %!demos or %!tests Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	84 %! assert (max (abs (vv(:))), 0, 0.1)

Mercurial > hg > octave-nkf

annotate scripts/geometry/griddata3.m @ 14001:5f0bb45e615c