Mercurial > octave-nkf

annotate scripts/plot/clabel.m @ 14335:ce2b59a6d0e5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: periodic merge of stable to default.
author Rik <octave@nomad.inbox5.com>
date Sun, 05 Feb 2012 15:32:24 -0800
parents c4fa5e0b6193 4d917a6a858b
children 5d3a684236b0
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: 14001
diff changeset
1 ## Copyright (C) 2008-2012 David Bateman
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
20 ## @deftypefn {Function File} {} clabel (@var{c}, @var{h})
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h}, @var{v})
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h}, "manual")
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## @deftypefnx {Function File} {} clabel (@var{c})
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## @deftypefnx {Function File} {} clabel (@var{c}, @var{h})
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 ## @deftypefnx {Function File} {} clabel (@dots{}, @var{prop}, @var{val}, @dots{})
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ## @deftypefnx {Function File} {@var{h} =} clabel (@dots{})
12575
d0b799dafede Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents: 11589
diff changeset
27 ## Add labels to the contours of a contour plot. The contour plot is specified
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 ## by the contour matrix @var{c} and optionally the contourgroup object @var{h}
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 ## that are returned by @code{contour}, @code{contourf} and @code{contour3}.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ## The contour labels are rotated and placed in the contour itself.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 ##
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9040
diff changeset
32 ## By default, all contours are labeled. However, the contours to label can be
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
33 ## specified by the vector @var{v}. If the "manual" argument is given then
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 ## the contours to label can be selected with the mouse.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 ##
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 ## Additional property/value pairs that are valid properties of text objects
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
37 ## can be given and are passed to the underlying text objects. Additionally,
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
38 ## the property "LabelSpacing" is available allowing the spacing between labels
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
39 ## on a contour (in points) to be specified. The default is 144 points, or 2
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 ## inches.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
42 ## 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: 12575
diff changeset
43 ## the text objects representing each label.
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
44 ## The "userdata" property of the text objects contains the numerical value of
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
45 ## the contour label.
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 ##
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 ## An example of the use of @code{clabel} is
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
48 ##
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
49 ## @example
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
51 ## [c, h] = contour (peaks (), -4 : 6);
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
52 ## clabel (c, h, -4:2:6, "fontsize", 12);
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
53 ## @end group
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
54 ## @end example
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
55 ##
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
56 ## @seealso{contour, contourf, contour3, meshc, surfc, text}
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
57 ## @end deftypefn
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
58
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
59 function retval = clabel (c, varargin)
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
60 label_spacing = 2 * 72;
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 have_hg = false;
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
62 have_labelspacing = false;
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
63
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
64 if (nargin < 1)
11589
b0084095098e missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
65 print_usage ();
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
66 elseif (nargin == 1)
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 hparent = gca ();
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
68 else
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
69 arg = varargin{1};
11149
fe3c3dfc07eb style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
70 if (isscalar (arg) && ishandle(arg)
fe3c3dfc07eb style fix: break lines before && and ||, not after
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
71 && strcmp (get (arg, "type"), "hggroup"))
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
72 obj = get (arg);
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
73 if (! isfield (obj, "contourmatrix"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9672
diff changeset
74 error ("clabel: expecting the handle to be a contour group");
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
75 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
76 hg = arg;
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
77 have_hg = true;
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
78 varargin(1) = [];
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
79 else
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
80 hparent = gca ();
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
81 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
82 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
83
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
84 if (length(varargin) > 0 && isnumeric (varargin{1}))
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 v = varargin{1}(:);
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
86 varargin(1) = [];
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
87 else
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
88 v = [];
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
89 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
90
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
91 for i = 1 : length (varargin) - 1
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
92 arg = varargin{i};
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
93 if (strcmpi (arg, "labelspacing"))
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
94 label_spacing = varargin{i+1};
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
95 have_labelspacing = true;
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
96 varargin(i:i+1) = [];
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
97 break;
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
98 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
99 endfor
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
100
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
101 for i = 1 : length (varargin)
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
102 arg = varargin{i};
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
103 if (strcmpi (arg, "manual"))
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
104 error ("clabel: manual contouring mode not supported");
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
105 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
106 endfor
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
107
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
108 if (have_hg)
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
109 if (! isempty (v))
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
110 if (have_labelspacing)
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
111 set (hg, "textlistmode", "manual", "textlist", v,
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9672
diff changeset
112 "labelspacing", label_spacing, "showtext", "on");
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
113 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9672
diff changeset
114 set (hg, "textlistmode", "manual", "textlist", v, "showtext", "on");
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
115 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
116 else
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
117 if (have_labelspacing)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9672
diff changeset
118 set (hg,"showtext", "on", "labelspacing", label_spacing);
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
119 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9672
diff changeset
120 set (hg,"showtext", "on");
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
121 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
122 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
123 retval = findobj (hg, "type", "text");
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
124 if (! isempty (varargin))
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
125 set (retval, varargin {:});
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
126 endif
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
127 else
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
128 retval = __clabel__ (c, v, hparent, label_spacing, [], varargin{:});
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
129 endif
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
130
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
131 endfunction
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
132
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
133
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
diff changeset
134 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
135 %! clf;
14247
c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents: 14245
diff changeset
136 %! colormap ('default');
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
137 %! [c, h] = contour (peaks (), -4:6);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
138 %! clabel (c, h, -4:2:6, 'fontsize', 12);
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
139
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
140 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
141 %! clf;
14247
c4fa5e0b6193 test: Make surface demos reproducible by setting colormap to default at start of demo.
Rik <octave@nomad.inbox5.com>
parents: 14245
diff changeset
142 %! colormap ('default');
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
143 %! [c, h] = contourf (peaks (), -7:6);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
144 %! clabel (c, h, -6:2:6, 'fontsize', 12);
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
145