Mercurial > hg > octave-nkf

annotate scripts/plot/pbaspect.m @ 11310:ffbcb0edfbda

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix handling of input array of length 2 in daspect.m and pbaspect.m
author Ben Abbott <bpabbott@mac.com>
date Fri, 03 Dec 2010 07:39:18 -0500
parents 2e32236eaa90
children fd0a3ac60b0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
1 ## Copyright (C) 2010 Ben Abbott
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
2 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
4 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
6 ## under the terms of the GNU General Public License as published by
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
8 ## your option) any later version.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
9 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
13 ## General Public License for more details.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10711
diff changeset
14 ##
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
18
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
19 ## -*- texinfo -*-
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
20 ## @deftypefn {Function File} {} pbaspect (@var{plot_box_aspect_ratio})
10711
fbd7843974fa Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents: 10218
diff changeset
21 ## Set the plot box aspect ratio of the current axes. The aspect ratio
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
22 ## is a normalized 3 element vector representing the rendered lengths of
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
23 ## the x, y, and z-axes.
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
24 ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( )
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
25 ## Return the plot box aspect ratio of the current axes.
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
26 ## @deftypefnx {Function File} {} pbaspect (@var{mode})
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
27 ## Set the plot box aspect ratio mode of the current axes.
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
28 ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode")
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
29 ## Return the plot box aspect ratio mode of the current axes.
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
30 ## @deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{})
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
31 ## Uses the axes, with handle @var{hax}, instead of the current axes.
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
32 ##
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
33 ## @seealso{axis, daspect, xlim, ylim, zlim}
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
34 ## @end deftypefn
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
35
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
36 ## Author: Ben Abbott <bpabbott@mac.com>
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
37 ## Created: 2010-01-26
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
38
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
39 function varargout = pbaspect (varargin)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
40
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
41 hax = gca ();
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
42
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
43 if (nargin > 0)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
44 if (isscalar (varargin{1}) && ishandle (varargin{1}))
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
45 hax = varargin{1};
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
46 varargin = varargin(2:end);
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
47 endif
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
48 endif
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
49 if (numel (varargin) > 0)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
50 if (numel (varargin) == 1)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
51 if (ischar (varargin{1})
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
52 && any (strcmpi (varargin{1}, {"mode", "manual", "auto"})))
11120
a44f979a35ce style fixes for some .m files
John W. Eaton <jwe@octave.org>
parents: 11113
diff changeset
53 switch (varargin{1})
a44f979a35ce style fixes for some .m files
John W. Eaton <jwe@octave.org>
parents: 11113
diff changeset
54 case "mode"
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
55 if (nargout < 2)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
56 varargout{1} = get (hax, "plotboxaspectratiomode");
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
57 return
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
58 else
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
59 error ("pbaspect: only one output is allowed.")
11113
a8ac114ec9ab Stylefixes, replace end by endif.
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 11104
diff changeset
60 endif
11120
a44f979a35ce style fixes for some .m files
John W. Eaton <jwe@octave.org>
parents: 11113
diff changeset
61 case "manual"
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
62 set (hax, "plotboxaspectratiomode", "manual");
11120
a44f979a35ce style fixes for some .m files
John W. Eaton <jwe@octave.org>
parents: 11113
diff changeset
63 case "auto"
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
64 set (hax, "plotboxaspectratiomode", "auto");
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
65 endswitch
11310
ffbcb0edfbda Fix handling of input array of length 2 in daspect.m and pbaspect.m
Ben Abbott <bpabbott@mac.com>
parents: 11161
diff changeset
66 elseif (isreal (varargin{1}) && numel (varargin{1}) == 2)
ffbcb0edfbda Fix handling of input array of length 2 in daspect.m and pbaspect.m
Ben Abbott <bpabbott@mac.com>
parents: 11161
diff changeset
67 set (hax, "plotboxaspectratio", [varargin{1}, 1])
ffbcb0edfbda Fix handling of input array of length 2 in daspect.m and pbaspect.m
Ben Abbott <bpabbott@mac.com>
parents: 11161
diff changeset
68 elseif (isreal (varargin{1}) && numel (varargin{1}) == 3)
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
69 set (hax, "plotboxaspectratio", varargin{1})
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
70 else
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
71 error ("pbaspect: invalid input.")
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
72 endif
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
73 elseif (numel (varargin) > 1)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
74 error ("pbaspect: too many inputs.")
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
75 endif
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
76 elseif (nargout == 0)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
77 print_usage ();
11113
a8ac114ec9ab Stylefixes, replace end by endif.
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 11104
diff changeset
78 endif
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
79
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
80 if (nargout == 1)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
81 varargout{1} = get (hax, "plotboxaspectratio");
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
82 elseif (nargout > 1)
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
83 error ("pbaspect: only one output is allowed.")
11113
a8ac114ec9ab Stylefixes, replace end by endif.
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 11104
diff changeset
84 endif
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
85
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
86 endfunction
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
87
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
88 %!demo
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
89 %! x = 0:0.01:4;
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
90 %! clf
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
91 %! plot (x, cos (x), x, sin (x))
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
92 %! pbaspect ([1 1 1])
11161
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
93 %! title ("plot box should be square")
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
94
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
95 %!demo
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
96 %! x = 0:0.01:4;
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
97 %! clf
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
98 %! plot (x, cos (x), x, sin (x))
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
99 %! pbaspect ([2 1 1])
11161
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
100 %! title ("plot box aspect ratio should be 2x1")
10218
ce94aaa71a4f daspect.m, pbaspect.m: New functions.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
101
11161
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
102 %!demo
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
103 %! x = 0:0.01:4;
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
104 %! clf
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
105 %! plot (x, cos (x), x, sin (x))
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
106 %! daspect ([1 1 1])
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
107 %! pbaspect ([2 1 1])
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
108 %! title ("plot box should be 2x1, and axes [0 4 -1 1]")
2e32236eaa90 Add demos setting both data and plotbox aspect ratios.
Ben Abbott <bpabbott@mac.com>
parents: 11120
diff changeset
109