source: trunk/src/plot_field.m @ 1116

Last change on this file since 1116 was 1107, checked in by g7moreau, 3 years ago

Update Copyright to 2022

File size: 62.3 KB
Line 
1%'plot_field': plot any field with the structure defined in the uvmat package
2%------------------------------------------------------------------------
3%
4%  This function is used by uvmat to plot fields. It automatically chooses the representation
5% appropriate to the input field structure:
6%     2D vector fields are represented by arrows, 2D scalar fields by grey scale images or contour plots, 1D fields are represented by usual plot with (abscissa, ordinate).
7%  The input field structure is first tested by check_field_structure.m,
8%  then split into blocks of related variables  by find_field_cells.m.
9%  The dimensionality of each block is obtained  by this function
10%  considering the presence of variables with the attribute .Role='coord_x'
11%  and/or coord_y and/or coord_z (case of unstructured coordinates), or
12%  dimension variables (case of matrices).
13%
14% function [PlotType,PlotParamOut,haxes]= plot_field(Data,haxes,PlotParam,PosColorbar)
15%
16% OUPUT:
17% PlotType: type of plot: 'text','line'(curve plot),'plane':2D view,'volume', or errormsg
18% PlotParamOut: structure, representing the updated  plotting parameters, in case of automatic scaling
19% haxes: handle of the plotting axis, when a new figure is created.
20%
21%INPUT
22%    Data:   structure describing the field to plot
23%         (optional) .ListGlobalAttribute: cell listing the names of the global attributes
24%                    .Att_1,Att_2... : values of the global attributes
25%         (requested)  .ListVarName: list of variable names to select (cell array of  char strings {'VarName1', 'VarName2',...} )
26%         (requested)  .VarDimName: list of dimension names for each element of .ListVarName (cell array of string cells)
27%                      .VarAttribute: cell of attributes for each element of .ListVarName (cell array of structures of the form VarAtt.key=value)
28%         (requested) .Var1, .Var2....: variables (Matlab arrays) with names listed in .ListVarName
29
30%            Variable attribute .Role :
31%    The only variable attribute used for plotting purpose is .Role which can take
32%    the values
33%       Role = 'scalar':  (default) represents a scalar field
34%            = 'coord_x', 'coord_y',  'coord_z': represents a separate set of
35%                        unstructured coordinate x, y  or z
36%            = 'vector': represents a vector field whose number of components
37%                is given by the last dimension (called 'nb_dim')
38%            = 'vector_x', 'vector_y', 'vector_z'  :represents the x, y or z  component of a vector 
39%            = 'warnflag' : provides a warning flag about the quality of data in a 'Field', default=0, no warning
40%            = 'errorflag': provides an error flag marking false data,
41%                   default=0, no error. Different non zero values can represent different criteria of elimination.
42%
43%   haxes: handle of the plotting axes to update with the new plot. If this input is absent or not a valid axes handle, a new figure is created.
44%
45%   PlotParam: structure containing the parameters for plotting, as read on the uvmat or view_field GUI (by function 'read_GUI.m').
46%      Contains three substructures:
47%     .Axes: coordinate parameters:
48%           .CheckFixLimits:=0 (default) adjust axes limit to the X,Y data, =1: preserves the previous axes limits
49%     .Axes.CheckFixAspectRatio: =0 (default):automatic adjustment of the graph, keep 1 to 1 aspect ratio for x and y scales.
50%     .Axes.AspectRatio: imposed aspect ratio y/x of axis unit plots
51%            --scalars--
52%    .Scalar.MaxA: upper bound (saturation color) for the scalar representation, max(field) by default
53%    .Scalar.MinA: lower bound (saturation) for the scalar representation, min(field) by default
54%    .Scalar.CheckFixScal: =0 (default) lower and upper bounds of the scalar representation set to the min and max of the field
55%               =1 lower and upper bound imposed by .AMax and .MinA
56%    .Scalar.CheckBW= 1: black and white representation imposed, =0 color imposed (color scale or rgb),
57%                   =[]: automatic (B/W for integer positive scalars, color  else)
58%    .Scalar.CheckContours= 1: represent scalars by contour plots (Matlab function 'contour'); =0 by default
59%    .IncrA : contour interval
60%            -- vectors--
61%    .Vectors.VecScale: scale for the vector representation
62%    .Vectors.CheckFixVec: =0 (default) automatic length for vector representation, =1: length set by .VecScale
63%    .Vectors.CheckHideFalse= 0 (default) false vectors represented in magenta, =1: false vectors not represented;
64%    .Vectors.CheckHideWarning= 0 (default) vectors marked by warnflag~=0 marked in black, 1: no warning representation;
65%    .Vectors.CheckDecimate4 = 0 (default) all vectors reprtesented, =1: half of  the vectors represented along each coordinate
66%         -- vector color--
67%    .Vectors.ColorCode= 'black','white': imposed color  (default ='blue')
68%                        'rgb', : three colors red, blue, green depending
69%                        on thresholds .colcode1 and .colcode2 on the input  scalar value (C)
70%                        'brg': like rgb but reversed color order (blue, green, red)
71%                        '64 colors': continuous color from blue to red (multijet)
72%    .Vectors.colcode1 : first threshold for rgb, first value for'continuous'
73%    .Vectors.colcode2 : second threshold for rgb, last value (saturation) for 'continuous'
74%    .Vectors.CheckFixedCbounds;  =0 (default): the bounds on C representation are min and max, =1: they are fixed by .Minc and .MaxC
75%    .Vectors.MinC = imposed minimum of the scalar field used for vector color;
76%    .Vectors.MaxC = imposed maximum of the scalar field used for vector color;
77%
78% PosColorbar: % if absent, no action on colorbar
79%              % if empty, suppress any existing colorbar
80%              % if not empty, display a colorbar for B&W images at position PosColorbar
81%                expressed in figure relative unit (ex [0.821 0.471 0.019 0.445])
82
83%=======================================================================
84% Copyright 2008-2022, LEGI UMR 5519 / CNRS UGA G-INP, Grenoble, France
85%   http://www.legi.grenoble-inp.fr
86%   Joel.Sommeria - Joel.Sommeria (A) legi.cnrs.fr
87%
88%     This file is part of the toolbox UVMAT.
89%
90%     UVMAT is free software; you can redistribute it and/or modify
91%     it under the terms of the GNU General Public License as published
92%     by the Free Software Foundation; either version 2 of the license,
93%     or (at your option) any later version.
94%
95%     UVMAT is distributed in the hope that it will be useful,
96%     but WITHOUT ANY WARRANTY; without even the implied warranty of
97%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
98%     GNU General Public License (see LICENSE.txt) for more details.
99%=======================================================================
100
101function [PlotType,PlotParamOut,haxes]= plot_field(Data,haxes,PlotParam)
102
103%% default input and output
104if ~exist('PlotParam','var'),PlotParam=[];end
105PlotType='text'; %default
106if ~isfield(PlotParam,'Axes')
107    PlotParam.Axes=[];
108    if isfield(Data,'CoordUnit')
109        PlotParam.Axes.CheckFixAspectRatio=1;
110        PlotParam.Axes.AspectRatio=1; %set axes equal by default if CoordUnit is defined
111    end
112end
113PlotParamOut=PlotParam;%default
114
115%% check input structure
116[CellInfo,NbDimArray,errormsg]=find_field_cells(Data);
117if ~isempty(errormsg)
118    msgbox_uvmat('ERROR',['input of plot_field/find_field_cells: ' errormsg]);
119    return
120end
121index_0D=find(NbDimArray==0);
122index_1D=find(NbDimArray==1);
123index_2D=find(NbDimArray==2);%find 2D fields
124index_3D=find(NbDimArray>2,1);
125if ~isempty(index_3D)
126    msgbox_uvmat('ERROR','volume plot not implemented yet');
127    return
128end
129
130%% test axes and figure
131testnewfig=1;%test to create a new figure (default)
132testzoomaxes=0;%test for the existence of a zoom secondary figure attached to the plotting axes
133if exist('haxes','var')
134    if ishandle(haxes)
135        if isequal(get(haxes,'Type'),'axes')
136            testnewfig=0;
137            AxeData=get(haxes,'UserData');
138            if isfield(AxeData,'ZoomAxes')&& ishandle(AxeData.ZoomAxes)
139                if isequal(get(AxeData.ZoomAxes,'Type'),'axes')
140                    testzoomaxes=1;
141                    zoomaxes=AxeData.ZoomAxes;
142                end
143            end
144        end
145    end
146end
147
148%% create a new figure and axes if the plotting axes does not exist
149if testnewfig
150    hfig=figure;
151    set(hfig,'Units','normalized')
152    haxes=axes;
153    set(haxes,'position',[0.13,0.2,0.775,0.73])
154    PlotParamOut.NextPlot='add'; %parameter for plot_profile
155else
156    hfig=get(haxes,'parent');
157    set(0,'CurrentFigure',hfig)% the parent of haxes becomes the current figure
158    set(hfig,'CurrentAxes',haxes)%  haxes becomes the current axes of the parent figure
159end
160
161%% set axes properties
162if isfield(PlotParamOut.Axes,'CheckFixLimits') && isequal(PlotParamOut.Axes.CheckFixLimits,1)  %adjust the graph limits
163    set(haxes,'XLimMode', 'manual')
164    set(haxes,'YLimMode', 'manual')
165else
166    set(haxes,'XLimMode', 'auto')
167    set(haxes,'YLimMode', 'auto')
168end
169
170if isfield(PlotParamOut.Axes,'CheckFixAspectRatio') && isequal(PlotParamOut.Axes.CheckFixAspectRatio,1)&&isfield(PlotParamOut.Axes,'AspectRatio')
171    set(haxes,'DataAspectRatioMode','manual')
172    set(haxes,'DataAspectRatio',[PlotParamOut.Axes.AspectRatio 1 1])
173else
174    set(haxes,'DataAspectRatioMode','auto')%automatic aspect ratio
175end
176
177errormsg='';
178AxeData=get(haxes,'UserData');
179
180%% 2D plots
181if isempty(index_2D)
182    plot_plane([],[],haxes,[]);%removes images or vector plots in the absence of 2D field plot
183else  %plot 2D field
184%     if ~exist('PosColorbar','var'),PosColorbar=[];end;
185    [tild,PlotParamOut,PlotType,errormsg]=plot_plane(Data,CellInfo(index_2D),haxes,PlotParamOut);
186    AxeData.NbDim=2;
187    if testzoomaxes && isempty(errormsg)
188        [zoomaxes,PlotParamOut,tild,errormsg]=plot_plane(Data,CellInfo(index_2D),zoomaxes,PlotParamOut);
189        AxeData.ZoomAxes=zoomaxes;
190    end
191end
192
193%% 1D plot (usual graph y vs x)
194if isempty(index_1D)|| ~isempty(index_2D)
195    if ~isempty(haxes)
196        plot_profile([],[],haxes);%removes usual praphs y vs x in the absence of 1D field plot
197    end
198else %plot 1D field (usual graph y vs x)
199    CheckHold=0;
200    if isfield(PlotParam,'CheckHold')
201        CheckHold= PlotParam.CheckHold;
202    end       
203    PlotParamOut=plot_profile(Data,CellInfo(index_1D),haxes,PlotParamOut,CheckHold);%
204    if isempty(index_2D)
205        if isfield(PlotParamOut,'Vectors')
206            PlotParamOut=rmfield(PlotParamOut,'Vectors');
207        end
208        if isfield(PlotParamOut,'Scalar')
209            PlotParamOut=rmfield(PlotParamOut,'Scalar');
210        end
211    end
212    if testzoomaxes
213        [zoomaxes,PlotParamOut.Axes]=plot_profile(Data,CellInfo(index_1D),zoomaxes,PlotParamOut.Axes,CheckHold);
214        AxeData.ZoomAxes=zoomaxes;
215    end
216    PlotType='line';
217end
218
219%% aspect ratio
220AspectRatio=get(haxes,'DataAspectRatio');
221PlotParamOut.Axes.AspectRatio=AspectRatio(1)/AspectRatio(2);
222
223%% text display
224if ~(isfield(PlotParamOut,'Axes')&&isfield(PlotParamOut.Axes,'TextDisplay')&&(PlotParamOut.Axes.TextDisplay)) % if text is not already given as statistics
225    htext=findobj(hfig,'Tag','TableDisplay');
226    if ~isempty(htext)%&&~isempty(hchecktable)
227        if isempty(index_0D)
228        else
229            errormsg=plot_text(Data,CellInfo(index_0D),htext);
230            set(htext,'visible','on')
231        end
232        set(hfig,'Unit','pixels');
233        set(htext,'Unit','pixels')
234        PosFig=get(hfig,'Position');
235        % case of no plot with view_field: only text display
236        if strcmp(get(hfig,'Tag'),'view_field')
237            if isempty(index_1D) && isempty(index_2D)% case of no plot: only text display
238                set(haxes,'Visible','off')
239                PosTable=get(htext,'Position');
240                set(hfig,'Position',[PosFig(1) PosFig(2)  PosTable(3) PosTable(4)])
241            else
242                set(haxes,'Visible','on')
243                set(hfig,'Position',[PosFig(1) PosFig(2)  877 677])%default size for view_field
244            end
245        end
246    end
247end
248%% display error message
249if ~isempty(errormsg)
250    PlotType=errormsg;
251    msgbox_uvmat('ERROR', errormsg)
252end
253
254%% update the parameters stored in AxeData
255if ishandle(haxes)&&( ~isempty(index_2D)|| ~isempty(index_1D))
256    if isfield(PlotParamOut,'MinX')
257        AxeData.RangeX=[PlotParamOut.MinX PlotParamOut.MaxX];
258        AxeData.RangeY=[PlotParamOut.MinY PlotParamOut.MaxY];
259    end
260    set(haxes,'UserData',AxeData)
261end
262
263%% update the plotted field stored in parent figure
264if ~isempty(index_2D)|| ~isempty(index_1D)
265    FigData=get(hfig,'UserData');
266    if strcmp(get(hfig,'tag'),'view_field')||strcmp(get(hfig,'tag'),'uvmat')
267        if ~isempty(get(haxes,'tag'))
268        FigData.(get(haxes,'tag'))=Data;
269        end
270        set(hfig,'UserData',FigData)
271    end
272end
273
274%-------------------------------------------------------------------
275% --- plot 0D fields: display data values without plot
276%------------------------------------------------------------------
277function errormsg=plot_text(FieldData,CellInfo,htext)
278
279errormsg='';
280txt_cell={};
281Data={};
282VarIndex=[];
283for icell=1:length(CellInfo)
284   
285    % select types of  variables to be projected
286    ListProj={'VarIndex_scalar','VarIndex_image','VarIndex_color','VarIndex_vector_x','VarIndex_vector_y'};
287    check_proj=false(size(FieldData.ListVarName));
288    for ilist=1:numel(ListProj)
289        if isfield(CellInfo{icell},ListProj{ilist})
290            check_proj(CellInfo{icell}.(ListProj{ilist}))=1;
291        end
292    end
293    VarIndex=[VarIndex find(check_proj)];
294end
295
296% data need to be displayed in a table
297% if strcmp(get(htext,'Type'),'uitable')% display data in a table
298%     VarNameCell=cell(1,numel(VarIndex));% prepare list of variable names to display (titles of columns)
299%     VarLength=zeros(1,numel(VarIndex));  % default number of values for each variable
300%     for ivar=1:numel(VarIndex)
301%         VarNameCell{ivar}=FieldData.ListVarName{VarIndex(ivar)};
302%         VarLength(ivar)=numel(FieldData.(VarNameCell{ivar}));
303%     end
304%     set(htext,'ColumnName',VarNameCell)
305%     Data=cell(max(VarLength),numel(VarIndex));% prepare the table of data display
306%     
307%     for ivar=1:numel(VarIndex)
308%         VarValue=FieldData.(VarNameCell{ivar});
309%         VarValue=reshape(VarValue,[],1);% reshape values array in a column
310%         Data(1:numel(VarValue),ivar)=num2cell(VarValue);
311%     end
312%     set(htext,'Data',Data)
313% end
314%         if numel(VarValue)>1 && numel(VarValue)<10 % case of a variable with several values
315%             for ind=1:numel(VarValue)
316%                 VarNameCell{1,ind}=[VarName '_' num2str(ind)];% indicate each value by an index
317%             end
318%         else
319%             VarNameCell={VarName};
320%         end
321%         if numel(VarValue)<10
322%             if isempty(VarValue)
323%                 VarValueCell={'[]'};
324%             else
325%                 VarValueCell=num2cell(VarValue);
326%             end
327%             if isempty(Data)
328%                 Data =[VarNameCell VarValueCell];
329%             else
330%                 Data =[Data [VarNameCell VarValueCell]];
331%             end
332%         else
333%             if isempty(Data)
334%                 Data =[VarNameCell; num2cell(VarValue)];
335%             else
336%                 Data =[Data [VarNameCell; {['size ' num2str(size(VarValue))]}]];
337%             end
338%         end
339%         if size(VarValue,1)==1
340%             txt=[VarName '=' num2str(VarValue)];
341%             txt_cell=[txt_cell;{txt}];
342%         end
343%     end
344% end
345% if strcmp(get(htext,'Type'),'uitable')% display data in a table
346%
347
348%     set(htext,'Data',Data(2:end,:))
349% else  % display in a text edit box
350%     set(htext,'String',txt_cell)
351%     set(htext,'UserData',txt_cell)% for temporary storage when the edit box is used for mouse display
352% end
353
354
355%-------------------------------------------------------------------
356% --- plot 1D fields (usual x,y plots)
357%-------------------------------------------------------------------
358%INPUT
359%    Data:   structure describing the field to plot
360%         (optional) .ListGlobalAttribute: cell listing the names of the global attributes
361%                    .Att_1,Att_2... : values of the global attributes
362%         (requested)  .ListVarName: list of variable names to select (cell array of  char strings {'VarName1', 'VarName2',...} )
363%         (requested)  .VarDimName: list of dimension names for each element of .ListVarName (cell array of string cells)
364%                      .VarAttribute: cell of attributes for each element of .ListVarName (cell array of structures of the form VarAtt.key=value)
365%         (requested) .Var1, .Var2....: variables (Matlab arrays) with names listed in .ListVarName
366
367%            Variable attribute .Role :
368%    The only variable attribute used for plotting purpose is .Role which can take
369%    the values:
370%       Role = 'coord_x' or 'histo' to label the x coordinate
371%            ='coord_y' or 'discrete' to label the y coordinate, variables labelled as 'discrete'
372%           will be plotted as isolated points while variables labelled as 'coord_y' will be plotted as continuous lines
373%    other variables will not be taken into account for plot_profile
374
375function PlotParamOut=plot_profile(Data,CellInfo,haxes,PlotParam,CheckHold)
376
377%% initialization
378if ~(exist('PlotParam','var')&&~isempty(PlotParam.Axes))
379    Coordinates=[];
380    PlotParamOut.Axes=Coordinates;
381else
382    Coordinates=PlotParam.Axes;
383    PlotParamOut=PlotParam;
384end
385hfig=get(haxes,'parent');
386legend_str={};
387
388%% suppress existing plot if empty Data
389if isempty(Data)
390    hplot=findobj(haxes,'tag','plot_line');
391    if ~isempty(hplot)
392        delete(hplot)
393    end
394    hlegend=findobj(hfig,'tag','legend');
395    if ~isempty(hlegend)
396        delete(hlegend)
397    end
398    return
399end
400
401%% set the colors of the successive plots (designed to produce rgb for the three components of color images)
402ColorOrder=[1 0 0;0 1 0;0 0 1;0 0.75 0.75;0.75 0 0.75;0.75 0.75 0;0.25 0.25 0.25];
403set(hfig,'DefaultAxesColorOrder',ColorOrder)
404if CheckHold
405    set(haxes,'NextPlot','add')
406else
407    set(haxes,'NextPlot','replace')
408end
409
410%% prepare the string for plot command
411plotstr='hhh=plot(';
412xtitle='';
413ytitle='';
414test_newplot=~CheckHold;
415MinX=[];
416MaxX=[];
417MinY_cell=[];
418MaxY_cell=[];
419testplot=ones(size(Data.ListVarName));%default test for plotted variables
420%loop on input  fields
421for icell=1:numel(CellInfo)
422    VarIndex=[CellInfo{icell}.YIndex CellInfo{icell}.YIndex_discrete];%  indices of the selected variables in the list Data.ListVarName
423    coord_x_index=CellInfo{icell}.XIndex;
424    coord_x_name{icell}=Data.ListVarName{coord_x_index};
425    coord_x{icell}=Data.(Data.ListVarName{coord_x_index});%coordinate variable set as coord_x
426    if isempty(find(strcmp(coord_x_name{icell},coord_x_name(1:end-1)), 1)) %xtitle not already selected
427        xtitle=[xtitle coord_x_name{icell}];
428        if isfield(Data,'VarAttribute')&& numel(Data.VarAttribute)>=coord_x_index && isfield(Data.VarAttribute{coord_x_index},'units')
429            xtitle=[xtitle '(' Data.VarAttribute{coord_x_index}.units '), '];
430        else
431            xtitle=[xtitle ', '];
432        end
433    end
434    if ~isempty(coord_x{icell})
435        MinX(icell)=min(coord_x{icell});
436        MaxX(icell)=max(coord_x{icell});
437        testplot(coord_x_index)=0;
438        if isfield(CellInfo{icell},'VarIndex_ancillary')
439            testplot(CellInfo{icell}.VarIndex_ancillary)=0;
440        end
441        if isfield(CellInfo{icell},'VarIndex_warnflag')
442            testplot(CellInfo{icell}.VarIndex_warnflag)=0;
443        end
444        if isfield(Data,'VarAttribute')
445            VarAttribute=Data.VarAttribute;
446            for ivar=1:length(VarIndex)
447                if length(VarAttribute)>=VarIndex(ivar) && isfield(VarAttribute{VarIndex(ivar)},'long_name')
448                    plotname{VarIndex(ivar)}=VarAttribute{VarIndex(ivar)}.long_name;
449                else
450                    plotname{VarIndex(ivar)}=Data.ListVarName{VarIndex(ivar)};%name for display in plot A METTRE
451                end
452            end
453        end
454        if isfield(CellInfo{icell},'YIndex_discrete')&& ~isempty(CellInfo{icell}.YIndex_discrete)
455            charplot_0='''+''';
456        else
457            charplot_0='''-''';
458        end
459        MinY=[];
460        MaxY=[];%default
461       
462        nbplot=0;
463        for ivar=1:length(VarIndex)
464            if testplot(VarIndex(ivar))
465                VarName=Data.ListVarName{VarIndex(ivar)};
466                nbplot=nbplot+1;
467                ytitle=[ytitle VarName];
468                if isfield(Data,'VarAttribute')&& numel(Data.VarAttribute)>=VarIndex(ivar) && isfield(Data.VarAttribute{VarIndex(ivar)},'units')
469                    ytitle=[ytitle '(' Data.VarAttribute{VarIndex(ivar)}.units '), '];
470                else
471                    ytitle=[ytitle ', '];
472                end
473                eval(['Data.' VarName '=squeeze(Data.' VarName ');'])
474                MinY(ivar)=min(min(Data.(VarName)));
475                MaxY(ivar)=max(max(Data.(VarName)));
476                plotstr=[plotstr 'coord_x{' num2str(icell) '},Data.' VarName ',' charplot_0 ','];
477                eval(['nbcomponent2=size(Data.' VarName ',2);']);
478                eval(['nbcomponent1=size(Data.' VarName ',1);']);
479                if numel(coord_x{icell})==2
480                    coord_x{icell}=linspace(coord_x{icell}(1),coord_x{icell}(2),nbcomponent1);
481                end
482                if nbcomponent1==1|| nbcomponent2==1
483                    legend_str=[legend_str {VarName}]; %variable with one component
484                else  %variable with severals  components
485                    for ic=1:min(nbcomponent1,nbcomponent2)
486                        legend_str=[legend_str [VarName '_' num2str(ic)]]; %variable with severals  components
487                    end                                                   % labeled by their index (e.g. color component)
488                end
489            end
490        end
491        if ~isempty(MinY)
492            MinY_cell(icell)=min(MinY);
493            MaxY_cell(icell)=max(MaxY);
494        end
495    end
496end
497
498%% activate the plot
499if  ~isequal(plotstr,'hhh=plot(') 
500    set(hfig,'CurrentAxes',haxes)
501    tag=get(haxes,'tag');   
502    %%%
503    plotstr=[plotstr '''tag'',''plot_line'');'];   
504    eval(plotstr)                  %execute plot (instruction  plotstr)
505    %%%
506    set(haxes,'tag',tag)% restitute the axes tag (removed by the command plot)
507    set(haxes,'ColorOrder',ColorOrder)% restitute the plot color order (to get red green blue for histograms or cuts of color images)
508    grid(haxes, 'on')
509    hxlabel=xlabel(xtitle(1:end-2));% xlabel (removes ', ' at the end)
510    set(hxlabel,'Interpreter','none')% desable tex interpreter
511    if length(legend_str)>=1
512        hylabel=ylabel(ytitle(1:end-2));% ylabel (removes ', ' at the end)
513        set(hylabel,'Interpreter','none')% desable tex interpreter
514    end
515    if ~isempty(legend_str)
516        hlegend=findobj(hfig,'Tag','legend');
517        if isempty(hlegend)
518            hlegend=legend(legend_str);
519            txt=ver('MATLAB');
520            Release=txt.Release;
521            relnumb=str2double(Release(3:4));% should be changed to Version for better compatibility
522            if relnumb >= 14
523                set(hlegend,'Interpreter','none')% desable tex interpreter
524            end
525        else
526            legend_old=get(hlegend,'String');
527            if isequal(size(legend_old,1),size(legend_str,1))&&~isequal(legend_old,legend_str)
528                set(hlegend,'String',[legend_old legend_str]);
529            end
530        end
531    end
532    title_str='';
533    if isfield(Data,'filename')
534       [Path, title_str, ext]=fileparts(Data.filename);
535       title_str=[title_str ext];
536    end
537    if isfield(Data,'Action')&&isfield(Data.Action,'ActionName')
538        if ~isequal(title_str,'')
539            title_str=[title_str ', '];
540        end
541        title_str=[title_str Data.Action.ActionName];
542    end
543    htitle=title(title_str);
544    set(htitle,'Interpreter','none')% desable tex interpreter
545end
546
547%% determine axes bounds
548fix_lim=isfield(Coordinates,'CheckFixLimits') && Coordinates.CheckFixLimits;
549check_lim=isfield(Coordinates,'MinX')&&isfield(Coordinates,'MaxX')&&isfield(Coordinates,'MinY')&&isfield(Coordinates,'MaxY');
550if fix_lim
551    if ~check_lim
552        fix_lim=0; %free limits if limits are not set,
553    end
554end
555if fix_lim
556    set(haxes,'XLim',[Coordinates.MinX Coordinates.MaxX])
557    set(haxes,'YLim',[Coordinates.MinY Coordinates.MaxY])
558else
559    if ~isempty(MinX)
560        if check_lim
561            Coordinates.MinX=min(min(MinX),Coordinates.MinX);
562            Coordinates.MaxX=max(max(MaxX),Coordinates.MaxX);
563        else
564            Coordinates.MinX=min(MinX);
565            Coordinates.MaxX=max(MaxX);
566        end
567    end
568    if ~isempty(MinY_cell)
569        if check_lim
570            Coordinates.MinY=min(min(MinY_cell),Coordinates.MinY);
571            Coordinates.MaxY=max(max(MaxY_cell),Coordinates.MaxY);
572        else
573            Coordinates.MinY=min(MinY_cell);
574            Coordinates.MaxY=max(MaxY_cell);
575        end
576    end
577end
578
579%% determine plot aspect ratio
580if isfield(Coordinates,'CheckFixAspectRatio') && isequal(Coordinates.CheckFixAspectRatio,1)&&isfield(Coordinates,'AspectRatio')
581    set(haxes,'DataAspectRatioMode','manual')
582    set(haxes,'DataAspectRatio',[Coordinates.AspectRatio 1 1])
583else
584    set(haxes,'DataAspectRatioMode','auto')%automatic aspect ratio
585    AspectRatio=get(haxes,'DataAspectRatio');
586    Coordinates.AspectRatio=AspectRatio(1)/AspectRatio(2);
587end
588PlotParamOut.Axes= Coordinates;
589
590%% give statistics for pdf
591%ind_var=find(testplot);
592TableData={'Variable';'SampleNbr';'bin size';'Mean';'RMS';'Skewness';'Kurtosis';...
593    'Min';'FirstCentile';'FirstDecile';'Median';'LastDecile';'LastCentile';'Max'};
594
595TextDisplay=0;
596for icell=1:numel(CellInfo)
597    if isfield(CellInfo{icell},'VarIndex_histo')% case of histogram plot
598        TextDisplay=1;
599        VarName=Data.ListVarName{CellInfo{icell}.CoordIndex};
600        pdf_val=Data.(Data.ListVarName{CellInfo{icell}.VarIndex_histo});
601        x=coord_x{icell};
602        if isrow(x)
603            x=x';
604        end
605        if ~isequal(size(x,1),size(pdf_val,1))
606            pdf_val=pdf_val';
607        end
608        Val=pdf2stat(x,pdf_val);
609        Column=mat2cell(Val,ones(13,1),ones(1,size(Val,2)));
610        if size(Val,2)==1%single component
611            TitleBar={VarName};
612        else
613            TitleBar=cell(1,size(Val,2));
614            for icomp=1:size(Val,2)
615                TitleBar{icomp}=[VarName '_' num2str(icomp)];
616            end
617        end
618        Column=[TitleBar;Column];
619        TableData=[TableData Column];
620    end
621end
622if TextDisplay
623    disp(TableData);
624    PlotParamOut.TableDisplay=TableData;
625else
626    if isfield(PlotParamOut,'TableDisplay')
627        PlotParamOut=rmfield(PlotParamOut,'TableDisplay');
628    end
629end
630   
631%-------------------------------------------------------------------
632function [haxes,PlotParamOut,PlotType,errormsg]=plot_plane(Data,CellInfo,haxes,PlotParam)
633%-------------------------------------------------------------------
634PlotType='plane';
635grid(haxes, 'off')% remove grid (possibly remaining from other graphs)
636
637%default plotting parameters
638if ~isfield(PlotParam,'Scalar')
639    PlotParam.Scalar=[];
640end
641if ~isfield(PlotParam,'Vectors')
642    PlotParam.Vectors=[];
643end
644PlotParamOut=PlotParam;%default
645errormsg='';%default
646
647hfig=get(haxes,'parent');%handle of the figure containing the plot axes
648PosColorbar=[];
649FigData=get(hfig,'UserData');
650if isfield(FigData,'PosColorbar')
651    PosColorbar=FigData.PosColorbar;
652end
653hcol=findobj(hfig,'Tag','Colorbar'); %look for colorbar axes
654hima=findobj(haxes,'Tag','ima');% search existing image in the current axes
655test_ima=0; %default: test for image or map plot
656test_vec=0; %default: test for vector plots
657test_black=0;
658test_false=0;
659test_C=0;
660XName='';
661x_units='';
662YName='';
663y_units='';
664
665% loop on the input field cells
666for icell=1:numel(CellInfo)
667    if strcmp(CellInfo{icell}.CoordType,'tps') %do not plot directly tps data (used for projection only)
668        continue
669    end
670    ivar_X=CellInfo{icell}.CoordIndex(end); % defines (unique) index for the variable representing unstructured x coordinate (default =[])
671    ivar_Y=CellInfo{icell}.CoordIndex(end-1); % defines (unique)index for the variable representing unstructured y coordinate (default =[])
672    ivar_C=[];
673    if isfield(CellInfo{icell},'VarIndex_scalar')
674        ivar_C=[ivar_C CellInfo{icell}.VarIndex_scalar];
675    end
676    if isfield(CellInfo{icell},'VarIndex_image')
677        ivar_C=[ivar_C CellInfo{icell}.VarIndex_image];
678    end
679    if isfield(CellInfo{icell},'VarIndex_color')
680        ivar_C=[ivar_C CellInfo{icell}.VarIndex_color];
681    end
682    if isfield(CellInfo{icell},'VarIndex_ancillary')
683        ivar_C=[ivar_C CellInfo{icell}.VarIndex_ancillary];
684    end
685    if numel(ivar_C)>1
686        errormsg= 'error in plot_field: too many scalar inputs';
687        return
688    end
689    ivar_F=[];
690    if isfield(CellInfo{icell},'VarIndex_warnflag')
691        ivar_F=CellInfo{icell}.VarIndex_warnflag; %defines index (unique) for warning flag variable
692    end
693    ivar_FF_vec=[];
694    if isfield(CellInfo{icell},'VarIndex_vector_x')&&isfield(CellInfo{icell},'VarIndex_vector_y') % vector components detected
695        if test_vec% a vector field has been already detected
696            errormsg='error in plot_field: attempt to plot two vector fields: to get the difference project on a plane with ProjMode= interp_lin or interp_tps';
697            return
698        else
699            if numel(CellInfo{icell}.VarIndex_vector_x)>1
700                errormsg='error in plot_field: attempt to plot two vector fields';
701                return
702            end
703            test_vec=1;
704            if isfield(CellInfo{icell},'VarIndex_errorflag')
705                ivar_FF_vec=CellInfo{icell}.VarIndex_errorflag; %defines index (unique) for error flag variable
706            end
707            vec_U=Data.(Data.ListVarName{CellInfo{icell}.VarIndex_vector_x});
708            vec_V=Data.(Data.ListVarName{CellInfo{icell}.VarIndex_vector_y});
709            XName=Data.ListVarName{CellInfo{icell}.CoordIndex(end)};
710            YName=Data.ListVarName{CellInfo{icell}.CoordIndex(end-1)};
711            if strcmp(CellInfo{icell}.CoordType,'scattered')%2D field with unstructured coordinates
712                vec_X=reshape(Data.(XName),[],1); %transform vectors in column matlab vectors
713                vec_Y=reshape(Data.(YName),[],1);
714            elseif strcmp(CellInfo{icell}.CoordType,'grid')%2D field with structured coordinates
715                y=Data.(YName);
716                x=Data.(XName);
717                if numel(y)==2 % y defined by first and last values on aregular mesh
718                    y=linspace(y(1),y(2),size(vec_U,1));
719                end
720                if numel(x)==2 % y defined by first and last values on aregular mesh
721                    x=linspace(x(1),x(2),size(vec_U,2));
722                end
723                [vec_X,vec_Y]=meshgrid(x,y);
724            end
725            if isfield(PlotParam.Vectors,'ColorScalar') && ~isempty(PlotParam.Vectors.ColorScalar)
726                [VarVal,ListVarName,VarAttribute,errormsg]=calc_field_interp([],Data,PlotParam.Vectors.ColorScalar);
727                if ~isempty(VarVal)
728                    vec_C=reshape(VarVal{1},1,numel(VarVal{1}));
729                    test_C=1;
730                end
731            end
732            if ~isempty(ivar_F)%~(isfield(PlotParam.Vectors,'HideWarning')&& isequal(PlotParam.Vectors.HideWarning,1))
733                vec_F=Data.(Data.ListVarName{ivar_F}); % warning flags for  dubious vectors
734                if  ~(isfield(PlotParam.Vectors,'CheckHideWarning') && isequal(PlotParam.Vectors.CheckHideWarning,1))
735                    test_black=1;
736                end
737            end
738            if ~isempty(ivar_FF_vec) %&& ~test_false
739                vec_FF=Data.(Data.ListVarName{ivar_FF_vec}); % flags for false vectors
740            end
741        end
742    elseif ~isempty(ivar_C) %scalar or image
743        if test_ima
744            errormsg='attempt to plot two scalar fields or images';
745            return
746        end
747        A=squeeze(Data.(Data.ListVarName{ivar_C}));% scalar represented as color image
748        test_ima=1;
749        if strcmp(CellInfo{icell}.CoordType,'scattered')%2D field with unstructured coordinates
750            A=reshape(A,1,[]);
751            XName=Data.ListVarName{ivar_X};
752            YName=Data.ListVarName{ivar_Y};
753            Coord_x=reshape(Data.(XName),1,[]);
754            Coord_y=reshape(Data.(YName),1,[]);
755            [A,Coord_x,Coord_y]=proj_grid(Coord_x',Coord_y',A',[],[],'np>256');  % interpolate on a grid
756            if isfield(Data,'VarAttribute')
757                if numel(Data.VarAttribute)>=ivar_X && isfield(Data.VarAttribute{ivar_X},'units')
758                    x_units=[' (' Data.VarAttribute{ivar_X}.units ')'];
759                end
760                if numel(Data.VarAttribute)>=ivar_Y && isfield(Data.VarAttribute{ivar_Y},'units')
761                    y_units=[' (' Data.VarAttribute{ivar_Y}.units ')'];
762                end
763            end
764        elseif strcmp(CellInfo{icell}.CoordType,'grid')%2D field with structured coordinates
765            YName=Data.ListVarName{CellInfo{icell}.CoordIndex(end-1)};
766            XName=Data.ListVarName{CellInfo{icell}.CoordIndex(end)};
767            Coord_y=Data.(YName);
768            Coord_x=Data.(XName);
769            test_interp_X=0; %default, regularly meshed X coordinate
770            test_interp_Y=0; %default, regularly meshed Y coordinate
771%             if isfield(Data,'VarAttribute')
772%                 if numel(Data.VarAttribute)>=CellInfo{icell}.CoordIndex(end) && isfield(Data.VarAttribute{CellInfo{icell}.CoordIndex(end)},'units')
773%                     x_units=Data.VarAttribute{CellInfo{icell}.CoordIndex(end)}.units;
774%                 end
775%                 if numel(Data.VarAttribute)>=CellInfo{icell}.CoordIndex(end-1) && isfield(Data.VarAttribute{CellInfo{icell}.CoordIndex(end-1)},'units')
776%                     y_units=Data.VarAttribute{CellInfo{icell}.CoordIndex(end-1)}.units;
777%                 end
778%             end
779            if numel(Coord_y)>2
780                DCoord_y=diff(Coord_y);
781                DCoord_y_min=min(DCoord_y);
782                DCoord_y_max=max(DCoord_y);
783                if sign(DCoord_y_min)~=sign(DCoord_y_max);% =1 for increasing values, 0 otherwise
784                    errormsg=['errror in plot_field.m: non monotonic dimension variable ' YName ];
785                    return
786                end
787                test_interp_Y=(DCoord_y_max-DCoord_y_min)> 0.0001*abs(DCoord_y_max);
788            end
789            if numel(Coord_x)>2
790                DCoord_x=diff(Coord_x);
791                DCoord_x_min=min(DCoord_x);
792                DCoord_x_max=max(DCoord_x);
793                if sign(DCoord_x_min)~=sign(DCoord_x_max)% =1 for increasing values, 0 otherwise
794                    errormsg=['errror in plot_field.m: non monotonic dimension variable ' Data.ListVarName{VarRole.coord(2)} ];
795                    return
796                end
797                test_interp_X=(DCoord_x_max-DCoord_x_min)> 0.0001*abs(DCoord_x_max);
798            end
799            if test_interp_Y
800                npxy(1)=max([256 floor((Coord_y(end)-Coord_y(1))/DCoord_y_min) floor((Coord_y(end)-Coord_y(1))/DCoord_y_max)]);
801                yI=linspace(Coord_y(1),Coord_y(end),npxy(1));
802                if ~test_interp_X
803                    xI=linspace(Coord_x(1),Coord_x(end),size(A,2));%default
804                    Coord_x=xI;
805                end
806            end
807            if test_interp_X
808                npxy(2)=max([256 floor((Coord_x(end)-Coord_x(1))/DCoord_x_min) floor((Coord_x(end)-Coord_x(1))/DCoord_x_max)]);
809                xI=linspace(Coord_x(1),Coord_x(end),npxy(2));
810                if ~test_interp_Y
811                    yI=linspace(Coord_y(1),Coord_y(end),size(A,1));
812                    Coord_y=yI;
813                end
814            end
815            if test_interp_X || test_interp_Y
816                [Coord_x2D,Coord_y2D]=meshgrid(Coord_x,Coord_y);
817                A=interp2(Coord_x2D,Coord_y2D,double(A),xI,yI');
818            end
819            Coord_x=[Coord_x(1) Coord_x(end)];% keep only the lower and upper bounds for image represnetation
820            Coord_y=[Coord_y(1) Coord_y(end)];
821        end
822    end
823    %define coordinates as CoordUnits, if not defined as attribute for each variable
824%     if isfield(Data,'VarAttribute')&& numel(Data.VarAttribute)>=1 && isfield(Data.VarAttribute{1},'unit')
825%         y_units=Data.VarAttribute{1}.unit;
826%     end
827    if isfield(Data,'CoordUnit')
828        if isempty(x_units)
829            x_units=Data.CoordUnit;
830        end
831        if isempty(y_units)
832            y_units=Data.CoordUnit;
833        end
834    elseif isfield(Data,'VarAttribute')
835        if numel(Data.VarAttribute)>=CellInfo{icell}.CoordIndex(end) && isfield(Data.VarAttribute{CellInfo{icell}.CoordIndex(end)},'units')
836            x_units=Data.VarAttribute{CellInfo{icell}.CoordIndex(end)}.units;
837        end
838        if numel(Data.VarAttribute)>=CellInfo{icell}.CoordIndex(end-1) && isfield(Data.VarAttribute{CellInfo{icell}.CoordIndex(end-1)},'units')
839            y_units=Data.VarAttribute{CellInfo{icell}.CoordIndex(end-1)}.units;
840        end
841    end
842end
843
844PlotParamOut=PlotParam; % output plot parameters equal to input by default
845
846%%   image or scalar plot %%%%%%%%%%%%%%%%%%%%%%%%%%
847if test_ima
848    % distinguish B/W and color images
849    np=size(A);%size of image
850    siz=numel(np);
851    if siz>3
852        errormsg=['unrecognized scalar type: ' num2str(siz) ' dimensions'];
853        return
854    end
855    if siz==3
856        if np(3)==1
857            siz=2;%B W image
858        elseif np(3)==3
859            siz=3;%color image
860        else
861            errormsg=['unrecognized scalar type in plot_field: considered as 2D field with ' num2str(np(3)) ' color components'];
862            return
863        end
864    end
865   
866    %set for grey scale setting
867    ColorMap='default';
868    if isfield(PlotParam.Scalar,'CheckBW') && ~isempty(PlotParam.Scalar.CheckBW)
869        ColorMap=PlotParam.Scalar.CheckBW; %BW=0 color imposed, else gray scale imposed.
870    elseif ((siz==2) && (isa(A,'uint8')|| isa(A,'uint16')))% non color images represented in gray scale by default
871        ColorMap='grayscale';
872    end
873    PlotParamOut.Scalar.CheckBW=ColorMap;
874    % determine the plot option 'image' or 'contours'
875    CheckContour=0; %default
876    if isfield(PlotParam.Scalar,'ListContour')
877        CheckContour=strcmp(PlotParam.Scalar.ListContour,'contours');% =1 for contour plot option
878    end
879   
880    %case of grey level images or contour plot
881    if ~isfield(PlotParam.Scalar,'CheckFixScalar')
882        PlotParam.Scalar.CheckFixScalar=0;% free scalar threshold value scale (from min to max) by default
883    end
884    if ~isfield(PlotParam.Scalar,'MinA')
885        PlotParam.Scalar.MinA=[];%no min scalar threshold value set
886    end
887    if ~isfield(PlotParam.Scalar,'MaxA')
888        PlotParam.Scalar.MaxA=[];%no max scalar threshold value set
889    end
890   
891    % determine the min scalar value
892    if PlotParam.Scalar.CheckFixScalar && ~isempty(PlotParam.Scalar.MinA) && isnumeric(PlotParam.Scalar.MinA)
893        MinA=double(PlotParam.Scalar.MinA); % min value set as input
894    else
895        MinA=double(min(min(min(A)))); % min value set as min of non NaN scalar values
896    end
897   
898    % error if the input scalar is NaN everywhere
899    if isnan(MinA)
900        errormsg='NaN input scalar or image in plot_field';
901        return
902    end
903   
904    % determine the max scalar value
905    CheckFixScalar=0;
906    if PlotParam.Scalar.CheckFixScalar && ~isempty(PlotParam.Scalar.MaxA) && isnumeric(PlotParam.Scalar.MaxA)
907        MaxA=double(PlotParam.Scalar.MaxA); % max value set as input
908        CheckFixScalar=1;
909    else
910        MaxA=double(max(max(max(A)))); % max value set as min of non NaN scalar values
911    end
912   
913    PlotParamOut.Scalar.MinA=MinA;
914    PlotParamOut.Scalar.MaxA=MaxA;
915    PlotParamOut.Scalar.Npx=size(A,2);
916    PlotParamOut.Scalar.Npy=size(A,1);
917   
918    % case of contour plot
919    if CheckContour
920        if ~isempty(hima) && ishandle(hima)
921            delete(hima) % delete existing image
922        end
923       
924        % set the contour values
925        if ~isfield(PlotParam.Scalar,'IncrA')
926            PlotParam.Scalar.IncrA=[];% automatic contour interval
927        end
928        if ~isempty(PlotParam.Scalar.IncrA) && isnumeric(PlotParam.Scalar.IncrA)
929            interval=PlotParam.Scalar.IncrA;
930        else % automatic contour interval
931            cont=colbartick(MinA,MaxA);
932            interval=cont(2)-cont(1);%default
933            PlotParamOut.Scalar.IncrA=interval;% set the interval as output for display on the GUI
934        end
935        abscontmin=interval*floor(MinA/interval);
936        abscontmax=interval*ceil(MaxA/interval);
937        contmin=interval*floor(min(min(A))/interval);
938        contmax=interval*ceil(max(max(A))/interval);
939        cont_pos_plus=0:interval:contmax;% zero and positive contour values (plotted as solid lines)
940        cont_pos_min=double(contmin):interval:-interval;% negative contour values (plotted as dashed lines)
941        cont_pos=[cont_pos_min cont_pos_plus];% set of all contour values
942       
943        sizpx=(Coord_x(end)-Coord_x(1))/(np(2)-1);
944        sizpy=(Coord_y(1)-Coord_y(end))/(np(1)-1);
945        x_cont=Coord_x(1):sizpx:Coord_x(end); % pixel x coordinates for image display
946        y_cont=Coord_y(1):-sizpy:Coord_y(end); % pixel x coordinates for image display
947       
948        tag_axes=get(haxes,'Tag');% axes tag
949        Opacity=1;
950        if isfield(PlotParam.Scalar,'Opacity')&&~isempty(PlotParam.Scalar.Opacity)
951            Opacity=PlotParam.Scalar.Opacity;
952        end
953        % fill the space between contours if opacity is undefined or =1
954        if isequal(Opacity,1)
955            [var,hcontour]=contour(haxes,x_cont,y_cont,A,cont_pos);% determine all contours
956            set(hcontour,'Fill','on')% fill the space between contours
957            set(hcontour,'LineStyle','none')
958            hold on
959        end
960        [var_p,hcontour_p]=contour(haxes,x_cont,y_cont,A,cont_pos_plus,'k-');% draw the contours for positive values as solid lines
961        hold on
962        [var_m,hcontour_m]=contour(haxes,x_cont,y_cont,A,cont_pos_min,'--');% draw the contours for negative values as dashed lines
963        if isequal(Opacity,1)
964            set(hcontour_m,'LineColor',[1 1 1])% draw negative contours in white (better visibility in dark background)
965        end
966        set(haxes,'Tag',tag_axes);% restore axes tag (removed by the matlab fct contour !)
967        hold off
968       
969        %determine the color scale and map
970        caxis([abscontmin abscontmax])
971        if strcmp(ColorMap,'grayscale')
972            vec=linspace(0,1,(abscontmax-abscontmin)/interval);%define a greyscale colormap with steps interval
973            map=[vec' vec' vec'];
974            colormap(map);
975        elseif strcmp(ColorMap,'BuYlRd')
976            hh=load('BuYlRd.mat');
977            colormap(hh.BuYlRd);
978        else
979            colormap(ColorMap);
980        end
981    else %usual images (no contour)
982        % set  colormap for  image display
983        if strcmp(ColorMap,'grayscale')
984            vec=linspace(0,1,255);%define a linear greyscale colormap
985            map=[vec' vec' vec'];
986            colormap(map);  %grey scale color map
987            if siz==3% true color images visualized in BW
988                A=uint16(sum(A,3));%sum the three color components for color images displayed with BW option
989            end
990        elseif strcmp(ColorMap,'BuYlRd')
991            hh=load('BuYlRd.mat');
992            colormap(hh.BuYlRd);
993        else
994            if siz==3 && CheckFixScalar % true color images rescaled by MaxA
995                  A=uint8(255*double(A)/double(MaxA));
996            end
997            colormap(ColorMap); % standard false colors for div, vort , scalar fields
998        end
999       
1000        % interpolate field to increase resolution of image display
1001        test_interp=0;
1002        if size(A,3)==1 % scalar or B/W image
1003            test_interp=1;
1004            if max(np) <= 64
1005                npxy=8*np;% increase the resolution 8 times
1006            elseif max(np) <= 128
1007                npxy=4*np;% increase the resolution 4 times
1008            elseif max(np) <= 256
1009                npxy=2*np;% increase the resolution 2 times
1010            else
1011                npxy=np;
1012                test_interp=0; % no interpolation done
1013            end
1014        end
1015        if test_interp%if we interpolate
1016            x=linspace(Coord_x(1),Coord_x(2),np(2));
1017            y=linspace(Coord_y(1),Coord_y(2),np(1));
1018            [X,Y]=meshgrid(x,y);
1019            xi=linspace(Coord_x(1),Coord_x(2),npxy(2));
1020            yi=linspace(Coord_y(1),Coord_y(2),npxy(1));
1021            A = interp2(X,Y,double(A),xi,yi');
1022        end
1023        % create new image if no image handle is found
1024        if isempty(hima)
1025            tag=get(haxes,'Tag');
1026            if MinA<MaxA
1027                hima=imagesc(Coord_x,Coord_y,A,[MinA MaxA]);
1028            else % to deal with uniform field
1029                hima=imagesc(Coord_x,Coord_y,A,[MaxA-1 MaxA]);
1030            end
1031            % the function imagesc reset the axes 'DataAspectRatioMode'='auto', change if .CheckFixAspectRatio is
1032            % requested:
1033            set(hima,'Tag','ima')
1034            set(hima,'HitTest','off')
1035            set(haxes,'Tag',tag);%preserve the axes tag (removed by image fct !!!)
1036            uistack(hima, 'bottom')
1037            % update an existing image
1038        else
1039            set(hima,'CData',A);
1040            if MinA<MaxA
1041                set(haxes,'CLim',[MinA MaxA])
1042            else
1043                set(haxes,'CLim',[MinA MaxA+1])
1044            end
1045            set(hima,'XData',Coord_x);
1046            set(hima,'YData',Coord_y);
1047        end
1048       
1049        % set the transparency to 0.5 if vectors are also plotted
1050        if isfield(PlotParam.Scalar,'Opacity')&& ~isempty(PlotParam.Scalar.Opacity)
1051            set(hima,'AlphaData',PlotParam.Scalar.Opacity)
1052        else
1053            if test_vec
1054                set(hima,'AlphaData',0.5)%set opacity to 0.5 by default in the presence of vectors
1055                PlotParamOut.Scalar.Opacity=0.5;
1056            else
1057                set(hima,'AlphaData',1)% full opacity (no transparency) by default
1058            end
1059        end
1060    end
1061    if isfield(PlotParam.Axes,'CheckFixAspectRatio') && isequal(PlotParam.Axes.CheckFixAspectRatio,1)
1062        set(haxes,'DataAspectRatioMode','manual')
1063        if isfield(PlotParam.Axes,'AspectRatio')
1064            set(haxes,'DataAspectRatio',[PlotParam.Axes.AspectRatio 1 1])
1065        else
1066            set(haxes,'DataAspectRatio',[1 1 1])
1067        end
1068    end
1069    test_ima=1;
1070   
1071    %display the colorbar code for B/W images if Poscolorbar not empty
1072    if ~isempty(PosColorbar)
1073        if size(A,3)==1 && exist('PosColorbar','var')
1074            if isempty(hcol)||~ishandle(hcol)
1075                hcol=colorbar;%create new colorbar
1076            end
1077            if length(PosColorbar)==4
1078                set(hcol,'Position',PosColorbar)
1079            end
1080            %YTick=0;%default
1081            if MaxA>MinA
1082                if CheckContour
1083                    colbarlim=get(hcol,'YLim');
1084                    scale_bar=(colbarlim(2)-colbarlim(1))/(abscontmax-abscontmin);
1085                    YTick=cont_pos(2:end-1);
1086                    YTick_scaled=colbarlim(1)+scale_bar*(YTick-abscontmin);
1087                    set(hcol,'YTick',YTick_scaled);
1088                elseif (isfield(PlotParam.Scalar,'CheckBW') && isequal(PlotParam.Scalar.CheckBW,1))||isa(A,'uint8')|| isa(A,'uint16')%images
1089                    hi=get(hcol,'children');
1090                    if iscell(hi)%multiple images in colorbar
1091                        hi=hi{1};
1092                    end
1093                    set(hi,'YData',[MinA MaxA])
1094                    set(hi,'CData',(1:256)')
1095                    set(hcol,'YLim',[MinA MaxA])
1096                    YTick=colbartick(MinA,MaxA);
1097                    set(hcol,'YTick',YTick)
1098                else
1099                    hi=get(hcol,'children');
1100                    if iscell(hi)%multiple images in colorbar
1101                        hi=hi{1};
1102                    end
1103                    set(hi,'YData',[MinA MaxA])
1104                    set(hi,'CData',(1:64)')
1105                    YTick=colbartick(MinA,MaxA);
1106                    set(hcol,'YLim',[MinA MaxA])
1107                    set(hcol,'YTick',YTick)
1108                end
1109                set(hcol,'Yticklabel',num2str(YTick'));
1110            end
1111        elseif ishandle(hcol)
1112            delete(hcol); %erase existing colorbar if not needed
1113        end
1114    end
1115else%no scalar plot
1116    if ~isempty(hima) && ishandle(hima)
1117        delete(hima)
1118    end
1119    if ~isempty(PosColorbar) && ~isempty(hcol)&& ishandle(hcol)
1120        delete(hcol)
1121    end
1122    PlotParamOut=rmfield(PlotParamOut,'Scalar');
1123end
1124
1125%%   vector plot %%%%%%%%%%%%%%%%%%%%%%%%%%
1126if test_vec
1127   %vector scale representation
1128    if size(vec_U,1)==numel(vec_Y) && size(vec_U,2)==numel(vec_X) % x, y  coordinate variables
1129        [vec_X,vec_Y]=meshgrid(vec_X,vec_Y);
1130    end   
1131    vec_X=reshape(vec_X,1,numel(vec_X));%reshape in matlab vectors
1132    vec_Y=reshape(vec_Y,1,numel(vec_Y));
1133    vec_U=reshape(vec_U,1,numel(vec_U));
1134    vec_V=reshape(vec_V,1,numel(vec_V));
1135     MinMaxX=max(vec_X)-min(vec_X);
1136    if  isfield(PlotParam.Vectors,'CheckFixVectors') && isequal(PlotParam.Vectors.CheckFixVectors,1)&& isfield(PlotParam.Vectors,'VecScale')...
1137               &&~isempty(PlotParam.Vectors.VecScale) && isa(PlotParam.Vectors.VecScale,'double') %fixed vector scale
1138        scale=PlotParam.Vectors.VecScale;  %impose the length of vector representation
1139    else
1140        if ~test_false %remove false vectors   
1141            indsel=1:numel(vec_X);%
1142        end
1143        if isempty(vec_U)
1144            scale=1;
1145        else
1146            if isempty(indsel)
1147                MaxU=max(abs(vec_U));
1148                MaxV=max(abs(vec_V));
1149            else
1150                MaxU=max(abs(vec_U(indsel)));
1151                MaxV=max(abs(vec_V(indsel)));
1152            end
1153            scale=MinMaxX/(max(MaxU,MaxV)*50);
1154            PlotParam.Vectors.VecScale=scale;%update the 'scale' display
1155        end
1156    end
1157   
1158    %record vectors on the plotting axes
1159    if test_C==0
1160        vec_C=ones(1,numel(vec_X));
1161    end
1162   
1163    %decimate by a factor 2 in vector mesh(4 in nbre of vectors)
1164    check_decimate=0;
1165    if isfield(PlotParam.Vectors,'CheckDecimate4') && PlotParam.Vectors.CheckDecimate4
1166        check_decimate=1;
1167        diffy=diff(vec_Y); %difference dy=vec_Y(i+1)-vec_Y(i)
1168        dy_thresh=max(abs(diffy))/2;
1169        ind_jump=find(abs(diffy) > dy_thresh); %indices with diff(vec_Y)> max/2, detect change of line
1170        ind_sel=1:ind_jump(1);%select the first line
1171        for i=2:2:length(ind_jump)-1
1172            ind_sel=[ind_sel (ind_jump(i)+1:ind_jump(i+1))];% select the odd lines
1173        end
1174        nb_sel=length(ind_sel);
1175        ind_sel=ind_sel(1:2:nb_sel);% take half the points on a line
1176    elseif isfield(PlotParam.Vectors,'CheckDecimate16') && PlotParam.Vectors.CheckDecimate16
1177        check_decimate=1;
1178        diffy=diff(vec_Y); %difference dy=vec_Y(i+1)-vec_Y(i)
1179        dy_thresh=max(abs(diffy))/2;
1180        ind_jump=find(abs(diffy) > dy_thresh); %indices with diff(vec_Y)> max/2, detect change of line
1181        ind_sel=1:ind_jump(1);%select the first line
1182        for i=2:4:length(ind_jump)-1
1183            ind_sel=[ind_sel (ind_jump(i)+1:ind_jump(i+1))];% select the odd lines
1184        end
1185        nb_sel=length(ind_sel);
1186        ind_sel=ind_sel(1:4:nb_sel);% take half the points on a line
1187    end
1188    if check_decimate
1189        vec_X=vec_X(ind_sel);
1190        vec_Y=vec_Y(ind_sel);
1191        vec_U=vec_U(ind_sel);
1192        vec_V=vec_V(ind_sel);
1193        vec_C=vec_C(ind_sel);
1194        if ~isempty(ivar_F)
1195           vec_F=vec_F(ind_sel);
1196        end
1197        if ~isempty(ivar_FF_vec)
1198           vec_FF=vec_FF(ind_sel);
1199        end
1200    end
1201   
1202    %get main level color code
1203    [colorlist,col_vec,PlotParamOut.Vectors]=set_col_vec(PlotParam.Vectors,vec_C);
1204   
1205    % take flags into account: add flag colors to the list of colors
1206    nbcolor=size(colorlist,1);
1207    if test_black
1208       nbcolor=nbcolor+1;
1209       colorlist(nbcolor,:)=[0 0 0]; %add black to the list of colors
1210       if ~isempty(ivar_FF_vec)
1211            col_vec(vec_F~=1 & vec_F~=0 & vec_FF==0)=nbcolor;
1212       else
1213            col_vec(vec_F~=1 & vec_F~=0)=nbcolor;
1214       end
1215    end
1216    nbcolor=nbcolor+1;
1217    if ~isempty(ivar_FF_vec)
1218        if isfield(PlotParam.Vectors,'CheckHideFalse') && PlotParam.Vectors.CheckHideFalse==1
1219            colorlist(nbcolor,:)=[NaN NaN NaN];% no plot of false vectors
1220        else
1221            colorlist(nbcolor,:)=[1 0 1];% magenta color
1222        end
1223        col_vec(vec_FF~=0)=nbcolor;
1224    end
1225    %plot vectors:
1226    quiresetn(haxes,vec_X,vec_Y,vec_U,vec_V,scale,colorlist,col_vec);   
1227else
1228    hvec=findobj(haxes,'Tag','vel');
1229    if ~isempty(hvec)
1230        delete(hvec);
1231    end
1232    PlotParamOut=rmfield(PlotParamOut,'Vectors');
1233end
1234
1235%store the coordinate extrema occupied by the field
1236if ~isempty(Data)
1237    MinX=[];
1238    MaxX=[];
1239    MinY=[];
1240    MaxY=[];
1241    fix_lim=isfield(PlotParam.Axes,'CheckFixLimits') && PlotParam.Axes.CheckFixLimits;
1242    if fix_lim
1243        if isfield(PlotParam.Axes,'MinX')&&isfield(PlotParam.Axes,'MaxX')&&isfield(PlotParam.Axes,'MinY')&&isfield(PlotParam.Axes,'MaxY')
1244            MinX=PlotParam.Axes.MinX;
1245            MaxX=PlotParam.Axes.MaxX;
1246            MinY=PlotParam.Axes.MinY;
1247            MaxY=PlotParam.Axes.MaxY;
1248        end  %else PlotParamOut.MinX =PlotParam.MinX...
1249    else
1250        if test_ima %both background image and vectors coexist, take the wider bound
1251            MinX=min(Coord_x);
1252            MaxX=max(Coord_x);
1253            MinY=min(Coord_y);
1254            MaxY=max(Coord_y);
1255            if test_vec
1256                MinX=min(MinX,min(vec_X));
1257                MaxX=max(MaxX,max(vec_X));
1258                MinY=min(MinY,min(vec_Y));
1259                MaxY=max(MaxY,max(vec_Y));
1260            end
1261        elseif test_vec
1262            MinX=min(vec_X);
1263            MaxX=max(vec_X);
1264            MinY=min(vec_Y);
1265            MaxY=max(vec_Y);
1266        end
1267    end
1268    PlotParamOut.Axes.MinX=MinX;
1269    PlotParamOut.Axes.MaxX=MaxX;
1270    PlotParamOut.Axes.MinY=MinY;
1271    PlotParamOut.Axes.MaxY=MaxY;
1272    if MaxX>MinX
1273        set(haxes,'XLim',[MinX MaxX]);% set x limits of frame in axes coordinates
1274    end
1275    if MaxY>MinY
1276        set(haxes,'YLim',[MinY MaxY]);% set x limits of frame in axes coordinates
1277    end
1278    set(haxes,'YDir','normal')
1279    set(get(haxes,'XLabel'),'String',[XName ' (' x_units ')']);
1280    set(get(haxes,'YLabel'),'String',[YName ' (' y_units ')']);
1281    PlotParamOut.Axes.x_units=x_units;
1282    PlotParamOut.Axes.y_units=y_units;
1283end
1284
1285%-------------------------------------------------------------------
1286% --- function for plotting vectors
1287%INPUT:
1288% haxes: handles of the plotting axes
1289% x,y,u,v: vectors coordinates and vector components to plot, arrays withb the same dimension
1290% scale: scaling factor for vector length representation
1291% colorlist(icolor,:): list of vector colors, dim (nbcolor,3), depending on color #i
1292% col_vec: matlab vector setting the color number #i for each velocity vector
1293function quiresetn(haxes,x,y,u,v,scale,colorlist,col_vec)
1294%-------------------------------------------------------------------
1295%define arrows
1296theta=0.5 ;%angle arrow
1297alpha=0.3 ;%length arrow
1298rot=alpha*[cos(theta) -sin(theta); sin(theta) cos(theta)]';
1299
1300%find the existing lines
1301h=findobj(haxes,'Tag','vel');% search existing lines in the current axes
1302sizh=size(h);
1303set(haxes,'NextPlot','replacechildren');
1304
1305%create lines (if no lines) or modify them
1306if ~isequal(size(col_vec),size(x))
1307    col_vec=ones(size(x));% case of error in col_vec input
1308end
1309nbcolor=size(colorlist,1);
1310
1311for icolor=1:nbcolor
1312    %determine the line positions for each color icolor
1313    ind=find(col_vec==icolor);
1314    xc=x(ind);
1315    yc=y(ind);
1316    uc=u(ind)*scale;
1317    vc=v(ind)*scale;
1318    n=size(xc);
1319    xN=NaN*ones(size(xc));
1320    matx=[xc(:)-uc(:)/2 xc(:)+uc(:)/2 xN(:)]';
1321    matx=reshape(matx,1,3*n(2));
1322    maty=[yc(:)-vc(:)/2 yc(:)+vc(:)/2 xN(:)]';
1323    maty=reshape(maty,1,3*n(2));
1324   
1325    %determine arrow heads
1326    arrowplus=rot*[uc;vc];
1327    arrowmoins=rot'*[uc;vc];
1328    x1=xc+uc/2-arrowplus(1,:);
1329    x2=xc+uc/2;
1330    x3=xc+uc/2-arrowmoins(1,:);
1331    y1=yc+vc/2-arrowplus(2,:);
1332    y2=yc+vc/2;
1333    y3=yc+vc/2-arrowmoins(2,:);
1334    matxar=[x1(:) x2(:) x3(:) xN(:)]';
1335    matxar=reshape(matxar,1,4*n(2));
1336    matyar=[y1(:) y2(:) y3(:) xN(:)]';
1337    matyar=reshape(matyar,1,4*n(2));
1338    %draw the line or modify the existing ones
1339%     tri=reshape(1:3*length(uc),3,[])';   
1340    isn=isnan(colorlist(icolor,:));%test if color NaN
1341    if 2*icolor > sizh(1) %if icolor exceeds the number of existing ones
1342        if ~isn(1) %if the vectors are visible color not nan
1343            if n(2)>0
1344                hold on
1345                line(matx,maty,'Color',colorlist(icolor,:),'Tag','vel');% plot new lines
1346                line(matxar,matyar,'Color',colorlist(icolor,:),'Tag','vel');% plot arrows
1347            end
1348        end
1349    else
1350        if isn(1)
1351            delete(h(2*icolor-1))
1352            delete(h(2*icolor))
1353        else
1354            set(h(2*icolor-1),'Xdata',matx,'Ydata',maty);
1355            set(h(2*icolor-1),'Color',colorlist(icolor,:));
1356%            set(h(2*icolor-1),'EraseMode','xor');
1357            set(h(2*icolor),'Xdata',matxar,'Ydata',matyar);
1358            set(h(2*icolor),'Color',colorlist(icolor,:));
1359            %set(h(2*icolor),'EraseMode','xor');
1360        end
1361    end
1362end
1363if sizh(1) > 2*nbcolor
1364    for icolor=nbcolor+1 : sizh(1)/2 %delete additional objects
1365        delete(h(2*icolor-1))
1366        delete(h(2*icolor))
1367    end
1368end
1369
1370%-------------------------------------------------------------------
1371% ---- determine tick positions for colorbar
1372function YTick=colbartick(MinA,MaxA)
1373%-------------------------------------------------------------------
1374%determine tick positions with "simple" values between MinA and MaxA
1375YTick=0;%default
1376maxabs=max([abs(MinA) abs(MaxA)]);
1377if maxabs>0
1378ord=10^(floor(log10(maxabs)));%order of magnitude
1379div=1;
1380siz2=1;
1381while siz2<2
1382    values=-10:div:10;
1383    ind=find((ord*values-MaxA)<0 & (ord*values-MinA)>0);%indices of 'values' such that MinA<ord*values<MaxA
1384    siz=size(ind);
1385    if siz(2)<4%if there are less than 4 selected values (4 levels)
1386        values=-9:0.5*div:9;
1387        ind=find((ord*values-MaxA)<0 & (ord*values-MinA)>0);
1388    end
1389    siz2=size(ind,2);
1390    div=div/10;
1391end
1392YTick=ord*values(ind);
1393end
1394
1395% -------------------------------------------------------------------------
1396% --- 'proj_grid': project  fields with unstructured coordinantes on a regular grid
1397function [A,rangx,rangy]=proj_grid(vec_X,vec_Y,vec_A,rgx_in,rgy_in,npxy_in)
1398% -------------------------------------------------------------------------
1399if length(vec_Y)<2
1400    msgbox_uvmat('ERROR','less than 2 points in proj_grid.m');
1401    return;
1402end
1403diffy=diff(vec_Y); %difference dy=vec_Y(i+1)-vec_Y(i)
1404index=find(diffy);% find the indices of vec_Y after wich a change of horizontal line occurs(diffy non zero)
1405if isempty(index); msgbox_uvmat('ERROR','points aligned along abscissa in proj_grid.m'); return; end;%points aligned% A FAIRE: switch to line plot.
1406diff2=diff(diffy(index));% diff2 = fluctuations of the detected vertical grid mesh dy
1407if max(abs(diff2))>0.001*abs(diffy(index(1))) % if max(diff2) is larger than 1/1000 of the first mesh dy
1408    % the data are not regularly spaced and must be interpolated  on a regular grid
1409    if exist('rgx_in','var') & ~isempty (rgx_in) & isnumeric(rgx_in) & length(rgx_in)==2%  positions imposed from input
1410        rangx=rgx_in; % first and last positions
1411        rangy=rgy_in;
1412        dxy(1)=1/(npxy_in(1)-1);%grid mesh in y
1413        dxy(2)=1/(npxy_in(2)-1);%grid mesh in x
1414        dxy(1)=(rangy(2)-rangy(1))/(npxy_in(1)-1);%grid mesh in y
1415        dxy(2)=(rangx(2)-rangx(1))/(npxy_in(2)-1);%grid mesh in x
1416    else % interpolation grid automatically determined
1417        rangx(1)=min(vec_X);
1418        rangx(2)=max(vec_X);
1419        rangy(2)=min(vec_Y);
1420        rangy(1)=max(vec_Y);
1421        dxymod=sqrt((rangx(2)-rangx(1))*(rangy(1)-rangy(2))/length(vec_X));
1422        dxy=[-dxymod/4 dxymod/4];% increase the resolution 4 times
1423    end
1424    xi=rangx(1):dxy(2):rangx(2);
1425    yi=rangy(1):dxy(1):rangy(2);
1426    A=griddata(vec_X,vec_Y,vec_A,xi,yi');
1427    A=reshape(A,length(yi),length(xi));
1428else
1429    x=vec_X(1:index(1));% the set of abscissa (obtained on the first line)
1430    indexend=index(end);% last vector index of line change
1431    ymax=vec_Y(indexend+1);% y coordinate AFTER line change
1432    ymin=vec_Y(index(1));
1433    y=vec_Y(index);
1434    y(length(y)+1)=ymax;
1435    nx=length(x);   %number of grid points in x
1436    ny=length(y);   % number of grid points in y
1437    B=(reshape(vec_A,nx,ny))'; %vec_A reshaped as a rectangular matrix
1438    [X,Y]=meshgrid(x,y);% positions X and Y also reshaped as matrix
1439
1440    %linear interpolation to improve the image resolution and/or adjust
1441    %to prescribed positions
1442    test_interp=1;
1443    if exist('rgx_in','var') & ~isempty (rgx_in) & isnumeric(rgx_in) & length(rgx_in)==2%  positions imposed from input
1444        rangx=rgx_in; % first and last positions
1445        rangy=rgy_in;
1446        npxy=npxy_in;
1447    else       
1448        rangx=[vec_X(1) vec_X(nx)];% first and last position found for x
1449          rangy=[max(ymax,ymin) min(ymax,ymin)];
1450        if max(nx,ny) <= 64 & isequal(npxy_in,'np>256')
1451            npxy=[8*ny 8*nx];% increase the resolution 8 times
1452        elseif max(nx,ny) <= 128 & isequal(npxy_in,'np>256')
1453            npxy=[4*ny 4*nx];% increase the resolution 4 times
1454        elseif max(nx,ny) <= 256 & isequal(npxy_in,'np>256')
1455            npxy=[2*ny 2*nx];% increase the resolution 2 times
1456        else
1457            npxy=[ny nx];
1458            test_interp=0; % no interpolation done
1459        end
1460    end
1461    if test_interp==1%if we interpolate
1462        xi=[rangx(1):(rangx(2)-rangx(1))/(npxy(2)-1):rangx(2)];
1463        yi=[rangy(1):(rangy(2)-rangy(1))/(npxy(1)-1):rangy(2)];
1464        [XI,YI]=meshgrid(xi,yi);
1465        A = interp2(X,Y,B,XI,YI);
1466    else %no interpolation for a resolution higher than 256
1467        A=B;
1468    end
1469end
Note: See TracBrowser for help on using the repository browser.