-
Notifications
You must be signed in to change notification settings - Fork 0
/
jisubplot.m
448 lines (397 loc) · 14.5 KB
/
jisubplot.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
function ret=jisubplot(rows,columns,pane,orientation,gap,varargin)
% JISUBPLOT Set up a figure for multi-pane plotting. Used with NEXTPLOT.
%
% axis=jisubplot(rows,columns,[pane],[orientation],[gap],['param1','value1',...])
%
% OVERVIEW: Enhanced replacement for SUBPLOT
%
% Problem:
% Multi-axis plotting (using SUBPLOT) is great and essential, but has
% shortcomings. The main one is that keeping track of the axis indexes
% can be tedious if you want to do anything more elaborate than plotting
% in row-order. In addition, the size of all axes are the same, and
% spacing is not adjustable.
%
% Solution: JISUBPLOT + NEXTPLOT
% What you might really want is to set up a grid of subplots once and
% then just tell the figure when you want to move to the next plot,
% letting it take care of the details for you.
%
% That's what the pair of functions JISUBPLOT and NEXTPLOT can do.
%
% You can move by row, or by column, or arbitrarily. You can create
% subplots of different sizes. Finally, wouldn't it be nice if
% when you changed a figure's orientation (e.g. orient tall),
% it actually changed shape to reflect that?
%
% Examples:
%
% figure
% jisubplot(4,2,1) % can be used just like SUBPLOT
% plot(X)
% nextplot % advance to next axis
% plot(something_else)
% nextplot
% plot(some_other_thing)
%
% nextplot('newRow') % start a new row of axes
% plot(something_new)
% nextplot('byCol') % move down columns
%
% %% jisubplot / nextplot is especially useful in loops
% figure
% jisubplot(4,4,0)
% for idx = 1:32,
% nextplot
% plot(data(idx,:))
% end
%
% %% a more complete usage: specify orientation, plot spacing and fontsize
% figure
% jisubplot(5,3,0,'tall',[.3 .3],'fontsize',9)
% nextplot
%
% See JISUBPLOTDEMO, NEXTPLOT and CURRENTPLOTIS for more advanced usage.
%
% Description:
%
% Sets up current figure for multi-pane plotting in a rows x columns grid.
% To advance among sub-plots, use NEXTPLOT, or specify a value for pane.
% If pane is unspecified (or=0), doesn't immediately create an axis for
% plotting, but initializes current figure so that a subsequent call to
% NEXTPLOT will create the first axis (pane 1). Note, this will also clear
% the figure. If pane > rows*columns, or NEXTPLOT advances past the current
% figure, will automatically overflow to a new figure with the same properites.
%
% If orientation is specified, the figure will resize to have the correct
% aspect ratio for that type of orientation (e.g. 'tall' or 'landscape').
% The spacing between plots can be specified (gap), as well as param/value
% pairs to pass on to each axis.
%
%
% USAGE:
%
% axis=jisubplot(rows,columns,[pane],[orientation],[gap],['param1','value1',...])
%
% INPUTS
% rows, columns number of axes in horizontal and vertical directions
% pane current sub-plot (if 0 or unspecified, initialze figure)
% pane can be specified in two ways:
% 1) scalar, pick that pane (as in subplot)
% 2) vector, [toprow leftcol width height]
% row,col of upper left and width & height of axis
% orientation 'portrait', 'tall', 'landscape' or '' (default is portrait)
% gap [x y] space between axes as proportion of axis size
% (if unspecified, or [], default to [0.2 0.2].
% Note: as is, this is optimized for a high density of
% plots, without axis labels. Increase the gap to allow
% room for axis labels and titles, etc, use a smaller
% axis font size, or use CURRENTPLOTIS to selectively
% add labels based on axis position on page.)
% prop,value any additional prop/value pairs will be applied to each
% new axis
%
% OUTPUT
% axis handle to current axis (if non-zero value for pane was given)
%
%
% NOTES
%
% if pane is > rows*columns: will automatically overflow to a new figure
% created with the same properties.
%
%
% See also NEXTPLOT, CURRENTPLOTIS, JISUBPLOTDEMO.
%
% John Iversen [email protected]
%
% JRI 4/99 John Iversen, [email protected]
% JRI 4/21/00 added array to store handles to axes. if hold is 'on'
% activate existing axis, if not, delete and create new one
% 12/16/00 allow separate specification of x & y gap
% 10/11/01 Port to NSI
% 12/11/01 More flexible specification of pane
% Figure retains its state in appdata, but is historically compatible with
% older matlab versions lacking appdata (uses userdata in this case).
% Fixed figure objectification
% Free for all uses, but please retain the following:
% Original Author: John Iversen
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%set defaults
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
defaultgap = [.25 .25];
usingdefaultgap = 0;
if nargin == 0
rows=1;
columns=1;
%figure
end
if nargin < 3, pane = 0; end
if nargin < 4 || isempty(orientation)
orientation='portrait';
end
if nargin < 5 || isempty(gap)
gap=defaultgap;
usingdefaultgap=1;
end
if nargin > 5 %optional param/value pairs specified
params = varargin;
else
params = [];
end
if gap==-1
error('use [] for unspecified gap from now on (not -1)')
end
if length(gap)==1
gap = [gap gap];
end
%note, the following refers to system-wide global, G, specific to my personal
% environment. If this global contains fields G.plot.layout.xplotregion,
% G.plot.layout.yplotregion and G.plot.layout.superimpose, will use these values;
% if it's not defined, will set defaults. This can be removed if it conflicts
% with your personal style, or another use of global G
global G
if isempty(G) || ~isfield(G.plot,'layout') %take care of case when global not defined
xplotregion = [.05 .95]; %the region on the page in which subplots will fit
yplotregion = [.05 .95]; % normalized [0,1] units
else %grab vales from global
yplotregion = G.plot.layout.yplotregion;
xplotregion = G.plot.layout.xplotregion;
end
xwidth=xplotregion(2)-xplotregion(1);
ywidth=yplotregion(2)-yplotregion(1);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%get current state, or initialize if it's a new figure
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
currentfig = gcf; %(creates a figure if there is none)
%convert figure object to old-style figure number
if ~isnumeric(currentfig)
currentfig = currentfig.Number;
end
try
UD = getappdata(currentfig,'JRI_jisubplotData');
haveAppdata = 1;
catch
UD = get(currentfig,'userdata');
haveAppdata = 0;
end
if isempty(UD) %no userdata means it's a fresh figure, so initialize it
isVisible = get(currentfig,'visible'); %preserve its (in)visibility
axisHandles=initializeFigure(currentfig, rows, columns, orientation,callername);
set(currentfig,'visible',isVisible)
else %if have userdata, unpack it, check for consistency
axisHandles = UD.axisHandles;
if rows~=UD.rows || columns~=UD.columns %if we've changed the number of panes
axisHandles=zeros(rows,columns); %the old handles aren't useful
end
orientation = UD.orientation;
if nargin>5 %if we've specified extra params, override earlier ones
params=varargin;
else
params = UD.params;
end
if usingdefaultgap %gap wasn't passed in explicitly,
gap=UD.gap; %so use saved value
end
end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%calculate extent of axis, given the pane number
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% pane is 4-element vector specifying row,col of upper left corner
% and width and height in panes
%expand scalar value of pane
pl = length(pane);
switch pl
case 1
if pane ~= 0
col=mod(pane-1,columns)+1;
row=floor((pane-1)/columns)+1;
pane = [row col 1 1];
else
pane = [0 0 1 1];
end
case 4
%do nothing
otherwise
error('Incorrect specification of pane: must be scalar or 4-element')
end
%Calculate axis size
ppp=rows*columns;
xsize=1/columns;
ysize=1/rows;
dx=xsize*gap(1)/2;
dy=ysize*gap(2)/2;
%handle cases where we move to a new figure (if pane moves past current figure)
% for multi-pane axes, this is computed based on upper left pane number
if pane(1) > 0
ulpane = (pane(1)-1) * columns + pane(2);
fig=max(floor((ulpane-1)/ppp),0)+currentfig;
%quick fix for advancing off the page in column mode
if pane(2)>columns && pane(1)==1
fig = currentfig+1;
ulpane=ppp+1;
end
if (fig ~= currentfig) %if we're on a new figure, create and initialize
ulpane=ulpane-(ppp*(fig-currentfig));
pane(1)=mod(ulpane-1,columns)+1;
pane(2)=floor((ulpane-1)/columns)+1;
%grab suptitle & timestampPrefix from previous figure
timestampTag = getappdata(currentfig,'JRI_timestampTag');
axisHandles=initializeFigure(fig,rows,columns,orientation,timestampTag);
%if previous figure was hidden, hide this one, too
set(fig,'visible',get(currentfig,'visible'));
figure(fig)
currentfig = gcf;
try
jisuptitle(G.plot.layout.jisuptitlestr)
catch
end
end
end
%bounds checking
ulrow = pane(1);
ulcol = pane(2);
w = pane(3);
h = pane(4);
if any([w h]>1)
if (w > ( 1 + columns - ulcol)) || ...
(h > (1 + rows - ulrow))
error('width or height exceed available space on figure')
end
end
if (pane(1)>0) %create an axis
currentaxis=axisHandles(pane(1),pane(2));
%for existing axes, use hold state to determine whether to add to axis
% or create a new one
if currentaxis ~= 0
try
superimpose = strcmp(get(currentaxis,'nextplot'),'add') & ...
strcmp(get(get(currentaxis,'parent'),'nextplot'),'add');
catch %current axis is invalid (user may have deleted it), so set to zero
currentaxis = 0;
superimpose = 0;
end
end
if currentaxis==0 || superimpose==0 %no current axis or no superimpose:
%we will make a new axis
if currentaxis ~=0 %we're not suprimposing, so delete old axis
try
delete(currentaxis);
catch
currentaxis = 0;
end
end
%create new axis
row = rows - (pane(1) + (pane(4) - 1));
col = pane(2) - 1;
rect=[(col*xsize+dx)*xwidth+xplotregion(1) ... %x
(row*ysize+dy)*ywidth+yplotregion(1) ... %y
(xsize*pane(3)-dx*2)*xwidth... %width
(ysize*pane(4)-dy*2)*ywidth]; %height
aa=axes('position',rect);
%axis equal
axisHandles(pane(1), pane(2))=aa;
if ~isempty(params)
set(aa,params{:});
end
else %we have a current axis and want to superimpose
set(currentfig,'CurrentAxes',currentaxis);
hold on
aa=currentaxis;
end
else %pane == 0, don't create an axis
aa=[];
end
%save figure userdata
UD.rows = rows;
UD.columns = columns;
UD.pane = pane;
UD.gap = gap;
UD.orientation = orientation;
UD.axisHandles = axisHandles;
UD.params = params;
if haveAppdata
setappdata(currentfig,'JRI_jisubplotData',UD);
else
set(currentfig,'userdata',UD);
end
if nargout
ret=aa;
end
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
function axisHandles=initializeFigure(currentfig, rows, columns,orientation,timestampTag)
%setup new figure's userdata and size
%return matrix of axis handles (initialized to zero)
%optionally initialize text to add to timestamp (only works if have *appdata functions)
axisHandles=zeros(rows,columns);
%set proportions of figure
figure(currentfig); clf reset
try
rmappdata(currentfig,'JRI_jisubplotData');
end
if nargin < 5
timestampTag = '';
try
rmappdata(currentfig,'JRI_timestampTag')
end
end
pos=get(currentfig,'position');
pos(1)=16 + 16; %+ 16*currentfig; % to stagger
%adjust figure size according to screen size, and # screens
saveUnits = get(0,'units');
set(0,'units','pixels');
ss = get(0,'screensize');
% get multiple monitor sizes (updated 3/26/13--different sized monitors)
mp = get(0,'MonitorPositions');
nMonitors = size(mp,1);
if nMonitors > 1
mp(2,2) = mp(1,4)-mp(2,4); %correct y origin of second monitor
figureOrigin = [mp(2,1) + 64 mp(1,4) - 32-80]; %upper left corner of secondary monitor, with room for toolbars
else
figureOrigin = [mp(3)*1/2 mp(4)-32-80];
end
%want tall oriented figure to be 85% of screen height
max_size = mp(1,4) * 0.85;
%on a big screen, it's too big, so cap it.
max_size = min(max_size,820);
%move it up a bit
%pos(2) = pos(2)-ss(4)/3;
switch orientation
case 'portrait'
case 'tall'
pos(3)= max_size * 0.75;
pos(4) = max_size;
case 'landscape'
pos(3) = max_size;
pos(4) = max_size * 0.75;
if numScreens > 1
% pos(1) = max(8,pos(1) - 16); %shift slightly left of tall, but not off screen
end
case ''
orientation='portrait'; %default
otherwise
error('Invalid orientation')
end
%adjust X to be on left screen (assuming main is right screen)
%pos(1) = pos(1) - ss(3)/2 * (numScreens-1);
pos(1) = figureOrigin(1);
pos(2) = figureOrigin(2) - pos(4); %adjust to lower left of figure
%keep figure on screen: Y > 0, Y+height < screen height
figtop = pos(2)+pos(4)+80; %80 is for toolbars
if figtop > ss(4) + 10
pos(2) = 0.95*ss(4) - figtop;
end
if pos(2) < 0
pos(2) = ss(4) * 0.05; %keep bottom slightly above screen bottom
end
set(currentfig,'position',pos)
orient(currentfig, orientation);
set(0,'units',saveUnits)
%set figure background to white
set(currentfig,'color',[1 1 1])
if ~isempty(timestampTag)
setappdata(currentfig,'JRI_timestampTag',timestampTag)
timestamp
end