tutorial_global_oce_latlon/diags_matlab/suptitle.m

function hout=suptitle(str)
%SUPTITLE Puts a title above all subplots.
%       SUPTITLE('text') adds text to the top of the figure
%       above all subplots (a "super title"). Use this function
%       after all subplot commands.

% Drea Thomas 6/15/95 drea@mathworks.com
%
% $Header:  $
% $Name:  $

% Warning: If the figure or axis units are non-default, this
% will break.

% Parameters used to position the supertitle.

% Amount of the figure window devoted to subplots
plotregion = .92;

% Y position of title in normalized coordinates
titleypos  = .95;

% Fontsize for supertitle
fs = get(gcf,'defaultaxesfontsize')+4;

% Fudge factor to adjust y spacing between subplots
fudge=1;

haold = gca;
figunits = get(gcf,'units');

% Get the (approximate) difference between full height (plot + title
% + xlabel) and bounding rectangle.

        if (~strcmp(figunits,'pixels')),
                set(gcf,'units','pixels');
                pos = get(gcf,'position');
                set(gcf,'units',figunits);
        else,
                pos = get(gcf,'position');
        end
        ff = (fs-4)*1.27*5/pos(4)*fudge;

        % The 5 here reflects about 3 characters of height below
        % an axis and 2 above. 1.27 is pixels per point.

% Determine the bounding rectange for all the plots

% h = findobj('Type','axes');   

% findobj is a 4.2 thing.. if you don't have 4.2 comment out
% the next line and uncomment the following block.
        
h = findobj(gcf,'Type','axes');  % Change suggested by Stacy J. Hills

% If you don't have 4.2, use this code instead
%ch = get(gcf,'children');
%h=[];
%for i=1:length(ch),
%  if strcmp(get(ch(i),'type'),'axes'),
%    h=[h,ch(i)];
%  end
%end

        
max_y=0;
min_y=1;

oldtitle =0;
for i=1:length(h),
        if (~strcmp(get(h(i),'Tag'),'suptitle')),
                pos=get(h(i),'pos');
                if (pos(2) < min_y), min_y=pos(2)-ff/5*3;end;
                if (pos(4)+pos(2) > max_y), max_y=pos(4)+pos(2)+ff/5*2;end;
        else,
                oldtitle = h(i);
        end
end

if max_y > plotregion,
        scale = (plotregion-min_y)/(max_y-min_y);
        for i=1:length(h),
                pos = get(h(i),'position');
                pos(2) = (pos(2)-min_y)*scale+min_y;
                pos(4) = pos(4)*scale-(1-scale)*ff/5*3;
                set(h(i),'position',pos);
        end
end

np = get(gcf,'nextplot');
set(gcf,'nextplot','add');
if (oldtitle),
        delete(oldtitle);
end
ha=axes('pos',[0 1 1 1],'visible','off','Tag','suptitle');
ht=text(.5,titleypos-1,str);set(ht,'horizontalalignment','center','fontsize',fs);
set(gcf,'nextplot',np);
axes(haold);
if nargout,
        hout=ht;
end


1	function hout=suptitle(str)
2	%SUPTITLE Puts a title above all subplots.
3	% SUPTITLE('text') adds text to the top of the figure
4	% above all subplots (a "super title"). Use this function
5	% after all subplot commands.
6
7	% Drea Thomas 6/15/95 drea@mathworks.com
8	%
9	% $Header: $
10	% $Name: $
11
12	% Warning: If the figure or axis units are non-default, this
13	% will break.
14
15	% Parameters used to position the supertitle.
16
17	% Amount of the figure window devoted to subplots
18	plotregion = .92;
19
20	% Y position of title in normalized coordinates
21	titleypos = .95;
22
23	% Fontsize for supertitle
24	fs = get(gcf,'defaultaxesfontsize')+4;
25
26	% Fudge factor to adjust y spacing between subplots
27	fudge=1;
28
29	haold = gca;
30	figunits = get(gcf,'units');
31
32	% Get the (approximate) difference between full height (plot + title
33	% + xlabel) and bounding rectangle.
34
35	if (~strcmp(figunits,'pixels')),
36	set(gcf,'units','pixels');
37	pos = get(gcf,'position');
38	set(gcf,'units',figunits);
39	else,
40	pos = get(gcf,'position');
41	end
42	ff = (fs-4)1.275/pos(4)*fudge;
43
44	% The 5 here reflects about 3 characters of height below
45	% an axis and 2 above. 1.27 is pixels per point.
46
47	% Determine the bounding rectange for all the plots
48
49	% h = findobj('Type','axes');
50
51	% findobj is a 4.2 thing.. if you don't have 4.2 comment out
52	% the next line and uncomment the following block.
53
54	h = findobj(gcf,'Type','axes'); % Change suggested by Stacy J. Hills
55
56	% If you don't have 4.2, use this code instead
57	%ch = get(gcf,'children');
58	%h=[];
59	%for i=1:length(ch),
60	% if strcmp(get(ch(i),'type'),'axes'),
61	% h=[h,ch(i)];
62	% end
63	%end
64
65
66
67
68	max_y=0;
69	min_y=1;
70
71	oldtitle =0;
72	for i=1:length(h),
73	if (~strcmp(get(h(i),'Tag'),'suptitle')),
74	pos=get(h(i),'pos');
75	if (pos(2) < min_y), min_y=pos(2)-ff/5*3;end;
76	if (pos(4)+pos(2) > max_y), max_y=pos(4)+pos(2)+ff/5*2;end;
77	else,
78	oldtitle = h(i);
79	end
80	end
81
82	if max_y > plotregion,
83	scale = (plotregion-min_y)/(max_y-min_y);
84	for i=1:length(h),
85	pos = get(h(i),'position');
86	pos(2) = (pos(2)-min_y)*scale+min_y;
87	pos(4) = pos(4)scale-(1-scale)ff/5*3;
88	set(h(i),'position',pos);
89	end
90	end
91
92	np = get(gcf,'nextplot');
93	set(gcf,'nextplot','add');
94	if (oldtitle),
95	delete(oldtitle);
96	end
97	ha=axes('pos',[0 1 1 1],'visible','off','Tag','suptitle');
98	ht=text(.5,titleypos-1,str);set(ht,'horizontalalignment','center','fontsize',fs);
99	set(gcf,'nextplot',np);
100	axes(haold);
101	if nargout,
102	hout=ht;
103	end
104
105
106