source: trunk/src/find_field_cells.m @ 582

Last change on this file since 582 was 582, checked in by sommeria, 8 years ago

various bugs corrected

File size: 16.6 KB
Line 
1%'find_field_cells': analyse the field structure for input in uvmat functions, grouping the variables  into 'fields' with common coordinates
2%------------------------------------------------------------------------
3% function  [CellInfo,NbDim,errormsg]=find_field_cells(Data)
4%
5% OUTPUT:
6% CellInfo: cell of structures describing field cells
7%     .CoordType:  type of coordinates for each field cell = 'scattered','grid','tps';
8%     .CoordIndex: array of the indices of the variables representing the coordinates (in the order z,y,x)
9%     .CoordSize: array of the nbre of values for each  coordinate in a grid, nbre of points in the unstructured case
10%     .NbCentres_tps:
11%     .SubRange_tps
12%     .VarIndex: arrays of the variable indices in the field cell
13%     .VarIndex_ancillary: indices of ancillary variables
14%              _color : color image, the last index, which is not a coordinate variable, represent the 3 color components rgb
15%              _discrete: like scalar, but set of data points without continuity, represented as dots in a usual plot, instead of continuous lines otherwise
16%              _errorflag: index of error flag
17%              _image   : B/W image, (behaves like scalar)
18%              _vector_x,_y,_z: indices of variables giving the vector components x, y, z
19%              _warnflag: index of warnflag   
20%      .ProjModeRequest= 'interp_lin', 'interp_tps' indicate whether lin interpolation  or derivatives (tps) is needed to calculate the requested field
21%      .FieldName = operation to be performed to finalise the field cell after projection
22%      .SubCheck=0 /1 indicate that the field must be substracted (second  entry in uvmat)
23% NbDim: array with the length of CellVarIndex, giving the space dimension of each field cell
24% errormsg: error message
25%   
26% INPUT:
27% Data: structure representing fields, output of check_field_structure
28%            .ListGlobalAttributes
29%            .ListVarName: cell array listing the names (cahr strings) of the variables
30%            .VarDimName: cell array of cells containing the set of dimension names for each variable of .ListVarName
31%            .VarAttribute: cell array of structures containing the variable attributes:
32%                     .VarAttribute{ilist}.key=value, where ilist is the variable
33%                     index, key is the name of the attribute, value its value (char string or number)
34%            .Attr1, .Attr2....
35%        case of actual data:
36%            .Var1, .Var2...
37%        case of data structure, without the  data themselves
38%            .LisDimName: list of dimension names
39%            .DimValue: list of corresponding dimension values
40% HELP:
41% to get the dimensions of arrays common to the field #icell
42%         VarIndex=CellVarIndex{icell}; % list of variable indices
43%         DimIndex=Data.VarDimIndex{VarIndex(1)} % list of dimensions for each variable in the cell #icell
44%
45%AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
46%  Copyright Joel Sommeria, 2008, LEGI / CNRS-UJF-INPG, sommeria@coriolis-legi.org.
47%AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
48%     This file is part of the toolbox UVMAT.
49%
50%     UVMAT is free software; you can redistribute it and/or modify
51%     it under the terms of the GNU General Public License as published by
52%     the Free Software Foundation; either version 2 of the License, or
53%     (at your option) any later version.
54%
55%     UVMAT is distributed in the hope that it will be useful,
56%     but WITHOUT ANY WARRANTY; without even the implied warranty of
57%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
58%     GNU General Public License (file UVMAT/COPYING.txt) for more details.for input in proj_field and plot_field
59%    group the variables  into 'fields' with common dimensions
60
61function [CellInfo,NbDim,errormsg]=find_field_cells(Data)
62CellInfo={};
63NbDim=0;
64errormsg='';
65if ~isfield(Data,'ListVarName'), errormsg='the list of variables .ListVarName is missing';return;end
66if ~isfield(Data,'VarDimName'), errormsg='the list of dimensions .VarDimName is missing';return;end
67nbvar=numel(Data.ListVarName);%number of variables in the field structure
68if ~isequal(numel(Data.VarDimName),nbvar), errormsg='.ListVarName and .VarDimName have unequal length';return;end
69% check the existence of variable data
70check_var=1;
71for ilist=1:numel(Data.ListVarName)
72    if ~isfield(Data,Data.ListVarName{ilist})
73        check_var=0;% dimensions of data defined, data not needed for this function
74        break
75    end
76end
77if ~check_var &&  ~(isfield(Data,'ListDimName')&& isfield(Data,'DimValue')&&isequal(numel(Data.ListDimName),numel(Data.DimValue)))
78    errormsg=['missing variable or values of dimensions' Data.ListVarName{ilist}];
79    return
80end
81
82
83%% role of variables and list of requested operations
84%ListRole={'coord_x','coord_y','coord_z','vector_x','vector_y','vector_z','vector_x_tps','vector_y_tps','warnflag','errorflag',...
85%   'ancillary','image','color','discrete','scalar','coord_tps'};% rmq vector_x_tps and vector_y_tps to be replaced by vector_x and vector_y
86Role=num2cell(blanks(nbvar));%initialize a cell array of nbvar blanks
87ProjModeRequest=regexprep(Role,' ',''); % fieldRequest set to '' by default
88FieldName=cell(size(Role)); % fieldRequest set to {} by default
89CheckSub=zeros(size(Role));% =1 for fields to substract
90Role=regexprep(Role,' ','scalar'); % Role set to 'scalar' by default
91if isfield(Data,'VarAttribute')
92    for ivar=1:numel(Data.VarAttribute)
93        if isfield(Data.VarAttribute{ivar},'Role')
94            Role{ivar}=Data.VarAttribute{ivar}.Role;
95        end
96        if isfield(Data.VarAttribute{ivar},'ProjModeRequest')
97            ProjModeRequest{ivar}=Data.VarAttribute{ivar}.ProjModeRequest;
98        end
99        if isfield(Data.VarAttribute{ivar},'FieldName')
100            FieldName{ivar}=Data.VarAttribute{ivar}.FieldName;
101        end
102        if isfield(Data.VarAttribute{ivar},'CheckSub')
103            CheckSub(ivar)=Data.VarAttribute{ivar}.CheckSub;
104        end
105    end
106end
107
108%% find scattered (unstructured) coordinates
109ivar_coord_x=find(strcmp('coord_x',Role));
110% VarDimCell=cell(numel(ivar_coord_x));
111check_select=false(1,nbvar);
112check_coord=false(1,nbvar);
113CellInfo=cell(1,numel(ivar_coord_x));
114NbDim=zeros(1,numel(ivar_coord_x));
115for icell=1:numel(ivar_coord_x)
116    DimCell=Data.VarDimName{ivar_coord_x(icell)};
117    if ischar(DimCell),DimCell={DimCell};end
118    check_cell=zeros(numel(DimCell),nbvar);
119    for idim=1:numel(DimCell)
120        for ivar=1:nbvar
121            check_cell(idim,ivar)=max(strcmp(DimCell{idim},Data.VarDimName{ivar}));
122        end
123    end
124    check_cell=sum(check_cell,1)==numel(DimCell);%logical array=1 for variables belonging to the current cell
125    VarIndex=find(check_cell);
126    if ~(numel(VarIndex)==1 && numel(DimCell)==1)% exclude case of isolated coord_x variable (treated later)
127        if ~(numel(VarIndex)==1 && numel(DimCell)>1)% a variable is associated to coordinate
128            CellInfo{icell}.CoordIndex=ivar_coord_x(icell);
129            % size of coordinate var
130            if check_var
131                CellInfo{icell}.CoordSize=numel(Data.(Data.ListVarName{ivar_coord_x(icell)}));
132            else
133                for idim=1:numel(DimCell)
134                 check_index= strcmp(DimCell{idim},Data.ListDimName);
135                 CellInfo{icell}.CoordSize(idim)=Data.DimValue(check_index);
136                end
137                CellInfo{icell}.CoordSize=prod(CellInfo{icell}.CoordSize);
138            end
139            ind_y=find(strcmp('coord_y',Role(VarIndex)));
140            if numel(VarIndex)==2||isempty(ind_y)% no variable, except possibly y
141                NbDim(icell)=1;
142            else
143                CellInfo{icell}.CoordType='scattered';
144                ind_z=find(strcmp('coord_z',Role(VarIndex)));
145                if numel(VarIndex)==3||isempty(ind_z)% no z variable, except possibly as a fct z(x,y)
146                    CellInfo{icell}.CoordIndex=[VarIndex(ind_y) CellInfo{icell}.CoordIndex];
147                    NbDim(icell)=2;
148                else
149                    CellInfo{icell}.CoordIndex=[VarIndex(ind_z) CellInfo{icell}.CoordIndex];
150                    NbDim(icell)=3;
151                end
152            end
153        end
154        CellInfo{icell}.VarIndex=VarIndex;
155        check_select=check_select|check_cell;
156    end
157end
158
159%% look for tps coordinates
160ivar_remain=find(~check_select);% indices of remaining variables (not already selected)
161check_coord_tps= strcmp('coord_tps',Role(~check_select));
162ivar_tps=ivar_remain(check_coord_tps);% variable indices corresponding to tps coordinates
163
164% loop on the tps coordinate sets
165for icell_tps=1:numel(ivar_tps)
166    check_cell=zeros(1,nbvar);% =1 for the variables selected in the current cell
167    check_cell(ivar_tps(icell_tps))=1;% mark the coordinate variable as selected
168    DimCell=Data.VarDimName{ivar_tps(icell_tps)};% dimension names for the current tps coordinate variable
169    icell=numel(CellInfo)+icell_tps; % new field cell index
170    CellInfo{icell}.CoordIndex=ivar_tps(icell_tps);% index of the  tps coordinate variable
171    if numel(DimCell)==3
172        VarDimName=Data.VarDimName(~check_select);
173        for ivardim=1:numel(VarDimName)
174            if strcmp(VarDimName{ivardim},DimCell{3})
175                CellInfo{icell}.NbCentres_tps= ivar_remain(ivardim);% nbre of sites for each tps subdomain
176                check_cell(ivar_remain(ivardim))=1;% mark the variable as selected
177            elseif strcmp(VarDimName{ivardim}{1},DimCell{2}) && strcmp(VarDimName{ivardim}{3},DimCell{3})
178                CellInfo{icell}.SubRange_tps=ivar_remain(ivardim);% subrange definiton for tps
179                check_cell(ivar_remain(ivardim))=1;% mark the variable as selected
180            elseif strcmp(VarDimName{ivardim}{1},DimCell{1}) && strcmp(VarDimName{ivardim}{2},DimCell{3})% variable
181                check_cell(ivar_remain(ivardim))=1;% mark the variable as selected
182            end
183        end
184    end
185    CellInfo{icell}.CoordType='tps';
186    CellInfo{icell}.VarIndex=find(check_cell);
187    if check_var
188        NbDim(icell)=size(Data.(Data.ListVarName{CellInfo{icell}.CoordIndex}),2);
189        CellInfo{icell}.CoordSize=size(Data.(Data.ListVarName{CellInfo{icell}.CoordIndex}),1)*size(Data.(Data.ListVarName{CellInfo{icell}.CoordIndex}),3);
190    else
191        check_index_1= strcmp(DimCell{1},Data.ListDimName);
192        check_index_2= strcmp(DimCell{2},Data.ListDimName);
193        check_index_3= strcmp(DimCell{3},Data.ListDimName);
194        NbDim(icell)=Data.DimValue(check_index_2);
195        CellInfo{icell}.CoordSize=Data.DimValue(check_index_1)*Data.DimValue(check_index_3);
196    end
197    check_select=check_select|check_cell;
198end
199
200%% look for coordinate variables and corresponding gridded data:
201% coordinate variables are variables associated with a single dimension, defining the coordinate values
202% two cases: 1)the coordiante variable represents the set of coordiante values
203%            2)the coordinate variable contains only two elements, representing the coordinate bounds for the dimension with the same name as the cordinate
204ivar_remain=find(~check_select);% indices of remaining variables, not already taken into account
205ListVarName=Data.ListVarName(~check_select);%list of remaining variables
206VarDimName=Data.VarDimName(~check_select);%dimensions of remaining variables
207check_coord_select= cellfun(@numel,VarDimName)==1|cellfun(@ischar,VarDimName)==1;% find remaining variables with a single dimension
208%check_coord(~check_select)=check_coord_select;
209ListCoordIndex=ivar_remain(check_coord_select);% indices of remaining variables with a single dimension
210ListCoordName=ListVarName(check_coord_select);% corresponding names of remaining variables with a single dimension
211ListDimName=VarDimName(check_coord_select);% dimension names of remaining variables with a single dimension
212
213%remove redondant variables -> keep only one variable per dimension
214check_keep=logical(ones(size(ListDimName)));
215for idim=1:numel(ListDimName)
216    prev_ind=strcmp(ListDimName{idim},ListDimName(1:idim-1));% check whether the dimension is already taken into account
217    if ~isempty(prev_ind)
218        if strcmp(ListCoordName{idim},ListDimName{idim}) %variable with the same name as the coordinate taken in priority
219            check_keep(prev_ind)=0;
220        else
221           check_keep(idim)=0;
222        end
223    end
224end
225ListCoordIndex=ListCoordIndex(check_keep);% list of coordinate variable indices
226ListCoordName=ListCoordName(check_keep);% list of coordinate variable names
227ListDimName=ListDimName(check_keep);% list of coordinate dimension names
228
229% determine dimension sizes
230CoordSize=zeros(size(ListCoordIndex));
231for ilist=1:numel(ListCoordIndex)
232    if iscell(ListDimName{ilist})
233        ListDimName(ilist)=ListDimName{ilist};%transform cell to string
234    end
235    if check_var% if the list of dimensions has been directly defined, no variable data available
236        CoordSize(ilist)=numel(Data.(ListCoordName{ilist}));% number of elements in the variable corresponding to the dimension #ilist
237    else
238        check_index= strcmp(ListDimName{ilist},Data.ListDimName);% find the  index in the list of dimensions
239        CoordSize(ilist)=Data.DimValue(check_index);% find the  corresponding dimension value
240    end
241    if CoordSize(ilist)==2% case of uniform grid coordinate defined by lower and upper bounds only
242        ListDimName{ilist}=ListCoordName{ilist};% replace the dimension name by the coordinate variable name
243    end
244end
245
246% group the remaining variables in cells sharing the same coordinate variables
247NewCellInfo={};
248NewCellDimIndex={};
249NewNbDim=[];
250for ivardim=1:numel(VarDimName) % loop at the list of remaining variables
251    DimCell=VarDimName{ivardim};% dimension names of the current variable
252    if ischar(DimCell), DimCell={DimCell}; end %transform char to cell if needed
253    DimIndices=[];
254    for idim=1:numel(DimCell)
255        ind_dim=find(strcmp(DimCell{idim},ListDimName));%find the dim index in the list of coordinate variables
256        if ~isempty(ind_dim)
257            DimIndices=[DimIndices ind_dim]; %update the list of coord dimensions included in DimCell
258            if check_var && CoordSize(ind_dim)==2 % determine the size of the coordinate in case of coordiante variable limited to lower and upper bounds
259                if isvector(Data.(ListVarName{ivardim}))
260                    if numel(Data.(ListVarName{ivardim}))>2
261                        CoordSize(ind_dim)=numel(Data.(ListVarName{ivardim}));
262                    end
263                else
264                    CoordSize(ind_dim)=size(Data.(ListVarName{ivardim}),idim);
265                end
266            end
267        end
268    end
269    % look for cells of variables with the same coordinate variables
270    check_previous=0;
271    for iprev=1:numel(NewCellInfo)
272        if isequal(DimIndices,NewCellDimIndex{iprev})
273            check_previous=1;
274            NewCellInfo{iprev}.VarIndex=[NewCellInfo{iprev}.VarIndex ivar_remain(ivardim)];%append the current variable index to the found field cell
275            break
276        end
277    end
278    % create a new cell if no previous one contains the coordinate variables
279    if ~check_previous
280        nbcell=numel(NewCellInfo)+1;
281        NewCellDimIndex{nbcell}=DimIndices;
282        NewCellInfo{nbcell}.VarIndex=ivar_remain(ivardim);% create a new field cell with the current variable index
283        NewNbDim(nbcell)=numel(DimIndices);
284        NewCellInfo{nbcell}.CoordType='grid';
285        NewCellInfo{nbcell}.CoordSize=CoordSize;
286        NewCellInfo{nbcell}.CoordIndex=ListCoordIndex(DimIndices);
287    end
288end
289NbDim=[NbDim NewNbDim];
290CellInfo=[CellInfo NewCellInfo];
291%
292% %% suppress empty cells
293% check_empty=cellfun(@isempty,CellInfo);
294% CellInfo(check_empty)=[];
295% NbDim(check_empty)=[];
296
297%% suppress empty cells or cells with a single coordinate variable
298check_remove=false(size(CellInfo));
299for icell=1:numel(check_remove)
300    if isempty(CellInfo{icell})||(numel(CellInfo{icell}.VarIndex)==1 && check_coord(icell))
301        check_remove(icell)=1;
302    end
303end
304CellInfo(check_remove)=[];
305NbDim(check_remove)=[];
306
307%% document roles of non-coordinate variables
308% ListRole={'vector_x','vector_y','vector_z','vector_x_tps','vector_y_tps','warnflag','errorflag',...
309%    'ancillary','image','color','discrete','scalar'};% except coord,coord_x,_y,_z,Coord_tps already taken, into account
310for icell=1:numel(CellInfo)
311    VarIndex=CellInfo{icell}.VarIndex;
312    for ivar=VarIndex
313        if isfield(CellInfo{icell},['VarIndex_' Role{ivar}])
314            CellInfo{icell}.(['VarIndex_' Role{ivar}])=[CellInfo{icell}.(['VarIndex_' Role{ivar}]) ivar];
315        else
316            CellInfo{icell}.(['VarIndex_' Role{ivar}])= ivar;
317        end
318        if ~isempty(ProjModeRequest{ivar})
319            CellInfo{icell}.ProjModeRequest=ProjModeRequest{ivar};
320        end
321        if ~isempty(FieldName{ivar})
322            CellInfo{icell}.FieldName=FieldName{ivar};
323        end
324        if CheckSub(ivar)==1
325            CellInfo{icell}.CheckSub=1;
326        end
327    end
328end
Note: See TracBrowser for help on using the repository browser.