source: trunk/src/plot_field.m @ 940

Last change on this file since 940 was 932, checked in by sommeria, 5 years ago

writting access improved

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