octave-nkf: scripts/plot/daspect.m annotate

annotate scripts/plot/daspect.m @ 12526:f8ea3eabcb85

Add daspect, pbaspect functions to documentation.

author	Rik <octave@nomad.inbox5.com>
date	Sat, 19 Mar 2011 12:12:57 -0700
parents	b0084095098e
children	d0b799dafede

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11310 diff changeset	1 ## Copyright (C) 2010-2011 Ben Abbott
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	2 ##
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10931 diff changeset	3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10931 diff changeset	4 ##
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10931 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: 10931 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: 10931 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: 10931 diff changeset	8 ## your option) any later version.
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10931 diff changeset	9 ##
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10931 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: 10931 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10931 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10931 diff changeset	13 ## General Public License for more details.
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10931 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 --
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	20 ## @deftypefn {Function File} {} daspect (@var{data_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 data aspect ratio of the current axes. The aspect ratio is
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	22 ## a normalized 3-element vector representing the span of the x, y, and
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	23 ## z-axes limits.
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	24 ##
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	25 ## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect ( )
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	26 ## Return the data aspect ratio of the current axes.
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	27 ##
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	28 ## @deftypefnx {Function File} {} daspect (@var{mode})
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	29 ## Set the data aspect ratio mode of the current axes.
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	30 ##
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	31 ## @deftypefnx {Function File} {@var{data_aspect_ratio_mode} =} daspect ("mode")
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	32 ## Return the data aspect ratio mode of the current axes.
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 11589 diff changeset	33 ##
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	34 ## @deftypefnx {Function File} {} daspect (@var{hax}, @dots{})
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	35 ## 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	36 ##
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	37 ## @seealso{axis, pbaspect, xlim, ylim, zlim}
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	38 ## @end deftypefn
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	39
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	40 ## Author: Ben Abbott <bpabbott@mac.com>
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	41 ## Created: 2010-01-26
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 function varargout = daspect (varargin)
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	44
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	45 hax = gca ();
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	46
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	47 if (nargin > 0)
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	48 if (isscalar (varargin{1}) && ishandle (varargin{1}))
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	49 hax = varargin{1};
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	50 varargin = varargin(2:end);
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	51 endif
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	52 endif
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	53 if (numel (varargin) > 0)
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	54 if (numel (varargin) == 1)
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	55 if (ischar (varargin{1})
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	56 && 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	57 switch (varargin{1})
a44f979a35ce style fixes for some .m files John W. Eaton <jwe@octave.org> parents: 11113 diff changeset	58 case "mode"
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	59 if (nargout < 2)
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	60 varargout{1} = get (hax, "dataaspectratiomode");
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	61 return
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	62 else
11589 b0084095098e missing semicolons in script files John W. Eaton <jwe@octave.org> parents: 11588 diff changeset	63 error ("daspect: only one output is allowed");
11113 a8ac114ec9ab Stylefixes, replace end by endif. Thorsten Meyer <thorsten.meyier@gmx.de> parents: 11104 diff changeset	64 endif
11120 a44f979a35ce style fixes for some .m files John W. Eaton <jwe@octave.org> parents: 11113 diff changeset	65 case "manual"
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	66 set (hax, "dataaspectratiomode", "manual");
11120 a44f979a35ce style fixes for some .m files John W. Eaton <jwe@octave.org> parents: 11113 diff changeset	67 case "auto"
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	68 set (hax, "dataaspectratiomode", "auto");
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	69 endswitch
11310 ffbcb0edfbda Fix handling of input array of length 2 in daspect.m and pbaspect.m Ben Abbott <bpabbott@mac.com> parents: 11205 diff changeset	70 elseif (isreal (varargin{1}) && numel (varargin{1}) == 2)
11589 b0084095098e missing semicolons in script files John W. Eaton <jwe@octave.org> parents: 11588 diff changeset	71 set (hax, "dataaspectratio", [varargin{1}, 1]);
11310 ffbcb0edfbda Fix handling of input array of length 2 in daspect.m and pbaspect.m Ben Abbott <bpabbott@mac.com> parents: 11205 diff changeset	72 elseif (isreal (varargin{1}) && numel (varargin{1}) == 3)
11589 b0084095098e missing semicolons in script files John W. Eaton <jwe@octave.org> parents: 11588 diff changeset	73 set (hax, "dataaspectratio", varargin{1});
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	74 else
11589 b0084095098e missing semicolons in script files John W. Eaton <jwe@octave.org> parents: 11588 diff changeset	75 error ("daspect: invalid input");
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	76 endif
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	77 elseif (numel (varargin) > 1)
11589 b0084095098e missing semicolons in script files John W. Eaton <jwe@octave.org> parents: 11588 diff changeset	78 error ("daspect: too many inputs");
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	79 endif
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	80 elseif (nargout == 0)
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	81 print_usage ();
11113 a8ac114ec9ab Stylefixes, replace end by endif. Thorsten Meyer <thorsten.meyier@gmx.de> parents: 11104 diff changeset	82 endif
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	83
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	84 if (nargout == 1)
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	85 varargout{1} = get (hax, "dataaspectratio");
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	86 elseif (nargout > 1)
11589 b0084095098e missing semicolons in script files John W. Eaton <jwe@octave.org> parents: 11588 diff changeset	87 error ("daspect: only one output is allowed");
11113 a8ac114ec9ab Stylefixes, replace end by endif. Thorsten Meyer <thorsten.meyier@gmx.de> parents: 11104 diff changeset	88 endif
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	89
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	90 endfunction
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	91
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	92 %!demo
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	93 %! x = 0:0.01:4;
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	94 %! clf
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	95 %! plot (x, cos (x), x, sin (x))
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	96 %! axis square
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	97 %! daspect ([1 1 1])
10931 a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	98 %! title ("square plot-box with axis limits [0, 4, -2, 2]")
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	99
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	100 %!demo
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	101 %! x = 0:0.01:4;
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	102 %! clf
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	103 %! plot (x, cos (x), x, sin (x))
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	104 %! axis ([0 4 -1 1])
ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	105 %! daspect ([2 1 1])
10931 a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	106 %! title ("square plot-box with axis limits [0, 4, -1, 1]")
10218 ce94aaa71a4f daspect.m, pbaspect.m: New functions. Ben Abbott <bpabbott@mac.com> parents: diff changeset	107
10931 a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	108 %!demo
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	109 %! x = 0:0.01:4;
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	110 %! clf
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	111 %! plot (x, cos (x), x, sin (x))
11205 abee8cc4820f daspect.m: Fix demo using both daspect and pbaspect. Ben Abbott <bpabbott@mac.com> parents: 11161 diff changeset	112 %! daspect ([1 2 1])
11161 2e32236eaa90 Add demos setting both data and plotbox aspect ratios. Ben Abbott <bpabbott@mac.com> parents: 11120 diff changeset	113 %! pbaspect ([2 1 1])
2e32236eaa90 Add demos setting both data and plotbox aspect ratios. Ben Abbott <bpabbott@mac.com> parents: 11120 diff changeset	114 %! title ("2x1 plot box with axis limits [0, 4, -2, 2]")
2e32236eaa90 Add demos setting both data and plotbox aspect ratios. Ben Abbott <bpabbott@mac.com> parents: 11120 diff changeset	115
2e32236eaa90 Add demos setting both data and plotbox aspect ratios. Ben Abbott <bpabbott@mac.com> parents: 11120 diff changeset	116 %!demo
2e32236eaa90 Add demos setting both data and plotbox aspect ratios. Ben Abbott <bpabbott@mac.com> parents: 11120 diff changeset	117 %! x = 0:0.01:4;
2e32236eaa90 Add demos setting both data and plotbox aspect ratios. Ben Abbott <bpabbott@mac.com> parents: 11120 diff changeset	118 %! clf
2e32236eaa90 Add demos setting both data and plotbox aspect ratios. Ben Abbott <bpabbott@mac.com> parents: 11120 diff changeset	119 %! plot (x, cos (x), x, sin (x))
10931 a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	120 %! axis square
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	121 %! set (gca, "activepositionproperty", "position")
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	122 %! daspect ([1 1 1])
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	123 %! title ("square plot-box with axis limits [0, 4, -2, 2]")
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	124
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	125 %!demo
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	126 %! x = 0:0.01:4;
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	127 %! clf
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	128 %! plot (x, cos (x), x, sin (x))
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	129 %! axis ([0 4 -1 1])
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	130 %! set (gca, "activepositionproperty", "position")
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	131 %! daspect ([2 1 1])
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	132 %! title ("square plot-box with axis limits [0, 4, -1, 1]")
a72d53df4fa6 Treatment of activepositionproperty for gnuplot. Ben Abbott <bpabbott@mac.com> parents: 10711 diff changeset	133

Mercurial > octave-nkf

annotate scripts/plot/daspect.m @ 12526:f8ea3eabcb85