Mercurial > hg > octave-nkf
annotate scripts/plot/findobj.m @ 14868:5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
* lin2mu.m, loadaudio.m, wavread.m, accumarray.m, bicubic.m, celldisp.m,
colon.m, cplxpair.m, dblquad.m, divergence.m, genvarname.m, gradient.m,
int2str.m, interp1.m, interp1q.m, interp2.m, interpn.m, loadobj.m, nthargout.m,
__isequal__.m, __splinen__.m, quadgk.m, quadl.m, quadv.m, rat.m, rot90.m,
rotdim.m, saveobj.m, subsindex.m, triplequad.m, delaunay3.m, griddata.m,
inpolygon.m, tsearchn.m, voronoi.m, get_first_help_sentence.m, which.m,
gray2ind.m, pink.m, dlmwrite.m, strread.m, textread.m, textscan.m, housh.m,
ishermitian.m, issymmetric.m, krylov.m, logm.m, null.m, rref.m,
compare_versions.m, copyfile.m, dump_prefs.m, edit.m, fileparts.m,
getappdata.m, isappdata.m, movefile.m, orderfields.m, parseparams.m,
__xzip__.m, rmappdata.m, setappdata.m, swapbytes.m, unpack.m, ver.m, fminbnd.m,
fminunc.m, fsolve.m, glpk.m, lsqnonneg.m, qp.m, sqp.m, configure_make.m,
copy_files.m, describe.m, get_description.m, get_forge_pkg.m, install.m,
installed_packages.m, is_architecture_dependent.m, load_package_dirs.m,
print_package_description.m, rebuild.m, repackage.m, save_order.m, shell.m,
allchild.m, ancestor.m, area.m, axes.m, axis.m, clabel.m, close.m, colorbar.m,
comet.m, comet3.m, contour.m, cylinder.m, ezmesh.m, ezsurf.m, findobj.m,
fplot.m, hist.m, isocolors.m, isonormals.m, isosurface.m, isprop.m, legend.m,
mesh.m, meshz.m, pareto.m, pcolor.m, peaks.m, plot3.m, plotmatrix.m, plotyy.m,
polar.m, print.m, __add_datasource__.m, __add_default_menu__.m,
__axes_limits__.m, __bar__.m, __clabel__.m, __contour__.m, __errcomm__.m,
__errplot__.m, __ezplot__.m, __file_filter__.m, __fltk_print__.m,
__ghostscript__.m, __gnuplot_print__.m, __go_draw_axes__.m,
__go_draw_figure__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m,
__pie__.m, __plt__.m, __print_parse_opts__.m, __quiver__.m, __scatter__.m,
__stem__.m, __tight_eps_bbox__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m,
__uiputfile_fltk__.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m,
ribbon.m, scatter.m, semilogy.m, shading.m, slice.m, subplot.m, surface.m,
surfl.m, surfnorm.m, text.m, uigetfile.m, uiputfile.m, whitebg.m, deconv.m,
mkpp.m, pchip.m, polyaffine.m, polyder.m, polygcd.m, polyout.m, polyval.m,
ppint.m, ppjumps.m, ppval.m, residue.m, roots.m, spline.m, splinefit.m,
addpref.m, getpref.m, setpref.m, ismember.m, setxor.m, arch_fit.m, arch_rnd.m,
arch_test.m, autoreg_matrix.m, diffpara.m, fftconv.m, filter2.m, hanning.m,
hurst.m, periodogram.m, triangle_sw.m, sinc.m, spectral_xdf.m, spencer.m,
stft.m, synthesis.m, unwrap.m, yulewalker.m, bicgstab.m, gmres.m, pcg.m, pcr.m,
__sprand_impl__.m, speye.m, spfun.m, sprandn.m, spstats.m, svds.m,
treelayout.m, treeplot.m, bessel.m, factor.m, legendre.m, perms.m, primes.m,
magic.m, toeplitz.m, corr.m, cov.m, mean.m, median.m, mode.m, qqplot.m,
quantile.m, ranks.m, zscore.m, logistic_regression_likelihood.m,
bartlett_test.m, chisquare_test_homogeneity.m, chisquare_test_independence.m,
kolmogorov_smirnov_test.m, run_test.m, u_test.m, wilcoxon_test.m, z_test.m,
z_test_2.m, bin2dec.m, dec2base.m, mat2str.m, strcat.m, strchr.m, strjust.m,
strtok.m, substr.m, untabify.m, assert.m, demo.m, example.m, fail.m, speed.m,
test.m, now.m: Use Octave coding conventions for cuddling parentheses in
scripts directory.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 17 Jul 2012 07:08:39 -0700 |
parents | 86854d032a37 |
children | 092d0a685546 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14001
diff
changeset
|
1 ## Copyright (C) 2007-2012 Ben Abbott |
6935 | 2 ## |
7016 | 3 ## This file is part of Octave. |
6935 | 4 ## |
7016 | 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. | |
6935 | 14 ## |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
6935 | 18 |
19 ## -*- texinfo -*- | |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
20 ## @deftypefn {Function File} {@var{h} =} findobj () |
8507 | 21 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}) |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
22 ## @deftypefnx {Function File} {@var{h} =} findobj ("-property", @var{prop_name}) |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
23 ## @deftypefnx {Function File} {@var{h} =} findobj ("-regexp", @var{prop_name}, @var{pattern}) |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
24 ## @deftypefnx {Function File} {@var{h} =} findobj ("flat", @dots{}) |
6935 | 25 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, @dots{}) |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
26 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, "-depth", @var{d}, @dots{}) |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13141
diff
changeset
|
27 ## Find graphics object with specified property values. The simplest form is |
6935 | 28 ## |
29 ## @example | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
30 ## findobj (@var{prop_name}, @var{prop_value}) |
6935 | 31 ## @end example |
32 ## | |
33 ## @noindent | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
34 ## which returns all of the handles to the objects with the name |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
35 ## @var{prop_name} and the name @var{prop_value}. The search can be limited |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
36 ## to a particular object or set of objects and their descendants by |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
37 ## passing a handle or set of handles @var{h} as the first argument to |
6935 | 38 ## @code{findobj}. |
39 ## | |
40 ## The depth of hierarchy of objects to which to search to can be limited | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
41 ## with the "-depth" argument. To limit the number depth of the hierarchy |
6935 | 42 ## to search to @var{d} generations of children, and example is |
43 ## | |
44 ## @example | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
45 ## findobj (@var{h}, "-depth", @var{d}, @var{prop_name}, @var{prop_value}) |
6935 | 46 ## @end example |
47 ## | |
48 ## Specifying a depth @var{d} of 0, limits the search to the set of object | |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
49 ## passed in @var{h}. A depth @var{d} of 0 is equivalent to the "-flat" |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
50 ## argument. |
6935 | 51 ## |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
52 ## A specified logical operator may be applied to the pairs of @var{prop_name} |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
53 ## and @var{prop_value}. The supported logical operators are "-and", "-or", |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
54 ## "-xor", "-not". |
6935 | 55 ## |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
56 ## The objects may also be matched by comparing a regular expression to the |
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
57 ## property values, where property values that match @code{regexp |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
58 ## (@var{prop_value}, @var{pattern})} are returned. Finally, objects may be |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
59 ## matched by property name only, using the "-property" option. |
6935 | 60 ## @seealso{get, set} |
61 ## @end deftypefn | |
62 | |
7017 | 63 ## Author: Ben Abbott <bpabbott@mac.com> |
64 | |
6935 | 65 function h = findobj (varargin) |
66 | |
67 depth = NaN; | |
68 if (nargin == 0) | |
69 handles = 0; | |
70 n1 = 0; | |
71 else | |
8265
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
72 if (! isempty (varargin{1})) |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
73 if (ishandle (varargin{1}(1))) |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
74 handles = varargin{1}; |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
75 n1 = 2; |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
76 else |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
77 handles = 0; |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
78 n1 = 1; |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
79 endif |
6935 | 80 else |
8265
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
81 ## Return [](0x1) for compatibility. |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
82 h = zeros (0, 1); |
1c213dff76fc
findobj.m: allow handle to be empty
Ben Abbott <bpabbott@mac.com>
parents:
8190
diff
changeset
|
83 return; |
7151 | 84 endif |
6935 | 85 if (n1 <= nargin) |
86 if (ischar (varargin{n1})) | |
10549 | 87 if (strcmpi (varargin{n1}, "flat")) |
88 depth = 0; | |
89 n1 = n1 + 1; | |
90 elseif (strcmpi (varargin{n1}, "-depth")) | |
91 depth = varargin{n1+1}; | |
92 n1 = n1 + 2; | |
93 endif | |
6935 | 94 else |
10549 | 95 error ("findobj: properties and options must be strings"); |
6935 | 96 endif |
97 endif | |
98 endif | |
99 | |
100 if (n1 <= nargin && nargin > 0) | |
101 args = varargin(n1 : nargin); | |
102 else | |
103 args = {}; | |
104 endif | |
105 | |
106 regularexpression = []; | |
107 property = []; | |
108 logicaloperator = {}; | |
109 pname = {}; | |
110 pvalue = {}; | |
111 np = 1; | |
112 na = 1; | |
113 | |
114 while (na <= numel (args)) | |
115 regularexpression(np) = 0; | |
116 property(np) = 0; | |
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
117 logicaloperator{np} = "and"; |
7208 | 118 if (ischar (args{na})) |
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
119 if (strcmpi (args{na}, "-regexp")) |
10549 | 120 if (na + 2 <= numel (args)) |
121 regularexpression(np) = 1; | |
122 na = na + 1; | |
123 pname{np} = args{na}; | |
124 na = na + 1; | |
125 pvalue{np} = args{na}; | |
126 na = na + 1; | |
127 np = np + 1; | |
128 else | |
129 error ("findobj: inconsistent number of arguments"); | |
130 endif | |
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
131 elseif (strcmpi (args{na}, "-property")) |
10549 | 132 if (na + 1 <= numel (args)) |
133 na = na + 1; | |
134 property(np) = 1; | |
135 pname{np} = args{na}; | |
136 na = na + 1; | |
137 pvalue{np} = []; | |
138 np = np + 1; | |
139 else | |
140 error ("findobj: inconsistent number of arguments"); | |
141 endif | |
8506 | 142 elseif (! strcmp (args{na}(1), "-")) |
10549 | 143 ## Parameter/value pairs. |
144 if (na + 1 <= numel (args)) | |
145 pname{np} = args{na}; | |
146 na = na + 1; | |
147 pvalue{np} = args{na}; | |
148 na = na + 1; | |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14552
diff
changeset
|
149 if (na <= numel (args)) |
10549 | 150 if (ischar (args{na})) |
14552
86854d032a37
maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents:
14327
diff
changeset
|
151 if (strcmpi (args{na}, "-and")) |
10549 | 152 logicaloperator{np} = "and"; |
153 na = na+1; | |
14552
86854d032a37
maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents:
14327
diff
changeset
|
154 elseif (strcmpi (args{na}, "-or")) |
10549 | 155 logicaloperator{np} = "or"; |
156 na = na+1; | |
14552
86854d032a37
maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents:
14327
diff
changeset
|
157 elseif (strcmpi (args{na}, "-xor")) |
10549 | 158 logicaloperator{np} = "xor"; |
159 na = na+1; | |
14552
86854d032a37
maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents:
14327
diff
changeset
|
160 elseif (strcmpi (args{na}, "-not")) |
10549 | 161 logicaloperator{np} = "not"; |
162 na = na+1; | |
163 endif | |
164 else | |
165 error ("findobj: properties and options must be strings"); | |
166 endif | |
167 else | |
168 logicaloperator{np} = "and"; | |
169 endif | |
170 np = np + 1; | |
171 else | |
172 error ("findobj: inconsistent number of arguments"); | |
173 endif | |
6935 | 174 else |
10549 | 175 ## This is sloppy ... but works like Matlab. |
14552
86854d032a37
maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents:
14327
diff
changeset
|
176 if (strcmpi (args{na}, "-not")) |
10549 | 177 h = []; |
178 return | |
179 endif | |
180 na = na + 1; | |
6935 | 181 endif |
182 else | |
183 error ("findobj: properties and options must be strings"); | |
184 endif | |
185 endwhile | |
186 | |
187 numpairs = np - 1; | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
188 |
8506 | 189 ## Load all objects which qualify for being searched. |
6935 | 190 idepth = 0; |
191 h = handles; | |
192 while (numel (handles) && ! (idepth >= depth)) | |
193 children = []; | |
194 for n = 1 : numel (handles) | |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14552
diff
changeset
|
195 children = union (children, get (handles(n), "children")); |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
196 endfor |
6935 | 197 handles = children; |
198 h = union (h, children); | |
199 idepth = idepth + 1; | |
200 endwhile | |
201 | |
202 keepers = ones (size (h)); | |
203 if (numpairs > 0) | |
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14552
diff
changeset
|
204 for nh = 1 : numel (h) |
6935 | 205 p = get (h (nh)); |
206 for np = 1 : numpairs | |
10549 | 207 fields = fieldnames (p); |
208 fieldindex = find (strcmpi (fields, pname{np}), 1); | |
209 if (numel (fieldindex)) | |
6935 | 210 pname{np} = fields{fieldindex}; |
211 if (property(np)) | |
212 match = 1; | |
213 else | |
214 if (regularexpression(np)) | |
10549 | 215 match = regexp (p.(pname{np}), pvalue{np}); |
14552
86854d032a37
maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents:
14327
diff
changeset
|
216 if (isempty (match)) |
6935 | 217 match = 0; |
7151 | 218 endif |
6935 | 219 elseif (numel (p.(pname{np})) == numel (pvalue{np})) |
10549 | 220 if (ischar (pvalue{np})) |
221 match = strcmpi (pvalue{np}, p.(pname{np})); | |
222 else | |
223 match = (pvalue{np} == p.(pname{np})); | |
224 endif | |
6935 | 225 else |
10549 | 226 match = 0; |
6935 | 227 endif |
228 match = all (match); | |
229 endif | |
8190
73d6b71788c0
use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents:
7208
diff
changeset
|
230 if (strcmpi (logicaloperator{np}, "not")) |
6935 | 231 keepers(nh) = ! keepers(nh) & ! match; |
232 else | |
233 keepers(nh) = feval (logicaloperator{np}, keepers(nh), match); | |
234 endif | |
10549 | 235 else |
236 keepers(nh) = 0; | |
237 endif | |
6935 | 238 endfor |
239 endfor | |
240 endif | |
241 | |
242 h = h (keepers != 0); | |
243 h = reshape (h, [numel(h), 1]); | |
244 endfunction | |
13096 | 245 |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13141
diff
changeset
|
246 |
13096 | 247 %!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:
13111
diff
changeset
|
248 %! 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
|
249 %! unwind_protect |
13096 | 250 %! l = line; |
13111
ebb42fb2da04
Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
251 %! obj = findobj (hf, "type", "line"); |
13096 | 252 %! assert (l, obj); |
13111
ebb42fb2da04
Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
253 %! assert (gca, findobj (hf, "type", "axes")); |
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:
13111
diff
changeset
|
254 %! assert (hf, findobj (hf, "type", "figure")); |
13111
ebb42fb2da04
Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
13096
diff
changeset
|
255 %! assert (isempty (findobj (hf, "type", "xyzxyz"))); |
13096 | 256 %! unwind_protect_cleanup |
257 %! close (hf); | |
258 %! end_unwind_protect | |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13141
diff
changeset
|
259 |