Mercurial > octave-nkf
annotate scripts/plot/surface.m @ 14138:72c96de7a403 stable
maint: update copyright notices for 2012
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Mon, 02 Jan 2012 14:25:41 -0500 |
| parents | 5f0bb45e615c |
| children | ba7a26030214 |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14001
diff
changeset
|
1 ## Copyright (C) 1993-2012 John W. Eaton |
| 7109 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
|
10634
60542efcfa2c
Check input arguments for size and type (bug #29861).
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
20 ## @deftypefn {Function File} {} surface (@var{x}, @var{y}, @var{z}, @var{c}) |
| 7175 | 21 ## @deftypefnx {Function File} {} surface (@var{x}, @var{y}, @var{z}) |
| 22 ## @deftypefnx {Function File} {} surface (@var{z}, @var{c}) | |
| 23 ## @deftypefnx {Function File} {} surface (@var{z}) | |
| 24 ## @deftypefnx {Function File} {} surface (@dots{}, @var{prop}, @var{val}) | |
| 25 ## @deftypefnx {Function File} {} surface (@var{h}, @dots{}) | |
| 7650 | 26 ## @deftypefnx {Function File} {@var{h} =} surface (@dots{}) |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
27 ## Plot a surface graphic object given matrices @var{x}, and @var{y} from |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
28 ## @code{meshgrid} and a matrix @var{z} corresponding to the @var{x} and |
| 7175 | 29 ## @var{y} coordinates of the surface. If @var{x} and @var{y} are vectors, |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
30 ## then a typical vertex is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, |
|
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
31 ## columns of @var{z} correspond to different @var{x} values and rows of |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
32 ## @var{z} correspond to different @var{y} values. If @var{x} and @var{y} |
| 7175 | 33 ## are missing, they are constructed from size of the matrix @var{z}. |
| 34 ## | |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
7650
diff
changeset
|
35 ## Any additional properties passed are assigned to the surface. |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13194
diff
changeset
|
36 ## |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13194
diff
changeset
|
37 ## The optional return value @var{h} is a graphics handle to the created |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13194
diff
changeset
|
38 ## surface object. |
| 7109 | 39 ## @seealso{surf, mesh, patch, line} |
| 40 ## @end deftypefn | |
| 41 | |
| 42 ## Author: jwe | |
| 43 | |
| 7216 | 44 function retval = surface (varargin) |
| 7109 | 45 |
| 7215 | 46 [h, varargin] = __plt_get_axis_arg__ ("surface", varargin{:}); |
| 47 | |
| 48 oldh = gca (); | |
| 49 unwind_protect | |
| 50 axes (h); | |
| 51 [tmp, bad_usage] = __surface__ (h, varargin{:}); | |
| 52 unwind_protect_cleanup | |
| 53 axes (oldh); | |
| 54 end_unwind_protect | |
| 7109 | 55 |
| 7207 | 56 if (bad_usage) |
| 57 print_usage (); | |
| 58 endif | |
| 59 | |
| 60 if (nargout > 0) | |
| 7216 | 61 retval = tmp; |
| 7207 | 62 endif |
| 7216 | 63 |
| 7207 | 64 endfunction |
| 65 | |
| 66 function [h, bad_usage] = __surface__ (ax, varargin) | |
| 67 | |
| 68 bad_usage = false; | |
| 69 h = 0; | |
| 70 firststring = nargin; | |
| 71 for i = 2 : nargin | |
| 7208 | 72 if (ischar (varargin{i - 1})) |
| 7207 | 73 firststring = i - 1; |
| 7175 | 74 break; |
| 7109 | 75 endif |
| 7175 | 76 endfor |
| 77 | |
| 78 if (firststring > 5) | |
| 7207 | 79 bad_usage = true; |
| 7175 | 80 elseif (firststring == 5) |
| 81 x = varargin{1}; | |
| 82 y = varargin{2}; | |
| 83 z = varargin{3}; | |
| 84 c = varargin{4}; | |
| 85 | |
|
13194
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
86 [z_nr, z_nc] = size (z); |
|
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
87 [c_nr, c_nc, c_np] = size (c); |
|
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
88 if (! (z_nr == c_nr && z_nc == c_nc && (c_np == 1 || c_np == 3))) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
89 error ("surface: Z and C must have the same size"); |
| 7109 | 90 endif |
|
13194
3e1871badab9
allow sscanf to accept character arrays with more than one row
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
91 |
| 7109 | 92 if (isvector (x) && isvector (y) && ismatrix (z)) |
| 93 if (rows (z) == length (y) && columns (z) == length (x)) | |
| 94 x = x(:)'; | |
| 95 y = y(:); | |
| 96 else | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
97 error ("surface: rows (Z) must be the same as length (Y) and columns (Z) must be the same as length (X)"); |
| 7109 | 98 endif |
| 99 elseif (ismatrix (x) && ismatrix (y) && ismatrix (z)) | |
| 7292 | 100 if (! size_equal (x, y, z)) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
101 error ("surface: X, Y, and Z must have the same dimensions"); |
| 7109 | 102 endif |
| 103 else | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
104 error ("surface: X and Y must be vectors and Z must be a matrix"); |
| 7109 | 105 endif |
| 7175 | 106 elseif (firststring == 4) |
| 107 x = varargin{1}; | |
| 108 y = varargin{2}; | |
| 109 z = varargin{3}; | |
| 110 c = z; | |
| 111 if (isvector (x) && isvector (y) && ismatrix (z)) | |
| 112 if (rows (z) == length (y) && columns (z) == length (x)) | |
| 113 x = x(:)'; | |
| 114 y = y(:); | |
| 115 else | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
116 error ("surface: rows (Z) must be the same as length (Y) and columns (Z) must be the same as length (X)"); |
| 7175 | 117 endif |
| 118 elseif (ismatrix (x) && ismatrix (y) && ismatrix (z)) | |
| 7292 | 119 if (! size_equal (x, y, z)) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
120 error ("surface: X, Y, and Z must have the same dimensions"); |
| 7175 | 121 endif |
| 122 else | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
123 error ("surface: X and Y must be vectors and Z must be a matrix"); |
| 7175 | 124 endif |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
125 elseif (firststring == 3) |
| 7208 | 126 z = varargin{1}; |
| 127 c = varargin{2}; | |
|
10634
60542efcfa2c
Check input arguments for size and type (bug #29861).
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
128 if (ismatrix (z) && !isvector (z) && !isscalar (z)) |
| 7175 | 129 [nr, nc] = size (z); |
| 130 x = 1:nc; | |
| 131 y = (1:nr)'; | |
| 132 else | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
133 error ("surface: Z argument must be a matrix"); |
| 7175 | 134 endif |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
135 elseif (firststring == 2) |
| 7208 | 136 z = varargin{1}; |
| 7175 | 137 c = z; |
|
10634
60542efcfa2c
Check input arguments for size and type (bug #29861).
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
138 if (ismatrix (z) && !isvector (z) && !isscalar (z)) |
| 7175 | 139 [nr, nc] = size (z); |
| 140 x = 1:nc; | |
| 141 y = (1:nr)'; | |
| 142 else | |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
10634
diff
changeset
|
143 error ("surface: Z argument must be a matrix"); |
| 7175 | 144 endif |
|
13115
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
145 elseif (firststring == 1) |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
146 x = 1:3; |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
147 y = (x).'; |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
148 c = z = eye(3); |
| 7109 | 149 else |
| 7207 | 150 bad_usage = true; |
| 7189 | 151 endif |
| 7109 | 152 |
| 7207 | 153 if (! bad_usage) |
| 154 ## Make a default surface object. | |
| 7277 | 155 other_args = {}; |
| 7207 | 156 if (firststring < nargin) |
| 7277 | 157 other_args = varargin(firststring:end); |
| 158 endif | |
| 159 h = __go_surface__ (ax, "xdata", x, "ydata", y, "zdata", z, "cdata", c, | |
| 10549 | 160 other_args{:}); |
| 7109 | 161 |
| 7277 | 162 if (! ishold ()) |
| 7298 | 163 set (ax, "view", [0, 90], "box", "off"); |
| 7277 | 164 endif |
| 165 endif | |
| 7109 | 166 |
| 167 endfunction | |
|
12817
e3e6079039c6
codesprint: 2 demos for pcolor.m dummy for surface.m
Kai Habel <kai.habel@gmx.de>
parents:
11587
diff
changeset
|
168 |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13194
diff
changeset
|
169 ## Functional tests for surface() are in surf.m, surfc.m, surfl.m, and pcolor.m |
|
13115
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
170 |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
171 %!test |
|
13124
2ea1658ad049
Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents:
13115
diff
changeset
|
172 %! hf = figure ("visible", "off"); |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
13124
diff
changeset
|
173 %! unwind_protect |
|
13115
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
174 %! h = surface; |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
175 %! assert (findobj (hf, "type", "surface"), h); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
176 %! assert (get (h, "xdata"), 1:3, eps); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
177 %! assert (get (h, "ydata"), (1:3)', eps); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
178 %! assert (get (h, "zdata"), eye(3)); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
179 %! assert (get (h, "cdata"), eye(3)); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
180 %! assert (get (h, "type"), "surface"); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
181 %! assert (get (h, "linestyle"), get (0, "defaultsurfacelinestyle")); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
182 %! assert (get (h, "linewidth"), get (0, "defaultsurfacelinewidth"), eps); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
183 %! assert (get (h, "marker"), get (0, "defaultsurfacemarker")); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
184 %! assert (get (h, "markersize"), get (0, "defaultsurfacemarkersize")); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
185 %! unwind_protect_cleanup |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
186 %! close (hf); |
|
cd808de114c1
Allow surface and patch to be called w/o arguments. Adding and fixing tests.
Kai Habel <kai.habel@gmx.de>
parents:
12819
diff
changeset
|
187 %! end_unwind_protect |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13194
diff
changeset
|
188 |