1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
########################################################################
##
## Copyright (C) 2008-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} clabel (@var{c}, @var{h})
## @deftypefnx {} {} clabel (@var{c}, @var{h}, @var{v})
## @deftypefnx {} {} clabel (@var{c}, @var{h}, "manual")
## @deftypefnx {} {} clabel (@var{c})
## @deftypefnx {} {} clabel (@dots{}, @var{prop}, @var{val}, @dots{})
## @deftypefnx {} {@var{hlabels} =} clabel (@dots{})
## Add labels to the contours of a contour plot.
##
## The contour levels are specified by the contour matrix @var{c} which is
## returned by @code{contour}, @code{contourc}, @code{contourf}, and
## @code{contour3}. Contour labels are rotated to match the local line
## orientation and centered on the line. The position of labels along the
## contour line is chosen randomly.
##
## If the argument @var{h} is a handle to a contour group object, then label
## this plot rather than the one in the current axes returned by @code{gca}.
##
## By default, all contours are labeled. However, the contours to label can be
## specified by the vector @var{v}. If the @qcode{"manual"} argument is
## given then the contours to label can be selected with the mouse.
##
## Additional property/value pairs that are valid properties of text objects
## can be given and are passed to the underlying text objects. Moreover,
## the contour group property @qcode{"LabelSpacing"} is available which
## determines the spacing between labels on a contour to be specified. The
## default is 144 points, or 2 inches.
##
## The optional return value @var{hlabels} is a vector of graphics handles to
## the text objects representing each label.
## The @qcode{"userdata"} property of the text objects contains the numerical
## value of the contour label.
##
## The full list of text object properties is documented at
## @ref{Text Properties}.
##
## @example
## @group
## [c, h] = contour (peaks (), -4 : 6);
## clabel (c, h, -4:2:6, "fontsize", 12);
## @end group
## @end example
##
## @seealso{contour, contourf, contour3, meshc, surfc, text}
## @end deftypefn
function hlabels = clabel (c, varargin)
have_hg = false;
have_labelspacing = false;
label_spacing = 144; # 2 inches in points
if (nargin < 1)
print_usage ();
elseif (nargin == 1)
hparent = gca ();
else
arg = varargin{1};
if (isscalar (arg) && isgraphics (arg, "hggroup"))
try
get (arg, "contourmatrix");
catch
error ("clabel: H must be a handle to a contour group");
end_try_catch
have_hg = true;
hg = arg;
varargin(1) = [];
else
hparent = gca ();
endif
endif
if (length (varargin) > 0 && isnumeric (varargin{1}))
v = varargin{1}(:);
varargin(1) = [];
else
v = [];
endif
idx = strcmpi (varargin(1:2:end), "manual");
if (any (idx))
error ('clabel: "manual" contour mode is not supported');
endif
idx = find (strcmpi (varargin(1:2:end), "labelspacing"), 1);
if (! isempty (idx))
have_labelspacing = true;
label_spacing = varargin{2*idx};
varargin(2*idx+(-1:0)) = [];
endif
if (have_hg)
if (! isempty (v))
if (have_labelspacing)
set (hg, "textlistmode", "manual", "textlist", v,
"labelspacing", label_spacing, "showtext", "on");
else
set (hg, "textlistmode", "manual", "textlist", v, "showtext", "on");
endif
else
if (have_labelspacing)
set (hg, "showtext", "on", "labelspacing", label_spacing);
else
set (hg, "showtext", "on");
endif
endif
htmp = findobj (hg, "type", "text");
if (! isempty (varargin))
set (htmp, varargin{:});
endif
else
htmp = __clabel__ (c, v, hparent, label_spacing, [], varargin{:});
endif
if (nargout > 0)
hlabels = htmp;
endif
endfunction
%!demo
%! clf;
%! colormap ("default");
%! [c, h] = contour (peaks (), -4:6);
%! clabel (c, h, -4:2:6, "fontsize", 12);
%! title ("clabel() labeling every other contour");
%!demo
%! clf;
%! colormap ("default");
%! [c, h] = contourf (peaks (), -7:6);
%! clabel (c, h, -6:2:6, "fontsize", 12);
%! title ("clabel() labeling every other contour");
|
