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

annotate scripts/plot/subplot.m @ 10821:693e22af08ae

Grammarcheck documentation of m-files Add newlines between @item fields for readability.

author	Rik <octave@nomad.inbox5.com>
date	Mon, 26 Jul 2010 21:25:36 -0700
parents	be55736a0783
children	a72d53df4fa6

rev	line source
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	1 ## Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2002, 2003, 2005,
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8804 diff changeset	2 ## 2006, 2007, 2008, 2009 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6828 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6828 diff changeset	9 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	16 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6828 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6828 diff changeset	18 ## <http://www.gnu.org/licenses/>.
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	19
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	20 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	21 ## @deftypefn {Function File} {} subplot (@var{rows}, @var{cols}, @var{index})
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	22 ## @deftypefnx {Function File} {} subplot (@var{rcn})
6448 2110cc251779 [project @ 2007-03-24 02:47:36 by jwe] jwe parents: 6425 diff changeset	23 ## Set up a plot grid with @var{cols} by @var{rows} subwindows and plot
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe] jwe parents: 6425 diff changeset	24 ## in location given by @var{index}.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3368 diff changeset	25 ##
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	26 ## If only one argument is supplied, then it must be a three digit value
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	27 ## specifying the location in digits 1 (rows) and 2 (columns) and the plot
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	28 ## index in digit 3.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3368 diff changeset	29 ##
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	30 ## The plot index runs row-wise. First all the columns in a row are filled
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	31 ## and then the next row is filled.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3368 diff changeset	32 ##
5798 7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe] jwe parents: 5775 diff changeset	33 ## For example, a plot with 2 by 3 grid will have plot indices running as
2311 2b5788792cad [project @ 1996-07-11 20:18:38 by jwe] jwe parents: 2303 diff changeset	34 ## follows:
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	35 ## @tex
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	36 ## \vskip 10pt
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	37 ## \hfil\vbox{\offinterlineskip\hrule
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	38 ## \halign{\vrule#&&\qquad\hfil#\hfil\qquad\vrule\cr
7107 22397f0fb0b2 [project @ 2007-11-06 20:31:33 by dbateman] dbateman parents: 7086 diff changeset	39 ## height13pt&1&2&3\cr height12pt&&&\cr\noalign{\hrule}
22397f0fb0b2 [project @ 2007-11-06 20:31:33 by dbateman] dbateman parents: 7086 diff changeset	40 ## height13pt&4&5&6\cr height12pt&&&\cr\noalign{\hrule}}}
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	41 ## \hfil
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	42 ## \vskip 10pt
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	43 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8350 diff changeset	44 ## @ifnottex
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	45 ##
8350 0e3a92a8683c fix texi bug in subplot.m Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8232 diff changeset	46 ## @example
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	47 ## @group
7040 1f16da18d85d [project @ 2007-10-19 18:24:19 by jwe] jwe parents: 7017 diff changeset	48 ## +-----+-----+-----+
1f16da18d85d [project @ 2007-10-19 18:24:19 by jwe] jwe parents: 7017 diff changeset	49 ## \| 1 \| 2 \| 3 \|
1f16da18d85d [project @ 2007-10-19 18:24:19 by jwe] jwe parents: 7017 diff changeset	50 ## +-----+-----+-----+
1f16da18d85d [project @ 2007-10-19 18:24:19 by jwe] jwe parents: 7017 diff changeset	51 ## \| 4 \| 5 \| 6 \|
1f16da18d85d [project @ 2007-10-19 18:24:19 by jwe] jwe parents: 7017 diff changeset	52 ## +-----+-----+-----+
8350 0e3a92a8683c fix texi bug in subplot.m Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8232 diff changeset	53 ## @end group
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6178 diff changeset	54 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	55 ##
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 8350 diff changeset	56 ## @end ifnottex
5798 7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe] jwe parents: 5775 diff changeset	57 ## @seealso{plot}
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3233 diff changeset	58 ## @end deftypefn
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	59
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	60 ## Author: Vinayak Dutt <Dutt.Vinayak@mayo.EDU>
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	61 ## Adapted-By: jwe
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	62
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6178 diff changeset	63 function h = subplot (rows, columns, index)
6163 8614649c454c [project @ 2006-11-14 18:52:34 by jwe] jwe parents: 6046 diff changeset	64
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	65 if (nargin != 3 && nargin != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5798 diff changeset	66 print_usage ();
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	67 endif
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	68
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	69 if (nargin == 1)
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	70
4030 22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe] jwe parents: 3426 diff changeset	71 if (! (isscalar (rows) && rows >= 0))
1541 47bd45a30dda [project @ 1995-10-06 03:40:11 by jwe] jwe parents: 1540 diff changeset	72 error ("subplot: input rcn has to be a positive scalar");
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	73 endif
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	74
1541 47bd45a30dda [project @ 1995-10-06 03:40:11 by jwe] jwe parents: 1540 diff changeset	75 tmp = rows;
47bd45a30dda [project @ 1995-10-06 03:40:11 by jwe] jwe parents: 1540 diff changeset	76 index = rem (tmp, 10);
47bd45a30dda [project @ 1995-10-06 03:40:11 by jwe] jwe parents: 1540 diff changeset	77 tmp = (tmp - index) / 10;
47bd45a30dda [project @ 1995-10-06 03:40:11 by jwe] jwe parents: 1540 diff changeset	78 columns = rem (tmp, 10);
47bd45a30dda [project @ 1995-10-06 03:40:11 by jwe] jwe parents: 1540 diff changeset	79 tmp = (tmp - columns) / 10;
47bd45a30dda [project @ 1995-10-06 03:40:11 by jwe] jwe parents: 1540 diff changeset	80 rows = rem (tmp, 10);
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	81
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	82 elseif (! (isscalar (columns) && isscalar (rows)))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	83 error ("subplot: columns, and rows must be scalars");
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	84 elseif (any (index < 1) \|\| any (index > rows*columns))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	85 error ("subplot: index value must be greater than 1 and less than rows*columns")
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	86 endif
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	87
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	88 columns = round (columns);
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	89 rows = round (rows);
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	90 index = round (index);
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	91
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	92 if (index > columns*rows)
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	93 error ("subplot: index must be less than columns*rows");
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	94 endif
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	95
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	96 if (columns < 1 \|\| rows < 1 \|\| index < 1)
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	97 error ("subplot: columns,rows,index must be be positive");
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	98 endif
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	99
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	100 units = get (0, "defaultaxesunits");
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	101 unwind_protect
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	102 set (0, "defaultaxesunits", "normalized")
8804 995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	103 pos = subplot_position (rows, columns, index, "position", units);
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	104
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	105 cf = gcf ();
6425 0cc5ca7b1e91 [project @ 2007-03-21 15:57:19 by jwe] jwe parents: 6424 diff changeset	106
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	107 set (cf, "nextplot", "add");
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	108
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	109 found = false;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	110 kids = get (cf, "children");
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	111 for child = reshape (kids, 1, numel (kids))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	112 ## Check whether this child is still valid; this might not be the
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	113 ## case anymore due to the deletion of previous children (due to
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	114 ## "deletefcn" callback or for legends/colorbars that are deleted
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	115 ## with their corresponding axes).
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	116 if (! ishandle (child))
7086 625891845df5 [project @ 2007-10-31 17:11:49 by jwe] jwe parents: 7040 diff changeset	117 continue;
625891845df5 [project @ 2007-10-31 17:11:49 by jwe] jwe parents: 7040 diff changeset	118 endif
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	119 if (strcmp (get (child, "type"), "axes"))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	120 ## Skip legend and colorbar objects.
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	121 if (strcmp (get (child, "tag"), "legend") \|\|
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	122 strcmp (get (child, "tag"), "colorbar"))
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	123 continue;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	124 endif
8804 995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	125 objpos = get (child, "position");
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	126 if (all (objpos == pos))
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	127 ## If the new axes are in exactly the same position as an
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	128 ## existing axes object, use the existing axes.
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	129 found = true;
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	130 tmp = child;
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	131 else
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	132 ## If the new axes overlap an old axes object, delete the old
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	133 ## axes.
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	134 x0 = pos(1);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	135 x1 = x0 + pos(3);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	136 y0 = pos(2);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	137 y1 = y0 + pos(4);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	138 objx0 = objpos(1);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	139 objx1 = objx0 + objpos(3);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	140 objy0 = objpos(2);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	141 objy1 = objy0 + objpos(4);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	142 if (! (x0 >= objx1 \|\| x1 <= objx0 \|\| y0 >= objy1 \|\| y1 <= objy0))
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	143 delete (child);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9211 diff changeset	144 endif
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	145 endif
6178 830235f4984f [project @ 2006-11-17 00:16:57 by jwe] jwe parents: 6163 diff changeset	146 endif
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	147 endfor
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	148
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	149 if (found)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	150 set (cf, "currentaxes", tmp);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	151 else
8804 995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	152 pos = subplot_position (rows, columns, index, "outerposition", units);
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	153 pos2 = subplot_position (rows, columns, index, "position", units);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	154 tmp = axes ("outerposition", pos, "position", pos2);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	155 endif
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	156
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	157 unwind_protect_cleanup
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	158 set (0, "defaultaxesunits", units);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	159 end_unwind_protect
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	160
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6178 diff changeset	161 if (nargout > 0)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: 6178 diff changeset	162 h = tmp;
1540 749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	163 endif
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	164
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe] jwe parents: diff changeset	165 endfunction
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	166
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	167 function pos = subplot_position (rows, columns, index, position_property, units)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	168
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	169 ## For 1 row and 1 column return the usual default.
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	170 if (rows == 1 && columns == 1)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	171 if (strcmpi (position_property, "position"))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	172 pos = get (0, "defaultaxesposition");
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	173 else
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	174 pos = get (0, "defaultaxesouterposition");
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	175 endif
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	176 return
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	177 endif
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	178
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	179 ## This produces compatible behavior for the "position" property.
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	180 margins.left = 0.130;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	181 margins.right = 0.095;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	182 margins.top = 0.075;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	183 margins.bottom = 0.110;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	184 pc = 1 ./ [0.1860, (margins.left + margins.right - 1)];
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	185 margins.column = 1 ./ polyval (pc , columns);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	186 pr = 1 ./ [0.2282, (margins.top + margins.bottom - 1)];
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	187 margins.row = 1 ./ polyval (pr , rows);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	188
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	189 ## Calculate the width/height of the subplot axes.
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	190 width = 1 - margins.left - margins.right - (columns-1)*margins.column;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	191 width = width / columns;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	192 height = 1 - margins.top - margins.bottom - (rows-1)*margins.row;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	193 height = height / rows;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	194
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	195 if (strcmp (position_property, "outerposition") )
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	196 ## Calculate the outerposition/position inset
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	197 if (rows > 1)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	198 inset.top = 8/420;
8804 995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	199 inset.bottom = max (polyval ([0.1382,-0.0026], height), 16/420);
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	200 else
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	201 inset.bottom = margins.bottom;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	202 inset.top = margins.top;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	203 endif
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	204 if (columns > 1)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	205 if (strcmpi (units, "normalized"))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	206 inset.right = max (polyval ([0.1200,-0.0014], width), 5/560);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	207 else
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	208 inset.right = max (polyval ([0.1252,-0.0023], width), 5/560);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	209 endif
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	210 inset.left = 22/560;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	211 else
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	212 inset.left = margins.left;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	213 inset.right = margins.right;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	214 endif
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	215 ## Apply the inset to the geometries for the "position" property.
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	216 margins.column = margins.column - inset.right - inset.left;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	217 margins.row = margins.row - inset.top - inset.bottom;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	218 width = width + inset.right + inset.left;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	219 height = height + inset.top + inset.bottom;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	220 endif
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	221
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	222 yp = fix ((index(:)-1)/columns);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	223 xp = index(:) - yp*columns - 1;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	224 yp = (rows - 1) - yp;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	225
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	226 x0 = xp .* (width + margins.column) + margins.left;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	227 y0 = yp .* (height + margins.row) + margins.bottom;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	228
8804 995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	229 if (strcmp (position_property, "outerposition") )
995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	230 x0 = x0 - inset.left;
995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	231 y0 = y0 - inset.bottom;
995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	232 endif
995f8b064b32 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8744 diff changeset	233
8744 4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	234 if (numel(x0) > 1)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	235 x1 = max (x0) + width;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	236 y1 = max (y0) + height;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	237 x0 = min (x0);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	238 y0 = min (y0);
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	239 pos = [x0, y0, x1-x0, y1-y0];
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	240 else
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	241 pos = [x0, y0, width, height];
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	242 endif
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	243
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	244 endfunction
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	245
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	246 %!demo
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	247 %! clf
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	248 %! r = 3;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	249 %! c = 3;
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	250 %! fmt = {'horizontalalignment', 'center', 'verticalalignment', 'middle'};
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	251 %! for n = 1:(r*c)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	252 %! subplot (r, c, n)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	253 %! xlabel (sprintf ("xlabel #%d", n))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	254 %! ylabel (sprintf ("ylabel #%d", n))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	255 %! title (sprintf ("title #%d", n))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	256 %! text (0.5, 0.5, sprintf('subplot(%d,%d,%d)', r, c, n), fmt{:})
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	257 %! axis ([0 1 0 1])
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	258 %! endfor
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	259 %! subplot (r, c, 1:3)
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	260 %! xlabel (sprintf ("xlabel #%d:%d", 1, 3))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	261 %! ylabel (sprintf ("ylabel #%d:%d", 1, 3))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	262 %! title (sprintf ("title #%d:%d", 1, 3))
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	263 %! text (0.5, 0.5, sprintf('subplot(%d,%d,%d:%d)', r, c, 1, 3), fmt{:})
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	264 %! axis ([0 1 0 1])
4142982c66c6 subplot.m: Compatible placement of subplots. Ben Abbott <bpabbott@mac.com> parents: 8517 diff changeset	265

Mercurial > octave-nkf

annotate scripts/plot/subplot.m @ 10821:693e22af08ae