enderton/Diagnostics/DiagPlotTitles.m

% DiagPlotTitles is called by DiagPlot and cannot be used seperately.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%                              Add titles                                 % 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Optionally put on a subplot title.  The subplot title will always contain
% the field name and it's corresponding units.  Optional subplot title
% information that is defined in DiagPlotParam:
%
%   Option (0/1)        Description
%   -------------------------------------------------------------
%   SubplotExp          Experiment
%   SubplotSlc          SliceType information
%   SubplotAvg          Averaging information
%   SubplotPst          PlotStyle information
%   SubplotMinMax       Minimum and maximum
%   SubplotModelTime    Model time
%
% Note that for certain types of SliceType, the longitude ('i=#'), latitude
% ('j=#'), or height ('k=#') information is included as well.  Little
% strings are built up for each title option (left as '' if option is
% turned off), and at the end concatenated together to make the title
% string.  This should make it easy to reorder things as desired.
if SubplotTitle
    info = page{inrow}{incol};
    
    % Experiment information.
    exptxt = '';
    if SubplotExp
        exptxt = [info{iexp},'; '];
    end
    
    % Field and unit information.
    fldtxt = '';
    if SubplotFld
        if isequal(cmp,'OvF')
            fldtxt = ['Fld = Various [',units,']; '];
        else
            fldtxt = ['Fld = ',fln,' [',units,']; '];
        end
    end
    
    % Model time information.
    timtxt = '';
    if SubplotModelTime
        y1 = num2str(time{inrow}{incol}(1));
        y2 = num2str(time{inrow}{incol}(end));
        timtxt = ['Yrs = [',y1,',',y2,']; '];
    end
    
    % Configuration information.
    contxt = '(';
    if SubplotSlc
        slc = info{islc};
        contxt = [contxt,'Slc = ''',slc,''', '];
        index = str2num(slc(3:end));
        if isequal(slc(1:2),'i=')
            contxt = [contxt,'lon = ',num2str(XL(index)),', '];
        elseif isequal(slc(1:2),'j=')
            contxt = [contxt,'lat = ',num2str(YL(index)),', '];
        elseif isequal(slc(1:2),'k=')
            contxt = [contxt,'pre = ',num2str(ZC(index)),', '];
        end
    end
    if SubplotAvg
        if isequal(cmp,'OvC')
            contxt = [contxt,'Avg = ''Various'', '];
        else
            contxt = [contxt,'Avg = ''',page{inrow}{incol}{iavg},''', '];
        end
    end
    if SubplotPst
        contxt = [contxt,'Pst = ''',pst,''', '];
    end
    if SubplotSlc | SubplotAvg | SubplotPst
        contxt = [contxt(1:end-2),'); '];
    else
        contxt = '';
    end
    
    % Data minimum/maximum information.
    minmaxtxt = '';
    if SubplotMinMax
        clear mn mx;
        if ismember(cmp,{'OvC','OvE','OvF'})
            for inexp = 1:nexp
                mn(inexp) = min(data{inrow}{inexp}(:));
                mx(inexp) = max(data{inrow}{inexp}(:));
            end
            mn = num2str(min(mn(:)));
            mx = num2str(max(mx(:)));
        else
            mn = num2str(min(data{inrow}{incol}(:)));
            mx = num2str(max(data{inrow}{incol}(:)));
        end
        minmaxtxt = ['[Min,Max] = [',mn,',',mx,']; '];
    end

    % Throw on the subplot title.
    titlestr = [exptxt,fldtxt,timtxt,contxt,minmaxtxt];
    titlestr = AddSlashesBeforeUnderscores(titlestr(1:end-2));
    title(titlestr,'fontsize',fs_sptitle);
end

% Optionally put on overall figure title containing user defined figure
% title and date of when the analysis was run (not the when the actual
% experiment was run).  This is added as a text string to the first
% subplot.
if FigureTitle
    if isp == 1
        xi = 0;
        yi = 1+titlefac*(dyt/dy);
        titlestr = [pagename,' (Date = ',date,')'];
        titlestr = AddSlashesBeforeUnderscores(titlestr);
        text(xi,yi,titlestr,'units','normalized','fontsize',fs_title);
    end
end
1	enderton	1.1	% DiagPlotTitles is called by DiagPlot and cannot be used seperately.
2
3
4			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5			% Add titles %
6			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7
8			% Optionally put on a subplot title. The subplot title will always contain
9			% the field name and it's corresponding units. Optional subplot title
10			% information that is defined in DiagPlotParam:
11			%
12			% Option (0/1) Description
13			% -------------------------------------------------------------
14			% SubplotExp Experiment
15			% SubplotSlc SliceType information
16			% SubplotAvg Averaging information
17			% SubplotPst PlotStyle information
18			% SubplotMinMax Minimum and maximum
19			% SubplotModelTime Model time
20			%
21			% Note that for certain types of SliceType, the longitude ('i=#'), latitude
22			% ('j=#'), or height ('k=#') information is included as well. Little
23			% strings are built up for each title option (left as '' if option is
24			% turned off), and at the end concatenated together to make the title
25			% string. This should make it easy to reorder things as desired.
26			if SubplotTitle
27			info = page{inrow}{incol};
28
29			% Experiment information.
30			exptxt = '';
31			if SubplotExp
32			exptxt = [info{iexp},'; '];
33			end
34
35			% Field and unit information.
36			fldtxt = '';
37			if SubplotFld
38			if isequal(cmp,'OvF')
39			fldtxt = ['Fld = Various [',units,']; '];
40			else
41			fldtxt = ['Fld = ',fln,' [',units,']; '];
42			end
43			end
44
45			% Model time information.
46			timtxt = '';
47			if SubplotModelTime
48			y1 = num2str(time{inrow}{incol}(1));
49			y2 = num2str(time{inrow}{incol}(end));
50			timtxt = ['Yrs = [',y1,',',y2,']; '];
51			end
52
53			% Configuration information.
54			contxt = '(';
55			if SubplotSlc
56			slc = info{islc};
57			contxt = [contxt,'Slc = ''',slc,''', '];
58			index = str2num(slc(3:end));
59			if isequal(slc(1:2),'i=')
60			contxt = [contxt,'lon = ',num2str(XL(index)),', '];
61			elseif isequal(slc(1:2),'j=')
62			contxt = [contxt,'lat = ',num2str(YL(index)),', '];
63			elseif isequal(slc(1:2),'k=')
64			contxt = [contxt,'pre = ',num2str(ZC(index)),', '];
65			end
66			end
67			if SubplotAvg
68			if isequal(cmp,'OvC')
69			contxt = [contxt,'Avg = ''Various'', '];
70			else
71			contxt = [contxt,'Avg = ''',page{inrow}{incol}{iavg},''', '];
72			end
73			end
74			if SubplotPst
75			contxt = [contxt,'Pst = ''',pst,''', '];
76			end
77			if SubplotSlc \| SubplotAvg \| SubplotPst
78			contxt = [contxt(1:end-2),'); '];
79			else
80			contxt = '';
81			end
82
83			% Data minimum/maximum information.
84			minmaxtxt = '';
85			if SubplotMinMax
86			clear mn mx;
87			if ismember(cmp,{'OvC','OvE','OvF'})
88			for inexp = 1:nexp
89			mn(inexp) = min(data{inrow}{inexp}(:));
90			mx(inexp) = max(data{inrow}{inexp}(:));
91			end
92			mn = num2str(min(mn(:)));
93			mx = num2str(max(mx(:)));
94			else
95			mn = num2str(min(data{inrow}{incol}(:)));
96			mx = num2str(max(data{inrow}{incol}(:)));
97			end
98			minmaxtxt = ['[Min,Max] = [',mn,',',mx,']; '];
99			end
100
101			% Throw on the subplot title.
102			titlestr = [exptxt,fldtxt,timtxt,contxt,minmaxtxt];
103			titlestr = AddSlashesBeforeUnderscores(titlestr(1:end-2));
104			title(titlestr,'fontsize',fs_sptitle);
105			end
106
107			% Optionally put on overall figure title containing user defined figure
108			% title and date of when the analysis was run (not the when the actual
109			% experiment was run). This is added as a text string to the first
110			% subplot.
111			if FigureTitle
112			if isp == 1
113			xi = 0;
114			yi = 1+titlefac*(dyt/dy);
115			titlestr = [pagename,' (Date = ',date,')'];
116			titlestr = AddSlashesBeforeUnderscores(titlestr);
117			text(xi,yi,titlestr,'units','normalized','fontsize',fs_title);
118			end
119			end