Mercurial > octave

annotate scripts/plot/util/refreshdata.m @ 21758:ffad2baa90f7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Use newlines to make code more readable.
author Rik <rik@octave.org>
date Fri, 20 May 2016 15:46:45 -0700
parents 516bb87ea72e
children 1c4cd12987f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19593
diff changeset
1 ## Copyright (C) 2008-2015 David Bateman
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19833
diff changeset
20 ## @deftypefn {} {} refreshdata ()
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19833
diff changeset
21 ## @deftypefnx {} {} refreshdata (@var{h})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19833
diff changeset
22 ## @deftypefnx {} {} refreshdata (@var{h}, @var{workspace})
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
23 ## Evaluate any @samp{datasource} properties of the current figure and update
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
24 ## the plot if the corresponding data has changed.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
25 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
26 ## If the first argument @var{h} is a list of graphic handles, then operate
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
27 ## on these objects rather than the current figure returned by @code{gcf}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
28 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
29 ## The optional second argument @var{workspace} can take the following values:
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ##
11595
5ec6aa05638d Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
31 ## @table @asis
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17188
diff changeset
32 ## @item @qcode{"base"}
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
33 ## Evaluate the datasource properties in the base workspace. (default).
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
34 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17188
diff changeset
35 ## @item @qcode{"caller"}
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
36 ## Evaluate the datasource properties in the workspace of the function
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
37 ## that called @code{refreshdata}.
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
38 ## @end table
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
39 ##
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
40 ## An example of the use of @code{refreshdata} is:
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 ## @example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 ## @group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
44 ## x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 ## y = sin (x);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 ## plot (x, y, "ydatasource", "y");
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 ## for i = 1 : 100
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
48 ## pause (0.1);
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
49 ## y = sin (x + 0.1*i);
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
50 ## refreshdata ();
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
51 ## endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
52 ## @end group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
53 ## @end example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
54 ## @end deftypefn
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
55
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
56 function refreshdata (h, workspace)
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
57
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
58 if (nargin == 0)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
59 h = gcf ();
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
60 workspace = "base";
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 else
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
62 if (iscell (h))
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
63 h = [h{:}];
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
64 endif
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
65 if (! all (isfigure (h)))
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
66 error ("refreshdata: H must be a list of figure handles");
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 endif
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
68 if (nargin == 1)
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
69 workspace = "base";
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
70 elseif (nargin == 2)
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
71 if (! ischar (workspace)
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
72 || ! any (strcmpi (workspace, {"base", "caller"})))
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
73 error ('refreshdata: WORKSPACE must be "base" or "caller"');
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
74 endif
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
75 workspace = tolower (workspace);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
76 else
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
77 print_usage ();
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
78 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
79 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
80
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
81 h = findall (h);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
82 objs = [];
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
83 props = {};
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
84
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 for i = 1 : numel (h)
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
86 obj = get (h(i));
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
87 flds = fieldnames (obj);
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
88 ## regexp() is proper way to do searching, but is 3X slower.
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
89 ## Pretty unlikely that people are going to be adding datasource
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
90 ## properties that are not, in fact, datasources.
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
91 ## m = regexp (flds, '^.+datasource$');
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
92 m = strfind (flds, "datasource");
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
93 m = flds(! cellfun (@isempty, m));
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
94 for j = 1 : numel (m)
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
95 if (isempty (obj.(m{j})))
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
96 continue; # datasource field doesn't point to anything
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
97 endif
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
98 expr = obj.(m{j}); # datasource field
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
99 val = evalin (workspace, expr);
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
100 pdname = m{j}(1:end-6); # property data name without "source"
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
101 set (h(i), pdname, val);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
102 endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
103 endfor
21758
ffad2baa90f7 maint: Use newlines to make code more readable.
Rik <rik@octave.org>
parents: 20852
diff changeset
104
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
105 endfunction
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
106
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
107
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
108 %!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
109 %! clf;
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
110 %! x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
111 %! y = sin (x);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
112 %! plot (x, y, 'ydatasource', 'y');
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
113 %! title ('refreshdata() showing moving sine curve');
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
114 %! axis manual;
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
115 %! for i = 1 : 100
17188
b90915ba489d refreshdata.m: Recode for 17% faster performance.
Rik <rik@octave.org>
parents: 17122
diff changeset
116 %! pause (0);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
117 %! y = sin (x + 0.1 * i);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
118 %! refreshdata (gcf, 'caller');
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
119 %! end
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
120