annotate scripts/plot/__pltopt__.m @ 6459:5dc550e1f419

[project @ 2007-03-26 18:11:58 by jwe]
author jwe
date Mon, 26 Mar 2007 18:11:58 +0000
parents 0078497b3b0b
children 76e3d985ae56
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2697
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
18 ## 02110-1301, USA.
933
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
19
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
20 ## -*- texinfo -*-
3500
7923abdeb4e5 [project @ 2000-01-31 06:35:00 by jwe]
jwe
parents: 3449
diff changeset
21 ## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt})
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
22 ## Decode plot option strings.
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
23 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
24 ## @var{opt} can currently be some combination of the following:
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
25 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
26 ## @table @code
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
27 ## @item "-"
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
28 ## For solid linestyle (default).
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
29 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
30 ## @item "--"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
31 ## For dashed line style.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
32 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
33 ## @item "-."
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
34 ## For linespoints plot style.
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
35 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
36 ## @item ":"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
37 ## For dots plot style.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
38 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
39 ## @item "r"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
40 ## Red line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
41 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
42 ## @item "g"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
43 ## Green line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
44 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
45 ## @item "b"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
46 ## Blue line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
47 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
48 ## @item "c"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
49 ## Cyan line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
50 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
51 ## @item "m"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
52 ## Magenta line color.
4006
efac4b97bb09 [project @ 2002-07-26 01:20:46 by jwe]
jwe
parents: 3717
diff changeset
53 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
54 ## @item "y"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
55 ## Yellow line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
56 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
57 ## @item "k"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
58 ## Black line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
59 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
60 ## @item "w"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
61 ## White line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
62 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
63 ## @item ";title;"
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
64 ## Here @code{"title"} is the label for the key.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
65 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
66 ## @item "+"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
67 ## @itemx "o"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
68 ## @itemx "*"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
69 ## @itemx "."
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
70 ## @itemx "x"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
71 ## @itemx "s"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
72 ## @itemx "d"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
73 ## @itemx "^"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
74 ## @itemx "v"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
75 ## @itemx ">"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
76 ## @itemx "<"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
77 ## @itemx "p"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
78 ## @itemx "h"
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
79 ## Used in combination with the points or linespoints styles, set the point
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
80 ## style.
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
81 ## @end table
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
82 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
83 ## The legend may be fixed to include the name of the variable
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
84 ## plotted in some future version of Octave.
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
85 ##
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5443
diff changeset
86 ## @seealso{__pltopt1__}
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
87 ## @end deftypefn
933
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
88
3162
7c96e85c76db [project @ 1998-04-08 18:19:35 by jwe]
jwe
parents: 3101
diff changeset
89 ## Author: jwe
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
90
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
91 function [options, valid] = __pltopt__ (caller, opt, err_on_invalid)
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
92
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
93 valid = true;
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
94 options = __default_plot_options__ ();
933
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
95
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
96 if ((nargin == 2 || nargin == 3) && (nargout == 1 || nargout == 2))
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
97 if (nargin == 2)
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
98 err_on_invalid = true;
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
99 endif
6146
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
100 if (ischar (opt))
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
101 nel = rows (opt);
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
102 elseif (iscellstr (opt))
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
103 nel = numel (opt);
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
104 else
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
105 error ("__pltopt__: expecting argument to be character string or cell array of character strings");
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
106 endif
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
107 if (ischar (opt))
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
108 opt = cellstr (opt);
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
109 endif
6264
cc2bee854d23 [project @ 2007-02-01 10:00:05 by jwe]
jwe
parents: 6146
diff changeset
110 for i = nel:-1:1
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
111 [options(i), valid] = __pltopt1__ (caller, opt{i}, err_on_invalid);
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
112 if (! err_on_invalid && ! valid)
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
113 return;
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6267
diff changeset
114 endif
6146
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
115 endfor
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
116 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
117 print_usage ();
933
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
118 endif
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
119
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
120 endfunction