source: trunk/src/plot_field.m @ 429

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

improvements in object drawing and projection on points

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