source: trunk/src/check_field_structure.m @ 158

Last change on this file since 158 was 158, checked in by sommeria, 10 years ago

CoordType? not used, replaced by CoordUnit?
bug repair in check_field_structure

File size: 5.7 KB
Line 
1%'check_field_structure': check the validity of the field struture representation consistant with the netcdf format
2%------------------------------------------------------------------------
3% function [DataOut,errormsg]=check_field_structure(Data)
4%
5% OUTPUT:
6% DataOut: structure reproducing the input structure Data, with the additional elements:
7%           with fields:
8%
9%            .ListDimName: cell listing the names of the array dimensions
10%             .DimValue: array dimension values (Matlab vector with the same length as .ListDimName
11%            .VarDimIndex: cell containing the set of dimension indices (in list .ListDimName) for each variable of .ListVarName
12%            .VarDimName: cell containing a cell of dimension names (in list .ListDimName) for each variable of .ListVarName
13% errormsg: error message which is not empty when the input structure does not have the right form
14%
15% INPUT:
16% Data:   structure containing
17%         (optional) .ListGlobalAttribute: cell listing the names of the global attributes
18%                    .Att_1,Att_2... : values of the global attributes
19%         (requested)  .ListVarName: list of variable names to select (cell array of  char strings {'VarName1', 'VarName2',...} )
20%         (requested)  .VarDimName: list of dimension names for each element of .ListVarName (cell array of string cells)                         
21%         (requested) .Var1, .Var2....: variables (Matlab arrays) with names listed in .ListVarName
22
23
24function [DataOut,errormsg]=check_field_structure(Data)
25DataOut=[]; %default
26errormsg=[];
27if ~isstruct(Data)
28    errormsg='input field is not a structure';
29    return
30end
31if isfield(Data,'ListVarName') && iscell(Data.ListVarName)
32    nbfield=numel(Data.ListVarName);
33else
34    errormsg='input field does not contain the cell array of variable names .ListVarNames';
35    return
36end
37%check dimension names
38if (isfield(Data,'VarDimName') && iscell(Data.VarDimName))
39    if  numel(Data.VarDimName)~=nbfield
40       errormsg=' .ListVarName and .VarDimName have different lengths';
41        return
42    end
43else
44    errormsg='input field does not contain the  cell array of dimension names .VarDimName';
45    return
46end
47if isfield(Data,'DimValue')
48    Data=rmfield(Data,'DimValue');
49end
50nbdim=0;
51Data.ListDimName={};
52
53%% main loop on the list of variables
54for ivar=1:nbfield
55    VarName=Data.ListVarName{ivar};
56    if ~isfield(Data,VarName)
57        errormsg=['the listed variable ' VarName ' is not found'];
58        return
59    end
60    eval(['sizvar=size(Data.' VarName ');'])% sizvar = dimension of variable
61    DimCell=Data.VarDimName{ivar};
62    if ischar(DimCell)
63        DimCell={DimCell};%case of a single dimension name, defined by a string
64    elseif ~iscell(DimCell)
65        errormsg=['wrong format for .VarDimName{' num2str(ivar) ' (must be the cell of dimension names of the variable ' VarName];
66        return
67    end
68    nbcoord=numel(sizvar);%nbre of coordinates for variable named VarName
69    testrange=0;
70    if numel(DimCell)==0
71        errormsg=['empty declared dimension .VarDimName{' num2str(ivar) '} for ' VarName];
72        return
73    elseif numel(DimCell)==1% one dimension declared
74        if nbcoord==2
75            if sizvar(1)==1
76                nbcoord=1;
77                sizvar(1)=sizvar(2);
78            elseif sizvar(2)==1
79                nbcoord=1;
80            else
81                errormsg=['1 dimension declared in .VarDimName{' num2str(ivar) '} inconsistent with the nbre of dimensions =2 of the variable ' VarName];
82                return
83            end
84            if sizvar(1)==2 && isequal(VarName,DimCell{1})
85                testrange=1;% test for a dimension variable representing a range
86            end
87        else
88            errormsg=['1 dimension declared in .VarDimName{' num2str(ivar) '} inconsistent with the nbre of dimensions =' num2str(nbcoord) ' of the variable ' VarName];
89            return
90        end
91    else
92        if numel(DimCell)>nbcoord
93            DimCell=DimCell(end-nbcoord+1:end);%first singleton diemensions omitted,
94        elseif nbcoord > numel(DimCell)
95            errormsg=['nbre of declared dimensions in .VarDimName{' num2str(ivar) '} smaller than the nbre of dimensions =' num2str(nbcoord) ' of the variable ' VarName];
96            return
97        end
98    end
99    DimIndex=[];
100    for idim=1:nbcoord %loop on the coordinates of variable #ivar
101        DimName=DimCell{idim};
102        iprev=find(strcmp(DimName,Data.ListDimName),1);%look for dimension name DimName in the current list
103        if isempty(iprev)% append the dimension name to the current list
104            nbdim=nbdim+1;
105            RangeTest(nbdim)=0; %default
106            if sizvar(idim)==2 && strcmp(DimName,VarName)%case of a coordinate defined by the two end values (regular spacing)
107                RangeTest(nbdim)=1; %to be updated for a later variable 
108            end
109            Data.DimValue(nbdim)=sizvar(idim);
110            Data.ListDimName{nbdim}=DimName;
111            DimIndex=[DimIndex nbdim];
112        else % DimName is detected in the current list of dimension names
113            if ~isequal(Data.DimValue(iprev),sizvar(idim))
114                        RangeTest(iprev)
115            Data.DimValue(iprev)
116                if isequal(Data.DimValue(iprev),2)&& RangeTest(iprev)  % the dimension has been already detected as a range [min max]
117                    Data.DimValue(iprev)=sizvar(idim); %update with actual value
118                elseif ~testrange               
119                    errormsg=['dimension declaration inconsistent with the size =[' num2str(sizvar) '] for ' VarName];
120                    return
121                end
122            end
123            DimIndex=[DimIndex iprev];
124        end
125    end
126    Data.VarDimIndex{ivar}=DimIndex;
127end
128DataOut=Data;
129   
130   
Note: See TracBrowser for help on using the repository browser.