Mercurial > octave-nkf

comparison scripts/plot/draw/plot3.m @ 17572:7bb76a22cde1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Split scripts/plot directory into 4 pieces. scripts/gui : user-interface functions scripts/plot/appearance : functions controlling plot appearance scripts/plot/draw : plotting functions which produce graphs scripts/plot/util : low-level plotting functions and utilities. * scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk, scripts/gui/private/__file_filter__.m, scripts/gui/private/__fltk_file_filter__.m, scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m, scripts/gui/private/__uigetfile_fltk__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m, scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m, scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m, scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui * scripts/plot/appearance/__clabel__.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m, scripts/plot/appearance/private/__axis_label__.m, scripts/plot/appearance/private/__axis_limits__.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m: Moved from scripts/plot to subdir appearance. * scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m, scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m, scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m, scripts/plot/draw/feather.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m, scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m, scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errcomm__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__interp_cube__.m, scripts/plot/draw/private/__line__.m, scripts/plot/draw/private/__marching_cube__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m, scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw. * scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__default_plot_options__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__next_line_color__.m, scripts/plot/util/__next_line_style__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m, scripts/plot/util/close.m, scripts/plot/util/closereq.m, scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/findall.m, scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m, scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m, scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m, scripts/plot/util/hold.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m, scripts/plot/util/ishold.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m, scripts/plot/util/ndgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_ginput__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__ghostscript__.m, scripts/plot/util/private/__gnuplot_get_var__.m, scripts/plot/util/private/__gnuplot_ginput__.m, scripts/plot/util/private/__gnuplot_has_feature__.m, scripts/plot/util/private/__gnuplot_has_terminal__.m, scripts/plot/util/private/__gnuplot_open_stream__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__gnuplot_version__.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__go_draw_figure__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m, scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m, scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m: Moved from plot to subdir util. * etc/HACKING: Updated directory structure info. * scripts/Makefile.am, scripts/plot/appearance/module.mk, scripts/plot/draw/module.mk, scripts/plot/util/module.mk: Added new directories to build system.
author Rik <rik@octave.org>
date Fri, 04 Oct 2013 17:09:08 -0700
parents scripts/plot/plot3.m@68bcac3c043a
children d63878346099
comparison
equal deleted inserted replaced
17571:6e4ea5c8a4bb 17572:7bb76a22cde1
1 ## Copyright (C) 1996-2012 John W. Eaton
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 -*-
20 ## @deftypefn {Function File} {} plot3 (@var{x}, @var{y}, @var{z})
21 ## @deftypefnx {Function File} {} plot3 (@var{x}, @var{y}, @var{z}, @var{prop}, @var{value}, @dots{})
22 ## @deftypefnx {Function File} {} plot3 (@var{x}, @var{y}, @var{z}, @var{fmt})
23 ## @deftypefnx {Function File} {} plot3 (@var{x}, @var{cplx})
24 ## @deftypefnx {Function File} {} plot3 (@var{cplx})
25 ## @deftypefnx {Function File} {} plot3 (@var{hax}, @dots{})
26 ## @deftypefnx {Function File} {@var{h} =} plot3 (@dots{})
27 ## Produce 3-D plots.
28 ##
29 ## Many different combinations of arguments are possible. The simplest
30 ## form is
31 ##
32 ## @example
33 ## plot3 (@var{x}, @var{y}, @var{z})
34 ## @end example
35 ##
36 ## @noindent
37 ## in which the arguments are taken to be the vertices of the points to
38 ## be plotted in three dimensions. If all arguments are vectors of the
39 ## same length, then a single continuous line is drawn. If all arguments
40 ## are matrices, then each column of is treated as a separate line. No attempt
41 ## is made to transpose the arguments to make the number of rows match.
42 ##
43 ## If only two arguments are given, as
44 ##
45 ## @example
46 ## plot3 (@var{x}, @var{cplx})
47 ## @end example
48 ##
49 ## @noindent
50 ## the real and imaginary parts of the second argument are used
51 ## as the @var{y} and @var{z} coordinates, respectively.
52 ##
53 ## If only one argument is given, as
54 ##
55 ## @example
56 ## plot3 (@var{cplx})
57 ## @end example
58 ##
59 ## @noindent
60 ## the real and imaginary parts of the argument are used as the @var{y}
61 ## and @var{z} values, and they are plotted versus their index.
62 ##
63 ## Arguments may also be given in groups of three as
64 ##
65 ## @example
66 ## plot3 (@var{x1}, @var{y1}, @var{z1}, @var{x2}, @var{y2}, @var{z2}, @dots{})
67 ## @end example
68 ##
69 ## @noindent
70 ## in which each set of three arguments is treated as a separate line or
71 ## set of lines in three dimensions.
72 ##
73 ## To plot multiple one- or two-argument groups, separate each group
74 ## with an empty format string, as
75 ##
76 ## @example
77 ## plot3 (@var{x1}, @var{c1}, "", @var{c2}, "", @dots{})
78 ## @end example
79 ##
80 ## Multiple property-value pairs may be specified which will affect the line
81 ## objects drawn by @code{plot3}. If the @var{fmt} argument is supplied it
82 ## will format the line objects in the same manner as @code{plot}.
83 ##
84 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
85 ## rather than the current axes returned by @code{gca}.
86 ##
87 ## The optional return value @var{h} is a graphics handle to the created plot.
88 ##
89 ## Example:
90 ##
91 ## @example
92 ## @group
93 ## z = [0:0.05:5];
94 ## plot3 (cos (2*pi*z), sin (2*pi*z), z, ";helix;");
95 ## plot3 (z, exp (2i*pi*z), ";complex sinusoid;");
96 ## @end group
97 ## @end example
98 ## @seealso{ezplot3, plot}
99 ## @end deftypefn
100
101 ## Author: Paul Kienzle
102 ## (modified from __plt__.m)
103
104 function retval = plot3 (varargin)
105
106 [hax, varargin, nargs] = __plt_get_axis_arg__ ("plot3", varargin{:});
107
108 if (nargs < 1)
109 print_usage ();
110 endif
111
112 oldfig = [];
113 if (! isempty (hax))
114 oldfig = get (0, "currentfigure");
115 endif
116 unwind_protect
117 hax = newplot (hax);
118
119 x_set = 0;
120 y_set = 0;
121 z_set = 0;
122 property_set = 0;
123 fmt_set = 0;
124 properties = {};
125 tlgnd = {};
126 hlgnd = [];
127 idx = 0;
128
129 ## Gather arguments, decode format, and plot lines.
130 arg = 0;
131 while (arg++ < nargs)
132 new = varargin{arg};
133 new_cell = varargin(arg);
134
135 if (property_set)
136 properties = [properties, new_cell];
137 property_set = 0;
138 continue;
139 endif
140
141 if (ischar (new))
142 if (! z_set)
143 if (! y_set)
144 if (! x_set)
145 error ("plot3: needs X, [ Y, [ Z ] ]");
146 else
147 y = real (x);
148 z = imag (x);
149 y_set = 1;
150 z_set = 1;
151 if (rows (x) > 1)
152 x = repmat ((1:rows (x))', 1, columns (x));
153 else
154 x = 1:columns (x);
155 endif
156 endif
157 else
158 z = imag (y);
159 y = real (y);
160 z_set = 1;
161 endif
162 endif
163
164 if (! fmt_set)
165 [options, valid] = __pltopt__ ("plot3", new, false);
166 if (! valid)
167 properties = [properties, new_cell];
168 property_set = 1;
169 continue;
170 else
171 fmt_set = 1;
172 while (arg < nargs && ischar (varargin{arg+1}))
173 if (nargs - arg < 2)
174 error ("plot3: properties must appear followed by a value");
175 endif
176 properties = [properties, varargin(arg+1:arg+2)];
177 arg += 2;
178 endwhile
179 endif
180 else
181 properties = [properties, new_cell];
182 property_set = 1;
183 continue;
184 endif
185
186 if (isvector (x) && isvector (y))
187 if (isvector (z))
188 x = x(:);
189 y = y(:);
190 z = z(:);
191 elseif (length (x) == rows (z) && length (y) == columns (z))
192 [x, y] = meshgrid (x, y);
193 else
194 error ("plot3: [length(X), length(Y)] must match size (Z)");
195 endif
196 endif
197
198 if (! size_equal (x, y, z))
199 error ("plot3: X, Y, and Z must have the same shape");
200 elseif (ndims (x) > 2)
201 error ("plot3: X, Y, and Z must not have more than two dimensions");
202 endif
203
204 for i = 1 : columns (x)
205 linestyle = options.linestyle;
206 marker = options.marker;
207 if (isempty (marker) && isempty (linestyle))
208 [linestyle, marker] = __next_line_style__ ();
209 endif
210 color = options.color;
211 if (isempty (color))
212 color = __next_line_color__ ();
213 endif
214
215 htmp(++idx) = line (x(:, i), y(:, i), z(:, i),
216 "color", color, "linestyle", linestyle,
217 "marker", marker, properties{:});
218 key = options.key;
219 if (! isempty (key))
220 hlgnd = [hlgnd, htmp(idx)];
221 tlgnd = {tlgnd{:}, key};
222 endif
223 endfor
224
225 x_set = 0;
226 y_set = 0;
227 z_set = 0;
228 fmt_set = 0;
229 properties = {};
230 elseif (! x_set)
231 x = new;
232 x_set = 1;
233 elseif (! y_set)
234 y = new;
235 y_set = 1;
236 elseif (! z_set)
237 z = new;
238 z_set = 1;
239 else
240 if (isvector (x) && isvector (y))
241 if (isvector (z))
242 x = x(:);
243 y = y(:);
244 z = z(:);
245 elseif (length (x) == rows (z) && length (y) == columns (z))
246 [x, y] = meshgrid (x, y);
247 else
248 error ("plot3: [length(X), length(Y)] must match size (Z)");
249 endif
250 endif
251
252 if (! size_equal (x, y, z))
253 error ("plot3: X, Y, and Z must have the same shape");
254 elseif (ndims (x) > 2)
255 error ("plot3: X, Y, and Z must not have more than two dimensions");
256 endif
257
258 options = __default_plot_options__ ();
259 for i = 1 : columns (x)
260 linestyle = options.linestyle;
261 marker = options.marker;
262 if (isempty (marker) && isempty (linestyle))
263 [linestyle, marker] = __next_line_style__ ();
264 endif
265 color = options.color;
266 if (isempty (color))
267 color = __next_line_color__ ();
268 endif
269
270 htmp(++idx) = line (x(:, i), y(:, i), z(:, i),
271 "color", color, "linestyle", linestyle,
272 "marker", marker, properties{:});
273 key = options.key;
274 if (! isempty (key))
275 hlgnd = [hlgnd, htmp(idx)];
276 tlgnd = {tlgnd{:}, key};
277 endif
278 endfor
279
280 x = new;
281 y_set = 0;
282 z_set = 0;
283 fmt_set = 0;
284 properties = {};
285 endif
286
287 endwhile
288
289 if (property_set)
290 error ("plot3: properties must appear followed by a value");
291 endif
292
293 ## Handle last plot.
294
295 if (x_set)
296 if (y_set)
297 if (! z_set)
298 z = imag (y);
299 y = real (y);
300 z_set = 1;
301 endif
302 else
303 y = real (x);
304 z = imag (x);
305 y_set = 1;
306 z_set = 1;
307 if (rows (x) > 1)
308 x = repmat ((1:rows (x))', 1, columns (x));
309 else
310 x = 1:columns (x);
311 endif
312 endif
313
314 if (isvector (x) && isvector (y))
315 if (isvector (z))
316 x = x(:);
317 y = y(:);
318 z = z(:);
319 elseif (length (x) == rows (z) && length (y) == columns (z))
320 [x, y] = meshgrid (x, y);
321 else
322 error ("plot3: [length(X), length(Y)] must match size (Z)");
323 endif
324 endif
325
326 if (! size_equal (x, y, z))
327 error ("plot3: X, Y, and Z must have the same shape");
328 elseif (ndims (x) > 2)
329 error ("plot3: X, Y, and Z must not have more than two dimensions");
330 endif
331
332 options = __default_plot_options__ ();
333
334 for i = 1 : columns (x)
335 linestyle = options.linestyle;
336 marker = options.marker;
337 if (isempty (marker) && isempty (linestyle))
338 [linestyle, marker] = __next_line_style__ ();
339 endif
340 color = options.color;
341 if (isempty (color))
342 color = __next_line_color__ ();
343 endif
344
345 htmp(++idx) = line (x(:, i), y(:, i), z(:, i),
346 "color", color, "linestyle", linestyle,
347 "marker", marker, properties{:});
348 key = options.key;
349 if (! isempty (key))
350 hlgnd = [hlgnd, htmp(idx)];
351 tlgnd = {tlgnd{:}, key};
352 endif
353 endfor
354 endif
355
356 if (! isempty (hlgnd))
357 legend (hax, hlgnd, tlgnd);
358 endif
359
360 if (! ishold ())
361 set (hax, "view", [-37.5, 30]);
362 endif
363
364 unwind_protect_cleanup
365 if (! isempty (oldfig))
366 set (0, "currentfigure", oldfig);
367 endif
368 end_unwind_protect
369
370 if (nargout > 0 && idx > 0)
371 retval = htmp;
372 endif
373
374 endfunction
375
376
377 %!demo
378 %! clf;
379 %! z = [0:0.05:5];
380 %! plot3 (cos (2*pi*z), sin (2*pi*z), z, ';helix;');
381 %! title ('plot3() of a helix');
382
383 %!demo
384 %! clf;
385 %! z = [0:0.05:5];
386 %! plot3 (z, exp (2i*pi*z), ';complex sinusoid;');
387 %! title ('plot3() with complex input');
388