Mercurial > hg > octave-nkf

annotate scripts/plot/ribbon.m @ 17120:a639221f9863

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
sombrero.m: Overhaul documentation and make calling forms equivalent to peaks() * scripts/plot/sombrero.m: Overhaul documentation. Return only Z argument if nargout == 1. * scripts/plot/ribbon.m, scripts/plot/surf.m, scripts/plot/surfc.m: Rephrase %!tests to take advantage of new calling form for sombrero.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 13:43:44 -0700
parents f8b485d09ac6
children eaab03308c0b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14092
diff changeset
1 ## Copyright (C) 2007-2012 Kai Habel
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
2 ##
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
3 ## This file is part of Octave.
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
4 ##
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
8 ## your option) any later version.
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
9 ##
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
14 ##
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
17 ## <http://www.gnu.org/licenses/>.
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
18
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
20 ## @deftypefn {Function File} {} ribbon (@var{y})
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
21 ## @deftypefnx {Function File} {} ribbon (@var{x}, @var{y})
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
22 ## @deftypefnx {Function File} {} ribbon (@var{x}, @var{y}, @var{width})
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
23 ## @deftypefnx {Function File} {} ribbon (@var{hax}, @dots{})
9143
74d5c1a4ca96 Eliminate 'unbalanced parentheses in @def...' error during texi2pdf.
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} ribbon (@dots{})
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
25 ## Plot a ribbon plot for the columns of @var{y} vs. @var{x}.
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
26 ##
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
27 ## The optional parameter @var{width} specifies the width of a single ribbon
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
28 ## (default is 0.75). If @var{x} is omitted, a vector containing the
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
29 ## row numbers is assumed (@code{1:rows (Y)}).
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
30 ##
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
31 ## If the first argument @var{hax} is an axis handle, then plot into this axis,
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
32 ## rather than the current axis handle returned by @code{gca}.
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
33 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
34 ## The optional return value @var{h} is a vector of graphics handles to
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
35 ## the surface objects representing each ribbon.
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
36 ## @end deftypefn
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
37
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
38 ## Author: Kai Habel <kai.habel at gmx.de>
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
39
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
40 function h = ribbon (varargin)
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
41
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
42 [hax, varargin, nargin] = __plt_get_axis_arg__ ("ribbon", varargin{:});
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
43
14229
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
44 if (nargin < 1 || nargin > 3)
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
45 print_usage ();
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
46 endif
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
47
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
48 if (nargin == 1)
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
49 y = varargin{1};
7166
4e7e5d51db86 [project @ 2007-11-12 22:17:08 by jwe]
jwe
parents: 7165
diff changeset
50 if (isvector (y))
4e7e5d51db86 [project @ 2007-11-12 22:17:08 by jwe]
jwe
parents: 7165
diff changeset
51 y = y(:);
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
52 endif
7166
4e7e5d51db86 [project @ 2007-11-12 22:17:08 by jwe]
jwe
parents: 7165
diff changeset
53 [nr, nc] = size (y);
4e7e5d51db86 [project @ 2007-11-12 22:17:08 by jwe]
jwe
parents: 7165
diff changeset
54 x = repmat ((1:nr)', 1, nc);
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
55 width = 0.75;
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
56 elseif (nargin == 2)
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
57 x = varargin{1};
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
58 y = varargin{2};
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
59 width = 0.75;
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
60 else
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
61 x = varargin{1};
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
62 y = varargin{2};
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
63 width = varargin{3};
8610
85c9906abfd1 use endif and endfor instead of end
John W. Eaton <jwe@octave.org>
parents: 7650
diff changeset
64 endif
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
65
7166
4e7e5d51db86 [project @ 2007-11-12 22:17:08 by jwe]
jwe
parents: 7165
diff changeset
66 if (isvector (x) && isvector (y))
4e7e5d51db86 [project @ 2007-11-12 22:17:08 by jwe]
jwe
parents: 7165
diff changeset
67 if (length (x) != length (y))
14229
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
68 error ("ribbon: vectors X and Y must have the same length");
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
69 else
7166
4e7e5d51db86 [project @ 2007-11-12 22:17:08 by jwe]
jwe
parents: 7165
diff changeset
70 [x, y] = meshgrid (x, y);
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
71 endif
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
72 else
14229
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
73 if (! size_equal (x, y))
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
74 error ("ribbon: matrices X and Y must have the same size");
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
75 endif
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
76 endif
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
77
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
78 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure"));
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
79 unwind_protect
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
80 hax = newplot (hax);
14229
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
81
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
82 [nr, nc] = size (y);
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
83 htmp = zeros (nc, 1);
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
84
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
85 for c = nc:-1:1
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
86 zz = [y(:,c), y(:,c)];
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
87 yy = x(:,c);
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
88 xx = [c - width / 2, c + width / 2];
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
89 [xx, yy] = meshgrid (xx, yy);
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
90 cc = repmat (c, size (zz));
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
91 htmp(c) = surface (xx, yy, zz, cc);
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
92 endfor
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
93
17077
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
94 if (! ishold ())
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
95 set (hax, "view", [-37.5, 30], "box", "off",
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
96 "xgrid", "on", "ygrid", "on", "zgrid", "on");
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
97 endif
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
98
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
99 unwind_protect_cleanup
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
100 if (! isempty (oldfig))
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
101 set (0, "currentfigure", oldfig);
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
102 endif
f8b485d09ac6 ribbon.m, slice.m: Overhaul to use __plt_get_axis_arg__.
Rik <rik@octave.org>
parents: 16849
diff changeset
103 end_unwind_protect
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
104
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
105 if (nargout > 0)
14229
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
106 h = htmp;
7163
d4d8c7b33e16 [project @ 2007-11-12 21:54:07 by jwe]
jwe
parents:
diff changeset
107 endif
7164
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
108
2b5e6c0a9df9 [project @ 2007-11-12 22:04:42 by jwe]
jwe
parents: 7163
diff changeset
109 endfunction
7269
3fade00a6ac7 [project @ 2007-12-07 19:26:20 by jwe]
jwe
parents: 7166
diff changeset
110
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
111
7269
3fade00a6ac7 [project @ 2007-12-07 19:26:20 by jwe]
jwe
parents: 7166
diff changeset
112 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14229
diff changeset
113 %! clf;
14247
c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
114 %! colormap ('default');
7269
3fade00a6ac7 [project @ 2007-12-07 19:26:20 by jwe]
jwe
parents: 7166
diff changeset
115 %! [x, y, z] = sombrero ();
17120
a639221f9863 sombrero.m: Overhaul documentation and make calling forms equivalent to peaks()
Rik <rik@octave.org>
parents: 17077
diff changeset
116 %! [~, y] = meshgrid (x, y);
7269
3fade00a6ac7 [project @ 2007-12-07 19:26:20 by jwe]
jwe
parents: 7166
diff changeset
117 %! ribbon (y, z);
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
118
14229
741340c02522 ribbon.m: Simplify code and return a column vector of graphics handles.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
119 %!FIXME: Could have some input validation tests here
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14247
diff changeset
120