source: trunk/src/plot_field.m @ 511

Last change on this file since 511 was 511, checked in by sommeria, 9 years ago

cleaning of uvmat and related fcts

File size: 55.1 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_indices.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,htext,PosColorbar)
15%
16% OUPUT:
17% PlotType: type of plot: 'text','line'(curve plot),'plane':2D view,'volume'
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%     .Coordinates: coordinate parameters:
48%           .CheckFixLimits:=0 (default) adjust axes limit to the X,Y data, =1: preserves the previous axes limits
49%     .Coordinates.CheckFixAspectRatio: =0 (default):automatic adjustment of the graph, keep 1 to 1 aspect ratio for x and y scales.
50%     .Coordinates.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 not empty, display a colorbar for B&W images
79%               imposed position of the colorbar (ex [0.821 0.471 0.019 0.445])
80
81%AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
82%  Copyright Joel Sommeria, 2008, LEGI / CNRS-UJF-INPG, sommeria@coriolis-legi.org.
83%AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
84%     This file is part of the toolbox UVMAT.
85%
86%     UVMAT is free software; you can redistribute it and/or modify
87%     it under the terms of the GNU General Public License as published by
88%     the Free Software Foundation; either version 2 of the License, or
89%     (at your option) any later version.
90%
91%     UVMAT is distributed in the hope that it will be useful,
92%     but WITHOUT ANY WARRANTY; without even the implied warranty of
93%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
94%     GNU General Public License (file UVMAT/COPYING.txt) for more details.
95%AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
96
97function [PlotType,PlotParamOut,haxes]= plot_field(Data,haxes,PlotParam,PosColorbar)
98
99%% default input and output
100if ~exist('PlotParam','var'),PlotParam=[];end;
101if ~exist('PosColorbar','var'),PosColorbar=[];end;
102PlotType='text'; %default
103PlotParamOut=PlotParam;%default
104if ~isfield(PlotParam,'Coordinates')
105    PlotParam.Coordinates=[];
106end
107
108%% check input structure
109index_2D=[];
110index_1D=[];
111index_0D=[];
112errormsg=check_field_structure(Data);
113if ~isempty(errormsg)
114    msgbox_uvmat('ERROR',['input of plot_field/check_field_structure: ' errormsg])
115    display(['input of plot_field/check_field_structure: ' errormsg])
116    return
117end
118% check the cells of fields :
119[CellVarIndex,NbDim,VarType,errormsg]=find_field_indices(Data);
120if ~isempty(errormsg)
121    msgbox_uvmat('ERROR',['input of plot_field/find_field_indices: ' errormsg]);
122    return
123end
124index_2D=find(NbDim==2,2);%find 2D fields (at most 2)
125index_3D=find(NbDim>2,1);
126if ~isempty(index_3D)
127    if isfield(Data,'NbDim')&& isequal(Data.NbDim,2)
128        index_2D=[index_2D index_3D];
129    else
130        msgbox_uvmat('ERROR','volume plot not implemented yet');
131        return
132    end
133end
134index_1D=find(NbDim==1&~cellfun(@isempty,VarType));
135index_0D=find(NbDim==0);
136%remove coordinates variables from 1D plot
137% if ~isempty(index_2D)
138%     for ivar=1:length(index_1D)
139%         if isequal(CellVarIndex{index_1D(ivar)},VarType{index_1D(ivar)}.coord)
140%             index_1D(ivar)=0;
141%         end
142%     end
143%     index_1D=index_1D(index_1D>0);
144% end
145
146%% test axes and figure
147testnewfig=1;%test to create a new figure (default)
148testzoomaxes=0;%test for the existence of a zoom secondary figure attached to the plotting axes
149if exist('haxes','var')
150    if ishandle(haxes)
151        if isequal(get(haxes,'Type'),'axes')
152            testnewfig=0;
153            AxeData=get(haxes,'UserData');
154            if isfield(AxeData,'ZoomAxes')&& ishandle(AxeData.ZoomAxes)
155                if isequal(get(AxeData.ZoomAxes,'Type'),'axes')
156                    testzoomaxes=1;
157                    zoomaxes=AxeData.ZoomAxes;
158                end
159            end
160        end
161    end
162end
163
164%% create a new figure and axes if the plotting axes does not exist
165if testnewfig
166    hfig=figure;
167    set(hfig,'Units','normalized')
168    haxes=axes;
169    set(haxes,'position',[0.13,0.2,0.775,0.73])
170    PlotParam.NextPlot='add'; %parameter for plot_profile and plot_his
171else
172    hfig=get(haxes,'parent');
173    set(0,'CurrentFigure',hfig)% the parent of haxes becomes the current figure
174    set(hfig,'CurrentAxes',haxes)%  haxes becomes the current axes of the parent figure
175end
176
177%% set axes properties
178if isfield(PlotParam.Coordinates,'CheckFixLimits') && isequal(PlotParam.Coordinates.CheckFixLimits,1)  %adjust the graph limits
179    set(haxes,'XLimMode', 'manual')
180    set(haxes,'YLimMode', 'manual')
181else
182    set(haxes,'XLimMode', 'auto')
183    set(haxes,'YLimMode', 'auto')
184end
185% if ~isfield(PlotParam.Coordinates,'CheckFixAspectRatio')&& isfield(Data,'CoordUnit')
186%     PlotParam.Coordinates.CheckFixAspectRatio=1;% if CoordUnit is defined, the two coordiantes should be plotted with equal scale by default
187% end
188errormsg='';
189PlotParamOut.Coordinates=[]; %default output
190AxeData=get(haxes,'UserData');
191
192%% 2D plots
193if isempty(index_2D)
194    plot_plane([],[],[],haxes);%removes images or vector plots in the absence of 2D field plot
195else  %plot 2D field
196    [tild,PlotParamOut,PlotType,errormsg]=plot_plane(Data,CellVarIndex(index_2D),VarType(index_2D),haxes,PlotParam,PosColorbar);
197    AxeData.NbDim=2;
198    if testzoomaxes && isempty(errormsg)
199        [zoomaxes,PlotParamOut,tild,errormsg]=plot_plane(Data,CellVarIndex(index_2D),VarType(index_2D),zoomaxes,PlotParam,PosColorbar);
200        AxeData.ZoomAxes=zoomaxes;
201    end
202end
203
204%% 1D plot (usual graph y vs x)
205if isempty(index_1D)
206    if ~isempty(haxes)
207        plot_profile([],[],[],haxes);%removes usual praphs y vs x in the absence of 1D field plot
208    end
209else %plot 1D field (usual graph y vs x)
210    Coordinates=plot_profile(Data,CellVarIndex(index_1D),VarType(index_1D),haxes,PlotParam.Coordinates);%
211    if testzoomaxes
212        [zoomaxes,Coordinates]=plot_profile(Data,CellVarIndex(index_1D),VarType(index_1D),zoomaxes,PlotParam.Coordinates);
213        AxeData.ZoomAxes=zoomaxes;
214    end
215    if ~isempty(Coordinates)
216        PlotParamOut.Coordinates=Coordinates;
217    end
218    PlotType='line';
219end
220
221%% text display
222if isempty(index_2D) && isempty(index_1D)%text display alone
223    htext=findobj(hfig,'Tag','TableDisplay');
224else  %text display added to plot
225    htext=findobj(hfig,'Tag','text_display');
226end
227if ~isempty(htext)
228    if isempty(index_0D)
229        if strcmp(get(htext,'Type'),'uitable')
230            set(htext,'Data',{})
231        else
232            set(htext,'String',{''})
233        end
234    else
235        [errormsg]=plot_text(Data,CellVarIndex(index_0D),VarType(index_0D),htext);
236    end
237end
238
239%% display error message
240if ~isempty(errormsg)
241    msgbox_uvmat('ERROR', errormsg)
242end
243
244%% update the parameters stored in AxeData
245if ishandle(haxes)&&( ~isempty(index_2D)|| ~isempty(index_1D))
246%     AxeData=[];
247    if isfield(PlotParamOut,'MinX')
248        AxeData.RangeX=[PlotParamOut.MinX PlotParamOut.MaxX];%'[PlotParamOut.MinX PlotParamOut.MaxX];
249        AxeData.RangeY=[PlotParamOut.MinY PlotParamOut.MaxY];%[PlotParamOut.MinY PlotParamOut.MaxY]
250    end
251    set(haxes,'UserData',AxeData)
252end
253
254%% update the plotted field stored in parent figure
255if ~isempty(index_2D)|| ~isempty(index_1D)
256    FigData=get(hfig,'UserData');
257    if strcmp(get(hfig,'tag'),'view_field')||strcmp(get(hfig,'tag'),'uvmat')
258        FigData.(get(haxes,'tag'))=Data;
259        set(hfig,'UserData',FigData)
260    end
261end
262
263%-------------------------------------------------------------------
264function errormsg=plot_text(FieldData,CellVarIndex,VarTypeCell,htext)
265%-------------------------------------------------------------------
266errormsg=[];
267txt_cell={};
268Data={};
269for icell=1:length(CellVarIndex)
270    VarIndex=CellVarIndex{icell};%  indices of the selected variables in the list data.ListVarName
271    for ivar=1:length(VarIndex)
272        checkancillary=0;
273        if length(FieldData.VarAttribute)>=VarIndex(ivar)
274            VarAttribute=FieldData.VarAttribute{VarIndex(ivar)};
275            if isfield(VarAttribute,'Role')&&(strcmp(VarAttribute.Role,'ancillary')||strcmp(VarAttribute.Role,'coord_tps')...
276                    ||strcmp(VarAttribute.Role,'vector_x_tps')||strcmp(VarAttribute.Role,'vector_y_tps'))
277                checkancillary=1;
278            end
279        end
280        if ~checkancillary% does not display variables with attribute '.Role=ancillary'
281            VarName=FieldData.ListVarName{VarIndex(ivar)};
282            VarValue=FieldData.(VarName);
283            Data =[Data [{VarName}; num2cell(VarValue)]];
284            if size(VarValue,1)~=1
285                VarValue=VarValue';% put the different values on a line
286            end
287            if size(VarValue,1)==1
288            txt=[VarName '=' num2str(VarValue)];
289            txt_cell=[txt_cell;{txt}];
290            end
291        end
292    end
293end
294if strcmp(get(htext,'Type'),'uitable')
295    get(htext,'ColumnName')
296    set(htext,'ColumnName',Data(1,:))
297    set(htext,'Data',Data(2:end,:))
298else
299    set(htext,'String',txt_cell)
300    set(htext,'UserData',txt_cell)% for storage during mouse display
301end
302
303
304%-------------------------------------------------------------------
305function CoordinatesOut=plot_profile(data,CellVarIndex,VarType,haxes,Coordinates)
306%-------------------------------------------------------------------
307
308if ~exist('Coordinates','var')
309    Coordinates=[];
310end
311CoordinatesOut=Coordinates; %default
312hfig=get(haxes,'parent');
313%suppress existing plot isf empty data
314if isempty(data)
315    hplot=findobj(haxes,'tag','plot_line');
316    if ~isempty(hplot)
317        delete(hplot)
318    end
319    hlegend=findobj(hfig,'tag','legend');
320    if ~isempty(hlegend)
321        delete(hlegend)
322    end
323    return
324end
325
326ColorOrder=[1 0 0;0 0.5 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];
327set(haxes,'ColorOrder',ColorOrder)
328if isfield(Coordinates,'NextPlot')
329    set(haxes,'NextPlot',Coordinates.NextPlot)
330end
331% adjust the size of the plot to include the whole field,
332
333legend_str={};
334
335%% prepare the string for plot command
336plotstr='hhh=plot(';
337coord_x_index=[];
338xtitle='';
339ytitle='';
340test_newplot=1;
341
342%loop on input  fields
343for icell=1:length(CellVarIndex)
344    if isempty(VarType{icell})% coordiante variable
345        continue
346    end
347    VarIndex=CellVarIndex{icell};%  indices of the selected variables in the list data.ListVarName
348    if ~isempty(VarType{icell}.coord_x)
349        coord_x_index=VarType{icell}.coord_x;
350    else
351        coord_x_index_cell=VarType{icell}.coord(1);
352        if isequal(coord_x_index_cell,0)
353             continue  % the cell has no abscissa, skip it
354        end
355        coord_x_index=coord_x_index_cell;
356    end
357    testplot=ones(size(data.ListVarName));%default test for plotted variables
358    coord_x_name{icell}=data.ListVarName{coord_x_index};
359    coord_x{icell}=data.(data.ListVarName{coord_x_index});%coordinate variable set as coord_x
360    if isempty(find(strcmp(coord_x_name{icell},coord_x_name(1:end-1)))) %xtitle not already selected
361        xtitle=[xtitle coord_x_name{icell}];
362        if isfield(data,'VarAttribute')&& numel(data.VarAttribute)>=coord_x_index && isfield(data.VarAttribute{coord_x_index},'units')
363            xtitle=[xtitle '(' data.VarAttribute{coord_x_index}.units '), '];
364        else
365            xtitle=[xtitle ', '];
366        end
367    end
368    XMin(icell)=min(coord_x{icell});
369    XMax(icell)=max(coord_x{icell});
370    testplot(coord_x_index)=0;
371    if ~isempty(VarType{icell}.ancillary')
372        testplot(VarType{icell}.ancillary)=0;
373    end
374    if ~isempty(VarType{icell}.warnflag')
375        testplot(VarType{icell}.warnflag)=0;
376    end
377    if isfield(data,'VarAttribute')
378        VarAttribute=data.VarAttribute;
379        for ivar=1:length(VarIndex)
380            if length(VarAttribute)>=VarIndex(ivar) && isfield(VarAttribute{VarIndex(ivar)},'long_name')
381                plotname{VarIndex(ivar)}=VarAttribute{VarIndex(ivar)}.long_name;
382            else
383                plotname{VarIndex(ivar)}=data.ListVarName{VarIndex(ivar)};%name for display in plot A METTRE
384            end
385        end
386    end
387    if ~isempty(VarType{icell}.discrete')
388        charplot_0='''+''';
389    else
390        charplot_0='''-''';
391    end
392    YMin=0;
393    YMax=1;%default
394    for ivar=1:length(VarIndex)
395        if testplot(VarIndex(ivar))
396            VarName=data.ListVarName{VarIndex(ivar)};
397            ytitle=[ytitle VarName];
398            if isfield(data,'VarAttribute')&& numel(data.VarAttribute)>=VarIndex(ivar) && isfield(data.VarAttribute{VarIndex(ivar)},'units')
399                ytitle=[ytitle '(' data.VarAttribute{VarIndex(ivar)}.units '), '];
400            else
401                ytitle=[ytitle ', '];
402            end
403            eval(['data.' VarName '=squeeze(data.' VarName ');'])
404            %eval(['min(data.' VarName ')'])
405            YMin(ivar)=min(min(data.(VarName)));
406            YMax(ivar)=max(max(data.(VarName)));
407            plotstr=[plotstr 'coord_x{' num2str(icell) '},data.' VarName ',' charplot_0 ','];
408            eval(['nbcomponent2=size(data.' VarName ',2);']);
409            eval(['nbcomponent1=size(data.' VarName ',1);']);
410            if numel(coord_x{icell})==2
411                coord_x{icell}=linspace(coord_x{icell}(1),coord_x{icell}(2),nbcomponent1);
412            end
413            if nbcomponent1==1|| nbcomponent2==1
414                legend_str=[legend_str {VarName}]; %variable with one component
415            else  %variable with severals  components
416                for ic=1:min(nbcomponent1,nbcomponent2)
417                    legend_str=[legend_str [VarName '_' num2str(ic)]]; %variable with severals  components
418                end                                                   % labeled by their index (e.g. color component)
419            end
420        end
421    end
422    YMin_cell(icell)=min(YMin);
423    YMax_cell(icell)=max(YMax);
424end
425
426%% activate the plot
427if test_newplot && ~isequal(plotstr,'hhh=plot(') 
428    set(hfig,'CurrentAxes',haxes)
429    tag=get(haxes,'tag');   
430    %%%
431    plotstr=[plotstr '''tag'',''plot_line'');'];   
432    eval(plotstr)                  %execute plot (instruction  plotstr)
433    %%%
434    set(haxes,'tag',tag)
435    grid(haxes, 'on')
436    hxlabel=xlabel(xtitle(1:end-2));% xlabel (removes ', ' at the end)
437    set(hxlabel,'Interpreter','none')% desable tex interpreter
438    if length(legend_str)>=1
439        hylabel=ylabel(ytitle(1:end-2));% ylabel (removes ', ' at the end)
440        set(hylabel,'Interpreter','none')% desable tex interpreter
441    end
442    if ~isempty(legend_str)
443        hlegend=findobj(hfig,'Tag','legend');
444        if isempty(hlegend)
445            hlegend=legend(legend_str);
446            txt=ver('MATLAB');
447            Release=txt.Release;
448            relnumb=str2double(Release(3:4));% should be changed to Version for better compatibility
449            if relnumb >= 14
450                set(hlegend,'Interpreter','none')% desable tex interpreter
451            end
452        else
453            legend_old=get(hlegend,'String');
454            if isequal(size(legend_old,1),size(legend_str,1))&&~isequal(legend_old,legend_str)
455                set(hlegend,'String',[legend_old legend_str]);
456            end
457        end
458    end
459    title_str='';
460    if isfield(data,'filename')
461       [Path, title_str, ext]=fileparts(data.filename);
462       title_str=[title_str ext];
463    end
464    if isfield(data,'Action')&&isfield(data.Action,'ActionName')
465        if ~isequal(title_str,'')
466            title_str=[title_str ', '];
467        end
468        title_str=[title_str data.Action.ActionName];
469    end
470    htitle=title(title_str);
471%     txt=ver('MATLAB');
472%     Release=txt.Release;
473%     relnumb=str2double(Release(3:4));
474%     if relnumb >= 14
475    set(htitle,'Interpreter','none')% desable tex interpreter
476%     end
477end
478
479%% determine axes bounds
480%CoordinatesOut.RangeX=[min(XMin) max(XMax)];
481%CoordinatesOut.RangeY=[min(YMin_cell) max(YMax_cell)];
482fix_lim=isfield(Coordinates,'CheckFixLimits') && Coordinates.CheckFixLimits;
483if fix_lim
484    if ~isfield(Coordinates,'MinX')||~isfield(Coordinates,'MaxX')||~isfield(Coordinates,'MinY')||~isfield(Coordinates,'MaxY')
485        fix_lim=0; %free limits if lits are not set,
486    end
487end
488if fix_lim
489    set(haxes,'XLim',[Coordinates.MinX Coordinates.MaxX])
490    set(haxes,'YLim',[Coordinates.MinY Coordinates.MaxY])
491else   
492    CoordinatesOut.MinX=min(XMin);
493    CoordinatesOut.MaxX=max(XMax);
494    CoordinatesOut.MinY=min(YMin_cell);
495    CoordinatesOut.MaxY=max(YMax_cell);
496end
497
498%% determine plot aspect ratio
499if isfield(Coordinates,'CheckFixAspectRatio') && isequal(Coordinates.CheckFixAspectRatio,1)&&isfield(Coordinates,'AspectRatio')
500    set(haxes,'DataAspectRatioMode','manual')
501    set(haxes,'DataAspectRatio',[Coordinates.AspectRatio 1 1])
502else
503    set(haxes,'DataAspectRatioMode','auto')%automatic aspect ratio
504    AspectRatio=get(haxes,'DataAspectRatio');
505    CoordinatesOut.AspectRatio=AspectRatio(1)/AspectRatio(2);
506end
507
508%-------------------------------------------------------------------
509function [haxes,PlotParamOut,PlotType,errormsg]=plot_plane(Data,CellVarIndex,VarTypeCell,haxes,PlotParam,PosColorbar)
510%-------------------------------------------------------------------
511
512grid(haxes, 'off')% remove grid (possibly remaining from other graphs)
513%default plotting parameters
514PlotType='plane';%default
515if ~exist('PlotParam','var')
516    PlotParam=[];
517end
518
519if ~isfield(PlotParam,'Scalar')
520    PlotParam.Scalar=[];
521end
522if ~isfield(PlotParam,'Vectors')
523    PlotParam.Vectors=[];
524end
525
526PlotParamOut=PlotParam;%default
527hfig=get(haxes,'parent');
528hcol=findobj(hfig,'Tag','Colorbar'); %look for colorbar axes
529hima=findobj(haxes,'Tag','ima');% search existing image in the current axes
530errormsg='';%default
531test_ima=0; %default: test for image or map plot
532test_vec=0; %default: test for vector plots
533test_black=0;
534test_false=0;
535test_C=0;
536XName='';
537x_units='';
538YName='';
539y_units='';
540for icell=1:length(CellVarIndex) % length(CellVarIndex) =1 or 2 (from the calling function)
541    VarType=VarTypeCell{icell};
542    if ~isempty(VarType.coord_tps)
543        continue
544    end
545    ivar_X=VarType.coord_x; % defines (unique) index for the variable representing unstructured x coordinate (default =[])
546    ivar_Y=VarType.coord_y; % defines (unique)index for the variable representing unstructured y coordinate (default =[])
547    ivar_U=VarType.vector_x; % defines (unique) index for the variable representing x vector component (default =[])
548    ivar_V=VarType.vector_y; % defines (unique) index for the variable representing y vector component (default =[])
549    ivar_C=[VarType.scalar VarType.image VarType.color VarType.ancillary]; %defines index (indices) for the scalar or ancillary fields
550    if numel(ivar_C)>1
551        errormsg= 'error in plot_field: too many scalar inputs';
552        return
553    end
554    ivar_F=VarType.warnflag; %defines index (unique) for warning flag variable
555    ivar_FF=VarType.errorflag; %defines index (unique) for error flag variable
556    ind_coord=find(VarType.coord);
557    if numel(ind_coord)==2
558        VarType.coord=VarType.coord(ind_coord);
559    end
560    if ~isempty(ivar_U) && ~isempty(ivar_V)% vector components detected
561        if test_vec
562            errormsg='error in plot_field: attempt to plot two vector fields';
563            return
564        else
565            test_vec=1;
566            vec_U=Data.(Data.ListVarName{ivar_U});
567            vec_V=Data.(Data.ListVarName{ivar_V});
568            if ~isempty(ivar_X) && ~isempty(ivar_Y)% 2D field (with unstructured coordinates or structured ones (then ivar_X and ivar_Y empty)
569                XName=Data.ListVarName{ivar_X};
570                YName=Data.ListVarName{ivar_Y};
571                eval(['vec_X=reshape(Data.' XName ',[],1);'])
572                eval(['vec_Y=reshape(Data.' YName ',[],1);'])
573            elseif numel(VarType.coord)==2 && ~isequal(VarType.coord,[0 0]);%coordinates defines by dimension variables
574                eval(['y=Data.' Data.ListVarName{VarType.coord(1)} ';'])
575                eval(['x=Data.' Data.ListVarName{VarType.coord(2)} ';'])
576                if numel(y)==2 % y defined by first and last values on aregular mesh
577                    y=linspace(y(1),y(2),size(vec_U,1));
578                end
579                if numel(x)==2 % y defined by first and last values on aregular mesh
580                    x=linspace(x(1),x(2),size(vec_U,2));
581                end
582                [vec_X,vec_Y]=meshgrid(x,y); 
583            else
584                errormsg='error in plot_field: invalid coordinate definition for vector field';
585                return
586            end
587            if ~isempty(ivar_C)
588                 eval(['vec_C=Data.' Data.ListVarName{ivar_C} ';']) ;
589                 vec_C=reshape(vec_C,1,numel(vec_C));
590                 test_C=1;
591            end
592            if ~isempty(ivar_F)%~(isfield(PlotParam.Vectors,'HideWarning')&& isequal(PlotParam.Vectors.HideWarning,1))
593                if test_vec
594                    vec_F=Data.(Data.ListVarName{ivar_F}); % warning flags for  dubious vectors
595                    if  ~(isfield(PlotParam.Vectors,'CheckHideWarning') && isequal(PlotParam.Vectors.CheckHideWarning,1))
596                        test_black=1;
597                    end
598                end
599            end
600            if ~isempty(ivar_FF) %&& ~test_false
601                if test_vec% TODO: deal with FF for structured coordinates
602                    vec_FF=Data.(Data.ListVarName{ivar_FF}); % flags for false vectors
603                end
604            end
605        end
606    elseif ~isempty(ivar_C) %scalar or image
607        if test_ima
608             errormsg='attempt to plot two scalar fields or images';
609            return
610        end
611        eval(['A=squeeze(Data.' Data.ListVarName{ivar_C} ');']) ;% scalar represented as color image
612        test_ima=1;
613        if ~isempty(ivar_X) && ~isempty(ivar_Y)% 2D field (with unstructured coordinates  (then ivar_X and ivar_Y not empty)
614            A=reshape(A,1,[]);
615            XName=Data.ListVarName{ivar_X};
616            YName=Data.ListVarName{ivar_Y};
617            eval(['AX=reshape(Data.' XName ',1,[]);'])
618            eval(['AY=reshape(Data.' YName ',1,[]);'])
619            [A,AX,AY]=proj_grid(AX',AY',A',[],[],'np>256');  % interpolate on a grid 
620            if isfield(Data,'VarAttribute')
621                if numel(Data.VarAttribute)>=ivar_X && isfield(Data.VarAttribute{ivar_X},'units')
622                    x_units=[' (' Data.VarAttribute{ivar_X}.units ')'];
623                end
624                if numel(Data.VarAttribute)>=ivar_Y && isfield(Data.VarAttribute{ivar_Y},'units')
625                    y_units=[' (' Data.VarAttribute{ivar_Y}.units ')'];
626                end
627            end       
628        elseif numel(VarType.coord)==2 %structured coordinates
629            XName=Data.ListVarName{VarType.coord(2)};
630            YName=Data.ListVarName{VarType.coord(1)};
631            eval(['AY=Data.' Data.ListVarName{VarType.coord(1)} ';'])
632            eval(['AX=Data.' Data.ListVarName{VarType.coord(2)} ';'])
633            test_interp_X=0; %default, regularly meshed X coordinate
634            test_interp_Y=0; %default, regularly meshed Y coordinate
635            if isfield(Data,'VarAttribute')
636                if numel(Data.VarAttribute)>=VarType.coord(2) && isfield(Data.VarAttribute{VarType.coord(2)},'units')
637                    x_units=Data.VarAttribute{VarType.coord(2)}.units;
638                end
639                if numel(Data.VarAttribute)>=VarType.coord(1) && isfield(Data.VarAttribute{VarType.coord(1)},'units')
640                    y_units=Data.VarAttribute{VarType.coord(1)}.units;
641                end
642            end 
643            if numel(AY)>2
644                DAY=diff(AY);
645                DAY_min=min(DAY);
646                DAY_max=max(DAY);
647                if sign(DAY_min)~=sign(DAY_max);% =1 for increasing values, 0 otherwise
648                     errormsg=['errror in plot_field.m: non monotonic dimension variable ' Data.ListVarName{VarType.coord(1)} ];
649                      return
650                end
651                test_interp_Y=(DAY_max-DAY_min)> 0.0001*abs(DAY_max);
652            end
653            if numel(AX)>2
654                DAX=diff(AX);
655                DAX_min=min(DAX);
656                DAX_max=max(DAX);
657                if sign(DAX_min)~=sign(DAX_max);% =1 for increasing values, 0 otherwise
658                     errormsg=['errror in plot_field.m: non monotonic dimension variable ' Data.ListVarName{VarType.coord(2)} ];
659                      return
660                end
661                test_interp_X=(DAX_max-DAX_min)> 0.0001*abs(DAX_max);
662            end 
663            if test_interp_Y         
664                npxy(1)=max([256 floor((AY(end)-AY(1))/DAY_min) floor((AY(end)-AY(1))/DAY_max)]);
665                yI=linspace(AY(1),AY(end),npxy(1));
666                if ~test_interp_X
667                    xI=linspace(AX(1),AX(end),size(A,2));%default
668                    AX=xI;
669                end
670            end
671            if test_interp_X 
672                npxy(2)=max([256 floor((AX(end)-AX(1))/DAX_min) floor((AX(end)-AX(1))/DAX_max)]);
673                xI=linspace(AX(1),AX(end),npxy(2));   
674                if ~test_interp_Y
675                   yI=linspace(AY(1),AY(end),size(A,1));
676                   AY=yI;
677                end
678            end
679            if test_interp_X || test_interp_Y               
680                [AX2D,AY2D]=meshgrid(AX,AY);
681                A=interp2(AX2D,AY2D,double(A),xI,yI');
682            end
683            AX=[AX(1) AX(end)];% keep only the lower and upper bounds for image represnetation
684            AY=[AY(1) AY(end)];
685        else
686            errormsg='error in plot_field: invalid coordinate definition ';
687            return
688        end
689    end
690    %define coordinates as CoordUnits, if not defined as attribute for each variable
691    if isfield(Data,'CoordUnit')
692        if isempty(x_units)
693            x_units=Data.CoordUnit;
694        end
695        if isempty(y_units)
696            y_units=Data.CoordUnit;
697        end
698    end
699       
700end
701
702%%   image or scalar plot %%%%%%%%%%%%%%%%%%%%%%%%%%
703
704if isfield(PlotParam.Scalar,'ListContour')
705    CheckContour=strcmp(PlotParam.Scalar.ListContour,'contours');
706else
707    CheckContour=0; %default
708end
709PlotParamOut=PlotParam; %default
710if test_ima
711    % distinguish B/W and color images
712    np=size(A);%size of image
713    siz=numel(np);
714    if siz>3
715        errormsg=['unrecognized scalar type: ' num2str(siz) ' dimensions'];
716        return
717    end
718    if siz==3
719        if np(3)==1
720            siz=2;%B W image
721        elseif np(3)==3
722            siz=3;%color image
723        else
724            errormsg=['unrecognized scalar type in plot_field: considered as 2D field with ' num2str(np(3)) ' color components'];
725            return
726        end
727    end
728   
729    %set the color map
730    if isfield(PlotParam.Scalar,'CheckBW') && ~isempty(PlotParam.Scalar.CheckBW)
731        BW=PlotParam.Scalar.CheckBW; %BW=0 color imposed, else gray scale imposed.
732    else % BW imposed automatically chosen
733        BW=(siz==2) && (isa(A,'uint8')|| isa(A,'uint16'));% non color images represented in gray scale by default
734        PlotParamOut.Scalar.CheckBW=BW;
735    end
736    %case of grey level images or contour plot
737    if siz==2
738        if ~isfield(PlotParam.Scalar,'CheckFixScalar')
739            PlotParam.Scalar.CheckFixScalar=0;%default
740        end
741        if ~isfield(PlotParam.Scalar,'MinA')
742            PlotParam.Scalar.MinA=[];%default
743        end
744        if ~isfield(PlotParam.Scalar,'MaxA')
745            PlotParam.Scalar.MaxA=[];%default
746        end
747        Aline=[];
748        if ~PlotParam.Scalar.CheckFixScalar ||isempty(PlotParam.Scalar.MinA)||~isa(PlotParam.Scalar.MinA,'double')  %correct if there is no numerical data in edit box
749            Aline=reshape(A,1,[]);
750            Aline=Aline(~isnan(A));
751            if isempty(Aline)
752                errormsg='NaN input scalar or image in plot_field';
753                return
754            end
755            MinA=double(min(Aline));
756        else
757            MinA=PlotParam.Scalar.MinA;
758        end;
759        if ~PlotParam.Scalar.CheckFixScalar||isempty(PlotParam.Scalar.MaxA)||~isa(PlotParam.Scalar.MaxA,'double') %correct if there is no numerical data in edit box
760            if isempty(Aline)
761                Aline=reshape(A,1,[]);
762                Aline=Aline(~isnan(A));
763                if isempty(Aline)
764                    errormsg='NaN input scalar or image in plot_field';
765                    return
766                end
767            end
768            MaxA=double(max(Aline));
769        else
770            MaxA=PlotParam.Scalar.MaxA;
771        end;
772        PlotParamOut.Scalar.MinA=MinA;
773        PlotParamOut.Scalar.MaxA=MaxA;
774        % case of contour plot
775        if CheckContour
776            if ~isempty(hima) && ishandle(hima)
777                delete(hima)
778            end
779            if ~isfield(PlotParam.Scalar,'IncrA')
780                PlotParam.Scalar.IncrA=NaN;
781            end
782            if isempty(PlotParam.Scalar.IncrA)|| isnan(PlotParam.Scalar.IncrA)% | PlotParam.Scalar.AutoScal==0
783                cont=colbartick(MinA,MaxA);
784                intercont=cont(2)-cont(1);%default
785                PlotParamOut.Scalar.IncrA=intercont;
786            else
787                intercont=PlotParam.Scalar.IncrA;
788            end
789            B=A;
790            abscontmin=intercont*floor(MinA/intercont);
791            abscontmax=intercont*ceil(MaxA/intercont);
792            contmin=intercont*floor(min(min(B))/intercont);
793            contmax=intercont*ceil(max(max(B))/intercont);
794            cont_pos_plus=0:intercont:contmax;
795            cont_pos_min=double(contmin):intercont:-intercont;
796            cont_pos=[cont_pos_min cont_pos_plus];
797            sizpx=(AX(end)-AX(1))/(np(2)-1);
798            sizpy=(AY(1)-AY(end))/(np(1)-1);
799            x_cont=AX(1):sizpx:AX(end); % pixel x coordinates for image display
800            y_cont=AY(1):-sizpy:AY(end); % pixel x coordinates for image display
801            % axes(haxes)% set the input axes handle as current axis
802            txt=ver('MATLAB');
803            Release=txt.Release;
804            relnumb=str2double(Release(3:4));
805            if relnumb >= 14
806                vec=linspace(0,1,(abscontmax-abscontmin)/intercont);%define a greyscale colormap with steps intercont
807                map=[vec' vec' vec'];
808                colormap(map);
809                [var,hcontour]=contour(x_cont,y_cont,B,cont_pos);
810                set(hcontour,'Fill','on')
811                set(hcontour,'LineStyle','none')
812                hold on
813            end
814            [var_p,hcontour_p]=contour(x_cont,y_cont,B,cont_pos_plus,'k-');
815            hold on
816            [var_m,hcontour_m]=contour(x_cont,y_cont,B,cont_pos_min,':');
817            set(hcontour_m,'LineColor',[1 1 1])
818            hold off
819            caxis([abscontmin abscontmax])
820            colormap(map);
821            if isfield(PlotParam.Coordinates,'CheckFixAspectRatio') && isequal(PlotParam.Coordinates.CheckFixAspectRatio,1)
822                set(haxes,'DataAspectRatioMode','manual')
823                if isfield(PlotParam.Coordinates,'AspectRatio')
824                    set(haxes,'DataAspectRatio',[PlotParam.Coordinates.AspectRatio 1 1])
825                else
826                    set(haxes,'DataAspectRatio',[1 1 1])
827                end
828            end
829        end
830       
831        % set  colormap for  image display
832        if ~CheckContour
833            % rescale the grey levels with min and max, put a grey scale colorbar
834            B=A;
835            if BW
836                vec=linspace(0,1,255);%define a linear greyscale colormap
837                map=[vec' vec' vec'];
838                colormap(map);  %grey scale color map
839            else
840                colormap('default'); % standard faulse colors for div, vort , scalar fields
841            end
842        end
843       
844        % case of color images
845    else
846        if BW
847            B=uint16(sum(A,3));
848        else
849            B=uint8(A);
850        end
851        MinA=0;
852        MaxA=255;
853    end
854   
855    % display usual image
856    if ~CheckContour
857        % interpolate field to increase resolution of image display
858        test_interp=1;
859        if max(np) <= 64
860            npxy=8*np;% increase the resolution 8 times
861        elseif max(np) <= 128
862            npxy=4*np;% increase the resolution 4 times
863        elseif max(np) <= 256
864            npxy=2*np;% increase the resolution 2 times
865        else
866            npxy=np;
867            test_interp=0; % no interpolation done
868        end
869        if test_interp==1%if we interpolate
870            x=linspace(AX(1),AX(2),np(2));
871            y=linspace(AY(1),AY(2),np(1));
872            [X,Y]=meshgrid(x,y);
873            xi=linspace(AX(1),AX(2),npxy(2));
874            yi=linspace(AY(1),AY(2),npxy(1));
875            B = interp2(X,Y,double(B),xi,yi');
876        end
877        % create new image if there  no image handle is found
878        if isempty(hima)
879            tag=get(haxes,'Tag');
880            if MinA<MaxA
881                hima=imagesc(AX,AY,B,[MinA MaxA]);
882            else % to deal with uniform field
883                hima=imagesc(AX,AY,B,[MaxA-1 MaxA]);
884            end
885            % the function imagesc reset the axes 'DataAspectRatioMode'='auto', change if .CheckFixAspectRatio is
886            % requested:
887            set(hima,'Tag','ima')
888            set(hima,'HitTest','off')
889            set(haxes,'Tag',tag);%preserve the axes tag (removed by image fct !!!)
890            uistack(hima, 'bottom')
891            % update an existing image
892        else
893            set(hima,'CData',B);
894            if MinA<MaxA
895                set(haxes,'CLim',[MinA MaxA])
896            else
897                set(haxes,'CLim',[MinA MaxA+1])
898            end
899            set(hima,'XData',AX);
900            set(hima,'YData',AY);
901        end
902
903        % set the transparency to 0.5 if vectors are also plotted
904        if isfield(PlotParam.Scalar,'Opacity')&& ~isempty(PlotParam.Scalar.Opacity)
905            set(hima,'AlphaData',PlotParam.Scalar.Opacity)
906        else
907            if test_vec
908                set(hima,'AlphaData',0.5)%set opacity to 0.5 by default in the presence of vectors
909                PlotParamOut.Scalar.Opacity=0.5;
910            else
911                set(hima,'AlphaData',1)% full opacity (no transparency) by default
912            end
913        end
914    end
915    test_ima=1;
916   
917    %display the colorbar code for B/W images if Poscolorbar not empty
918    if siz==2 && exist('PosColorbar','var')&& ~isempty(PosColorbar)
919        if isempty(hcol)||~ishandle(hcol)
920            hcol=colorbar;%create new colorbar
921        end
922        if length(PosColorbar)==4
923            set(hcol,'Position',PosColorbar)
924        end
925        %YTick=0;%default
926        if MaxA>MinA
927            if CheckContour
928                colbarlim=get(hcol,'YLim');
929                scale_bar=(colbarlim(2)-colbarlim(1))/(abscontmax-abscontmin);
930                YTick=cont_pos(2:end-1);
931                YTick_scaled=colbarlim(1)+scale_bar*(YTick-abscontmin);
932                set(hcol,'YTick',YTick_scaled);
933            elseif (isfield(PlotParam.Scalar,'CheckBW') && isequal(PlotParam.Scalar.CheckBW,1))||isa(A,'uint8')|| isa(A,'uint16')%images
934                hi=get(hcol,'children');
935                if iscell(hi)%multiple images in colorbar
936                    hi=hi{1};
937                end
938                set(hi,'YData',[MinA MaxA])
939                set(hi,'CData',(1:256)')
940                set(hcol,'YLim',[MinA MaxA])
941                YTick=colbartick(MinA,MaxA);
942                set(hcol,'YTick',YTick)
943            else
944                hi=get(hcol,'children');
945                if iscell(hi)%multiple images in colorbar
946                    hi=hi{1};
947                end
948                set(hi,'YData',[MinA MaxA])
949                set(hi,'CData',(1:64)')
950                YTick=colbartick(MinA,MaxA);
951                set(hcol,'YLim',[MinA MaxA])
952                set(hcol,'YTick',YTick)
953            end
954            set(hcol,'Yticklabel',num2str(YTick'));
955        end
956    elseif ishandle(hcol)
957        delete(hcol); %erase existing colorbar if not needed
958    end
959else%no scalar plot
960    if ~isempty(hima) && ishandle(hima)
961        delete(hima)
962    end
963    if ~isempty(hcol)&& ishandle(hcol)
964        delete(hcol)
965    end
966    PlotParamOut=rmfield(PlotParamOut,'Scalar');
967end
968
969%%   vector plot %%%%%%%%%%%%%%%%%%%%%%%%%%
970if test_vec
971   %vector scale representation
972    if size(vec_U,1)==numel(vec_Y) && size(vec_U,2)==numel(vec_X); % x, y  coordinate variables
973        [vec_X,vec_Y]=meshgrid(vec_X,vec_Y);
974    end   
975    vec_X=reshape(vec_X,1,numel(vec_X));%reshape in matlab vectors
976    vec_Y=reshape(vec_Y,1,numel(vec_Y));
977    vec_U=reshape(vec_U,1,numel(vec_U));
978    vec_V=reshape(vec_V,1,numel(vec_V));
979     MinMaxX=max(vec_X)-min(vec_X);
980    if  isfield(PlotParam.Vectors,'CheckFixVectors') && isequal(PlotParam.Vectors.CheckFixVectors,1)&& isfield(PlotParam.Vectors,'VecScale')...
981               &&~isempty(PlotParam.Vectors.VecScale) && isa(PlotParam.Vectors.VecScale,'double') %fixed vector scale
982        scale=PlotParam.Vectors.VecScale;  %impose the length of vector representation
983    else
984        if ~test_false %remove false vectors   
985            indsel=1:numel(vec_X);%
986        end
987        if isempty(vec_U)
988            scale=1;
989        else
990            if isempty(indsel)
991                MaxU=max(abs(vec_U));
992                MaxV=max(abs(vec_V));
993            else
994                MaxU=max(abs(vec_U(indsel)));
995                MaxV=max(abs(vec_V(indsel)));
996            end
997            scale=MinMaxX/(max(MaxU,MaxV)*50);
998            PlotParam.Vectors.VecScale=scale;%update the 'scale' display
999        end
1000    end
1001   
1002    %record vectors on the plotting axes
1003    if test_C==0
1004        vec_C=ones(1,numel(vec_X));
1005    end
1006   
1007    %decimate by a factor 2 in vector mesh(4 in nbre of vectors)
1008    if isfield(PlotParam.Vectors,'CheckDecimate4') && PlotParam.Vectors.CheckDecimate4
1009        diffy=diff(vec_Y); %difference dy=vec_Y(i+1)-vec_Y(i)
1010        dy_thresh=max(abs(diffy))/2;
1011        ind_jump=find(abs(diffy) > dy_thresh); %indices with diff(vec_Y)> max/2, detect change of line
1012        ind_sel=1:ind_jump(1);%select the first line
1013        for i=2:2:length(ind_jump)-1
1014            ind_sel=[ind_sel (ind_jump(i)+1:ind_jump(i+1))];% select the odd lines
1015        end
1016        nb_sel=length(ind_sel);
1017        ind_sel=ind_sel(1:2:nb_sel);% take half the points on a line
1018        vec_X=vec_X(ind_sel);
1019        vec_Y=vec_Y(ind_sel);
1020        vec_U=vec_U(ind_sel);
1021        vec_V=vec_V(ind_sel);
1022        vec_C=vec_C(ind_sel);
1023        if ~isempty(ivar_F)
1024           vec_F=vec_F(ind_sel);
1025        end
1026        if ~isempty(ivar_FF)
1027           vec_FF=vec_FF(ind_sel);
1028        end
1029    end
1030   
1031    %get main level color code
1032    [colorlist,col_vec,PlotParamOut.Vectors]=set_col_vec(PlotParam.Vectors,vec_C);
1033   
1034    % take flags into account: add flag colors to the list of colors
1035    sizlist=size(colorlist);
1036    nbcolor=sizlist(1);
1037    if test_black
1038       nbcolor=nbcolor+1;
1039       colorlist(nbcolor,:)=[0 0 0]; %add black to the list of colors
1040       if ~isempty(ivar_FF)
1041          %  ind_flag=find(vec_F~=1 & vec_F~=0 & vec_FF==0);  %flag warning but not false
1042            col_vec(vec_F~=1 & vec_F~=0 & vec_FF==0)=nbcolor;
1043       else
1044            col_vec(vec_F~=1 & vec_F~=0)=nbcolor;
1045       end
1046    end
1047    nbcolor=nbcolor+1;
1048    if ~isempty(ivar_FF)
1049        if isfield(PlotParam.Vectors,'CheckHideFalse') && PlotParam.Vectors.CheckHideFalse==1
1050            colorlist(nbcolor,:)=[NaN NaN NaN];% no plot of false vectors
1051        else
1052            colorlist(nbcolor,:)=[1 0 1];% magenta color
1053        end
1054        col_vec(vec_FF~=0)=nbcolor;
1055    end
1056    %plot vectors:
1057    quiresetn(haxes,vec_X,vec_Y,vec_U,vec_V,scale,colorlist,col_vec);   
1058
1059else
1060    hvec=findobj(haxes,'Tag','vel');
1061    if ~isempty(hvec)
1062        delete(hvec);
1063    end
1064    PlotParamOut=rmfield(PlotParamOut,'Vectors');
1065end
1066
1067%listfields={'AY','AX','A','X','Y','U','V','C','W','F','FF'};
1068%listdim={'AY','AX',{'AY','AX'},'nb_vectors','nb_vectors','nb_vectors','nb_vectors','nb_vectors','nb_vectors','nb_vectors','nb_vectors'};
1069%Role={'coord_y','coord_x','scalar','coord_x','coord_y','vector_x','vector_y','scalar','vector_z','warnflag','errorflag'};
1070%ind_select=[];
1071nbvar=0;
1072
1073%store the coordinate extrema occupied by the field
1074if ~isempty(Data)
1075    XMin=[];
1076    XMax=[];
1077    YMin=[];
1078    YMax=[];
1079    fix_lim=isfield(PlotParam.Coordinates,'CheckFixLimits') && PlotParam.Coordinates.CheckFixLimits;
1080    if fix_lim
1081        if isfield(PlotParam.Coordinates,'MinX')&&isfield(PlotParam.Coordinates,'MaxX')&&isfield(PlotParam.Coordinates,'MinY')&&isfield(PlotParam.Coordinates,'MaxY')
1082            XMin=PlotParam.Coordinates.MinX;
1083            XMax=PlotParam.Coordinates.MaxX;
1084            YMin=PlotParam.Coordinates.MinY;
1085            YMax=PlotParam.Coordinates.MaxY;
1086        end  %else PlotParamOut.XMin =PlotParam.XMin...
1087    else
1088        if test_ima %both background image and vectors coexist, take the wider bound
1089            XMin=min(AX);
1090            XMax=max(AX);
1091            YMin=min(AY);
1092            YMax=max(AY);
1093            if test_vec
1094                XMin=min(XMin,min(vec_X));
1095                XMax=max(XMax,max(vec_X));
1096                YMin=min(YMin,min(vec_Y));
1097                YMax=max(YMax,max(vec_Y));
1098            end
1099        elseif test_vec
1100            XMin=min(vec_X);
1101            XMax=max(vec_X);
1102            YMin=min(vec_Y);
1103            YMax=max(vec_Y);
1104        end
1105    end
1106%     PlotParamOut.RangeX=[XMin XMax]; %range of x, to be stored in the user data of the plot axes
1107%     PlotParamOut.RangeY=[YMin YMax]; %range of x, to be stored in the user data of the plot axes
1108%     if ~fix_lim
1109        PlotParamOut.Coordinates.MinX=XMin;
1110        PlotParamOut.Coordinates.MaxX=XMax;
1111        PlotParamOut.Coordinates.MinY=YMin;
1112        PlotParamOut.Coordinates.MaxY=YMax;
1113        if XMax>XMin
1114            set(haxes,'XLim',[XMin XMax]);% set x limits of frame in axes coordinates
1115        end
1116        if YMax>YMin
1117            set(haxes,'YLim',[YMin YMax]);% set x limits of frame in axes coordinates
1118        end
1119%     end
1120    set(haxes,'YDir','normal')
1121    set(get(haxes,'XLabel'),'String',[XName ' (' x_units ')']);
1122    set(get(haxes,'YLabel'),'String',[YName ' (' y_units ')']);
1123    PlotParamOut.Coordinates.x_units=x_units;
1124    PlotParamOut.Coordinates.y_units=y_units;
1125end
1126        if isfield(PlotParam,'Coordinates') && isfield(PlotParam.Coordinates,'CheckFixAspectRatio') && isequal(PlotParam.Coordinates.CheckFixAspectRatio,1)
1127            set(haxes,'DataAspectRatioMode','manual')
1128            if isfield(PlotParam.Coordinates,'AspectRatio')
1129                set(haxes,'DataAspectRatio',[PlotParam.Coordinates.AspectRatio 1 1])
1130            end
1131        else
1132            set(haxes,'DataAspectRatioMode','auto')
1133        end
1134%-------------------------------------------------------------------
1135% --- function for plotting vectors
1136%INPUT:
1137% haxes: handles of the plotting axes
1138% x,y,u,v: vectors coordinates and vector components to plot, arrays withb the same dimension
1139% scale: scaling factor for vector length representation
1140% colorlist(icolor,:): list of vector colors, dim (nbcolor,3), depending on color #i
1141% col_vec: matlab vector setting the color number #i for each velocity vector
1142function quiresetn(haxes,x,y,u,v,scale,colorlist,col_vec)
1143%-------------------------------------------------------------------
1144%define arrows
1145theta=0.5 ;%angle arrow
1146alpha=0.3 ;%length arrow
1147rot=alpha*[cos(theta) -sin(theta); sin(theta) cos(theta)]';
1148%find the existing lines
1149h=findobj(haxes,'Tag','vel');% search existing lines in the current axes
1150sizh=size(h);
1151set(h,'EraseMode','xor');
1152set(haxes,'NextPlot','replacechildren');
1153
1154%drawnow
1155%create lines (if no lines) or modify them
1156if ~isequal(size(col_vec),size(x))
1157    col_vec=ones(size(x));% case of error in col_vec input
1158end
1159sizlist=size(colorlist);
1160ncolor=sizlist(1);
1161
1162for icolor=1:ncolor
1163    %determine the line positions for each color icolor
1164    ind=find(col_vec==icolor);
1165    xc=x(ind);
1166    yc=y(ind);
1167    uc=u(ind)*scale;
1168    vc=v(ind)*scale;
1169    n=size(xc);
1170    xN=NaN*ones(size(xc));
1171    matx=[xc(:)-uc(:)/2 xc(:)+uc(:)/2 xN(:)]';
1172    matx=reshape(matx,1,3*n(2));
1173    maty=[yc(:)-vc(:)/2 yc(:)+vc(:)/2 xN(:)]';
1174    maty=reshape(maty,1,3*n(2));
1175   
1176    %determine arrow heads
1177    arrowplus=rot*[uc;vc];
1178    arrowmoins=rot'*[uc;vc];
1179    x1=xc+uc/2-arrowplus(1,:);
1180    x2=xc+uc/2;
1181    x3=xc+uc/2-arrowmoins(1,:);
1182    y1=yc+vc/2-arrowplus(2,:);
1183    y2=yc+vc/2;
1184    y3=yc+vc/2-arrowmoins(2,:);
1185    matxar=[x1(:) x2(:) x3(:) xN(:)]';
1186    matxar=reshape(matxar,1,4*n(2));
1187    matyar=[y1(:) y2(:) y3(:) xN(:)]';
1188    matyar=reshape(matyar,1,4*n(2));
1189    %draw the line or modify the existing ones
1190%     tri=reshape(1:3*length(uc),3,[])';   
1191    isn=isnan(colorlist(icolor,:));%test if color NaN
1192    if 2*icolor > sizh(1) %if icolor exceeds the number of existing ones
1193        if ~isn(1) %if the vectors are visible color not nan
1194            if n(2)>0
1195                hold on
1196                line(matx,maty,'Color',colorlist(icolor,:),'Tag','vel');% plot new lines
1197                line(matxar,matyar,'Color',colorlist(icolor,:),'Tag','vel');% plot arrows
1198            end
1199        end
1200    else
1201        if isn(1)
1202            delete(h(2*icolor-1))
1203            delete(h(2*icolor))
1204        else
1205            set(h(2*icolor-1),'Xdata',matx,'Ydata',maty);
1206            set(h(2*icolor-1),'Color',colorlist(icolor,:));
1207            set(h(2*icolor-1),'EraseMode','xor');
1208            set(h(2*icolor),'Xdata',matxar,'Ydata',matyar);
1209            set(h(2*icolor),'Color',colorlist(icolor,:));
1210            set(h(2*icolor),'EraseMode','xor');
1211        end
1212    end
1213end
1214if sizh(1) > 2*ncolor
1215    for icolor=ncolor+1 : sizh(1)/2%delete additional objects
1216        delete(h(2*icolor-1))
1217        delete(h(2*icolor))
1218    end
1219end
1220
1221%-------------------------------------------------------------------
1222% ---- determine tick positions for colorbar
1223function YTick=colbartick(MinA,MaxA)
1224%-------------------------------------------------------------------
1225%determine tick positions with "simple" values between MinA and MaxA
1226YTick=0;%default
1227maxabs=max([abs(MinA) abs(MaxA)]);
1228if maxabs>0
1229ord=10^(floor(log10(maxabs)));%order of magnitude
1230div=1;
1231siz2=1;
1232while siz2<2
1233    values=-10:div:10;
1234    ind=find((ord*values-MaxA)<0 & (ord*values-MinA)>0);%indices of 'values' such that MinA<ord*values<MaxA
1235    siz=size(ind);
1236    if siz(2)<4%if there are less than 4 selected values (4 levels)
1237        values=-9:0.5*div:9;
1238        ind=find((ord*values-MaxA)<0 & (ord*values-MinA)>0);
1239    end
1240    siz2=size(ind,2);
1241    div=div/10;
1242end
1243YTick=ord*values(ind);
1244end
1245
1246% -------------------------------------------------------------------------
1247% --- 'proj_grid': project  fields with unstructured coordinantes on a regular grid
1248function [A,rangx,rangy]=proj_grid(vec_X,vec_Y,vec_A,rgx_in,rgy_in,npxy_in)
1249% -------------------------------------------------------------------------
1250if length(vec_Y)<2
1251    msgbox_uvmat('ERROR','less than 2 points in proj_grid.m');
1252    return;
1253end
1254diffy=diff(vec_Y); %difference dy=vec_Y(i+1)-vec_Y(i)
1255index=find(diffy);% find the indices of vec_Y after wich a change of horizontal line occurs(diffy non zero)
1256if isempty(index); msgbox_uvmat('ERROR','points aligned along abscissa in proj_grid.m'); return; end;%points aligned% A FAIRE: switch to line plot.
1257diff2=diff(diffy(index));% diff2 = fluctuations of the detected vertical grid mesh dy
1258if max(abs(diff2))>0.001*abs(diffy(index(1))) % if max(diff2) is larger than 1/1000 of the first mesh dy
1259    % the data are not regularly spaced and must be interpolated  on a regular grid
1260    if exist('rgx_in','var') & ~isempty (rgx_in) & isnumeric(rgx_in) & length(rgx_in)==2%  positions imposed from input
1261        rangx=rgx_in; % first and last positions
1262        rangy=rgy_in;
1263        dxy(1)=1/(npxy_in(1)-1);%grid mesh in y
1264        dxy(2)=1/(npxy_in(2)-1);%grid mesh in x
1265        dxy(1)=(rangy(2)-rangy(1))/(npxy_in(1)-1);%grid mesh in y
1266        dxy(2)=(rangx(2)-rangx(1))/(npxy_in(2)-1);%grid mesh in x
1267    else % interpolation grid automatically determined
1268        rangx(1)=min(vec_X);
1269        rangx(2)=max(vec_X);
1270        rangy(2)=min(vec_Y);
1271        rangy(1)=max(vec_Y);
1272        dxymod=sqrt((rangx(2)-rangx(1))*(rangy(1)-rangy(2))/length(vec_X));
1273        dxy=[-dxymod/4 dxymod/4];% increase the resolution 4 times
1274    end
1275    xi=[rangx(1):dxy(2):rangx(2)];
1276    yi=[rangy(1):dxy(1):rangy(2)];
1277    A=griddata_uvmat(vec_X,vec_Y,vec_A,xi,yi');
1278    A=reshape(A,length(yi),length(xi));
1279else
1280    x=vec_X(1:index(1));% the set of abscissa (obtained on the first line)
1281    indexend=index(end);% last vector index of line change
1282    ymax=vec_Y(indexend+1);% y coordinate AFTER line change
1283    ymin=vec_Y(index(1));
1284    y=vec_Y(index);
1285    y(length(y)+1)=ymax;
1286    nx=length(x);   %number of grid points in x
1287    ny=length(y);   % number of grid points in y
1288    B=(reshape(vec_A,nx,ny))'; %vec_A reshaped as a rectangular matrix
1289    [X,Y]=meshgrid(x,y);% positions X and Y also reshaped as matrix
1290
1291    %linear interpolation to improve the image resolution and/or adjust
1292    %to prescribed positions
1293    test_interp=1;
1294    if exist('rgx_in','var') & ~isempty (rgx_in) & isnumeric(rgx_in) & length(rgx_in)==2%  positions imposed from input
1295        rangx=rgx_in; % first and last positions
1296        rangy=rgy_in;
1297        npxy=npxy_in;
1298    else       
1299        rangx=[vec_X(1) vec_X(nx)];% first and last position found for x
1300          rangy=[max(ymax,ymin) min(ymax,ymin)];
1301        if max(nx,ny) <= 64 & isequal(npxy_in,'np>256')
1302            npxy=[8*ny 8*nx];% increase the resolution 8 times
1303        elseif max(nx,ny) <= 128 & isequal(npxy_in,'np>256')
1304            npxy=[4*ny 4*nx];% increase the resolution 4 times
1305        elseif max(nx,ny) <= 256 & isequal(npxy_in,'np>256')
1306            npxy=[2*ny 2*nx];% increase the resolution 2 times
1307        else
1308            npxy=[ny nx];
1309            test_interp=0; % no interpolation done
1310        end
1311    end
1312    if test_interp==1%if we interpolate
1313        xi=[rangx(1):(rangx(2)-rangx(1))/(npxy(2)-1):rangx(2)];
1314        yi=[rangy(1):(rangy(2)-rangy(1))/(npxy(1)-1):rangy(2)];
1315        [XI,YI]=meshgrid(xi,yi);
1316        A = interp2(X,Y,B,XI,YI);
1317    else %no interpolation for a resolution higher than 256
1318        A=B;
1319    end
1320end
Note: See TracBrowser for help on using the repository browser.