source: trunk/src/uvmat_doc/FUNCTIONS_DOC/check_field_structure.html @ 37

Last change on this file since 37 was 37, checked in by sommeria, 14 years ago

create_grid.fig ,
uvmat_doc and all the included files added
File size: 16.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2                "http://www.w3.org/TR/REC-html40/loose.dtd">
3<html>
4<head>
5  <title>Description of check_field_structure</title>
6  <meta name="keywords" content="check_field_structure">
7  <meta name="description" content="'check_field_structure': check the representation of fields by a Matlab structure">
8  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9  <meta name="generator" content="m2html &copy; 2003 Guillaume Flandin">
10  <meta name="robots" content="index, follow">
11  <link type="text/css" rel="stylesheet" href="../m2html.css">
12</head>
13<body>
14<a name="_top"></a>
15<div><a href="../index.html">Home</a> &gt;  <a href="index.html">.</a> &gt; check_field_structure.m</div>
16
17<!--<table width="100%"><tr><td align="left"><a href="../index.html"><img alt="<" border="0" src="../left.png">&nbsp;Master index</a></td>
18<td align="right"><a href="index.html">Index for .&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->
19
20<h1>check_field_structure
21</h1>
22
23<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
24<div class="box"><strong>'check_field_structure': check the representation of fields by a Matlab structure</strong></div>
25
26<h2><a name="_synopsis"></a>SYNOPSIS <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
27<div class="box"><strong>function [DataOut,errormsg]=check_field_structure(Data) </strong></div>
28
29<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
30<div class="fragment"><pre class="comment">'check_field_structure': check the representation of fields by a Matlab structure
31----------------------------------------------------------------------
32 function [DataOut,errormsg]=check_field_structure(Data)
33
34 OUTPUT:
35  Data: structure reproducing the input structure Data, with the additional elements:
36           with fields:
37
38            .ListDimName: cell listing the names of the array dimensions
39               .DimValue: array dimension values (Matlab vector with the same length as .ListDimName
40            .VarDimIndex: cell containing the set of dimension indices (in list .ListDimName) for each variable of .ListVarName
41            .VarDimName: cell containing a cell of dimension names (in list .ListDimName) for each variable of .ListVarName
42 errormsg: error message which is not empty when the input structure does not have the right form
43
44INPUT:
45 Data:   structure containing
46         (optional) .ListGlobalAttribute: cell listing the names of the global attributes
47                    .Att_1,Att_2... : values of the global attributes
48         (requested)  .ListVarName: list of variable names to select (cell array of  char strings {'VarName1', 'VarName2',...} )
49         (requested)  .VarDimName: list of dimension names for each element of .ListVarName (cell array of string cells)                         
50         (requested) .Var1, .Var2....: variables (Matlab arrays) with names listed in .ListVarName</pre></div>
51
52<!-- crossreference -->
53<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
54This function calls:
55<ul style="list-style-image:url(../matlabicon.gif)">
56</ul>
57This function is called by:
58<ul style="list-style-image:url(../matlabicon.gif)">
59<li><a href="plot_field.html" class="code" title="function [PlotType,PlotParamOut,haxes]= plot_field(Data,haxes,PlotParam,KeepLim,PosColorbar)">plot_field</a>  'plot_field': plot any field with the structure defined in the uvmat package</li><li><a href="struct2nc.html" class="code" title="function errormsg=struct2nc(flname,Data)">struct2nc</a>       'struct2nc': create a netcdf file from a Matlab structure</li><li><a href="struct2nc_toolbox.html" class="code" title="function errormsg=struct2nc_toolbox(flname,Data)">struct2nc_toolbox</a>  'struct2nc_toolbox': create a netcdf file from a Matlab structure: use of netcdf toolbox</li><li><a href="uvmat.html" class="code" title="function varargout = uvmat(varargin)">uvmat</a>       'uvmat': function associated with the GUI 'uvmat.fig' for images and data field visualization</li></ul>
60<!-- crossreference -->
61
62
63<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
64<div class="fragment"><pre>0001 <span class="comment">%'check_field_structure': check the representation of fields by a Matlab structure</span>
650002 <span class="comment">%----------------------------------------------------------------------</span>
660003 <span class="comment">% function [DataOut,errormsg]=check_field_structure(Data)</span>
670004 <span class="comment">%</span>
680005 <span class="comment">% OUTPUT:</span>
690006 <span class="comment">%  Data: structure reproducing the input structure Data, with the additional elements:</span>
700007 <span class="comment">%           with fields:</span>
710008 <span class="comment">%</span>
720009 <span class="comment">%            .ListDimName: cell listing the names of the array dimensions</span>
730010 <span class="comment">%               .DimValue: array dimension values (Matlab vector with the same length as .ListDimName</span>
740011 <span class="comment">%            .VarDimIndex: cell containing the set of dimension indices (in list .ListDimName) for each variable of .ListVarName</span>
750012 <span class="comment">%            .VarDimName: cell containing a cell of dimension names (in list .ListDimName) for each variable of .ListVarName</span>
760013 <span class="comment">% errormsg: error message which is not empty when the input structure does not have the right form</span>
770014 <span class="comment">%</span>
780015 <span class="comment">%INPUT:</span>
790016 <span class="comment">% Data:   structure containing</span>
800017 <span class="comment">%         (optional) .ListGlobalAttribute: cell listing the names of the global attributes</span>
810018 <span class="comment">%                    .Att_1,Att_2... : values of the global attributes</span>
820019 <span class="comment">%         (requested)  .ListVarName: list of variable names to select (cell array of  char strings {'VarName1', 'VarName2',...} )</span>
830020 <span class="comment">%         (requested)  .VarDimName: list of dimension names for each element of .ListVarName (cell array of string cells)</span>
840021 <span class="comment">%         (requested) .Var1, .Var2....: variables (Matlab arrays) with names listed in .ListVarName</span>
850022
860023
870024 <a name="_sub0" href="#_subfunctions" class="code">function [DataOut,errormsg]=check_field_structure(Data)</a>
880025 DataOut=[]; <span class="comment">%default</span>
890026 errormsg=[];
900027 <span class="keyword">if</span> ~isstruct(Data)
910028     errormsg=<span class="string">'input field is not a structure'</span>;
920029     <span class="keyword">return</span>
930030 <span class="keyword">end</span>
940031 <span class="keyword">if</span> isfield(Data,<span class="string">'ListVarName'</span>) &amp;&amp; iscell(Data.ListVarName)
950032     nbfield=numel(Data.ListVarName);
960033 <span class="keyword">else</span>
970034     errormsg=<span class="string">'input field does not contain the list of variables .ListVarNames'</span>;
980035     <span class="keyword">return</span>
990036 <span class="keyword">end</span>
1000037 <span class="comment">%check dimension names</span>
1010038 <span class="comment">% definition by VarDimIndex (obsolete)</span>
1020039 <span class="keyword">if</span> ~isfield(Data,<span class="string">'VarDimName'</span>) &amp;&amp; isfield(Data,<span class="string">'VarDimIndex'</span>) &amp;&amp; isfield(Data,<span class="string">'ListDimName'</span>)<span class="comment">%old convention</span>
1030040     <span class="keyword">for</span> ivar=1:nbfield
1040041         DimCell=Data.VarDimIndex{ivar};
1050042         <span class="keyword">if</span> isnumeric(DimCell)
1060043             <span class="keyword">if</span> DimCell &lt;= numel(Data.ListDimName)
1070044                 Data.VarDimName{ivar}=Data.ListDimName(DimCell);
1080045             <span class="keyword">else</span>                     
1090046                 errormsg=<span class="string">'dimension names not defined'</span>;
1100047                 <span class="keyword">return</span> 
1110048             <span class="keyword">end</span>
1120049         <span class="keyword">else</span> 
1130050             errormsg=<span class="string">'unrecognized format for .VarDimIndex'</span>;
1140051         <span class="keyword">end</span>
1150052     <span class="keyword">end</span>
1160053 <span class="keyword">end</span>
1170054 <span class="keyword">if</span> ~(isfield(Data,<span class="string">'VarDimName'</span>) &amp;&amp; iscell(Data.VarDimName))
1180055     errormsg=<span class="string">'input field does not contain the list of dimensions .VarDimName'</span>;
1190056     <span class="keyword">return</span>
1200057 <span class="keyword">end</span>
1210058 <span class="keyword">if</span> isfield(Data,<span class="string">'DimValue'</span>)
1220059     Data=rmfield(Data,<span class="string">'DimValue'</span>);
1230060 <span class="keyword">end</span>
1240061 <span class="keyword">if</span> isfield(Data,<span class="string">'VarDimName'</span>) &amp;&amp; iscell(Data.VarDimName)
1250062     nbdim=0;
1260063     <span class="keyword">if</span> numel(Data.VarDimName)==nbfield
1270064         <span class="keyword">for</span> ivar=1:nbfield
1280065             VarName=Data.ListVarName{ivar};
1290066             <span class="keyword">if</span> ~isfield(Data,VarName)
1300067                 errormsg=[<span class="string">'the listed variable '</span> VarName <span class="string">' is not found'</span>];
1310068                 <span class="keyword">return</span>
1320069             <span class="keyword">else</span>             
1330070                 eval([<span class="string">'sizvar=size(Data.'</span> VarName <span class="string">');'</span>])<span class="comment">% sizvar = dimension of variable</span>
1340071                 DimCell=Data.VarDimName{ivar};
1350072                 <span class="keyword">if</span> ischar(DimCell)
1360073                     DimCell={DimCell};
1370074                 <span class="keyword">elseif</span> ~iscell(DimCell)
1380075                     errormsg=[<span class="string">'wrong format for .VarDimName{'</span> num2str(ivar) <span class="string">' (must be the cell of dimension names of the variable '</span> VarName];
1390076                     <span class="keyword">return</span>
1400077                 <span class="keyword">end</span>
1410078                 nbcoord=numel(sizvar);
1420079 <span class="comment">%                 Data.VarType{ivar}=[num2str(nbcoord) 'D'];%default</span>
1430080                 <span class="keyword">if</span> numel(DimCell)==0
1440081                     errormsg=[<span class="string">'empty declared dimension .VarDimName{'</span> num2str(ivar) <span class="string">'} for '</span> VarName];
1450082                     <span class="keyword">return</span>
1460083                 <span class="keyword">elseif</span> numel(DimCell)==1<span class="comment">% one dimension declared</span>
1470084                     <span class="keyword">if</span> nbcoord==2
1480085                         <span class="keyword">if</span> sizvar(1)==1
1490086 <span class="comment">%                             Data.VarType{ivar}='row';</span>
1500087                             nbcoord=1;
1510088                             sizvar(1)=sizvar(2);
1520089                         <span class="keyword">elseif</span> sizvar(2)==1
1530090 <span class="comment">%                             Data.VarType{ivar}='column';</span>
1540091                             nbcoord=1;
1550092                         <span class="keyword">else</span>
1560093                             errormsg=[<span class="string">'1 dimension declared in .VarDimName{'</span> num2str(ivar) <span class="string">'} inconsistent with the nbre of dimensions =2 of the variable '</span> VarName];
1570094                             <span class="keyword">return</span>
1580095                         <span class="keyword">end</span>
1590096                     <span class="keyword">else</span>
1600097                           errormsg=[<span class="string">'1 dimension declared in .VarDimName{'</span> num2str(ivar) <span class="string">'} inconsistent with the nbre of dimensions ='</span> num2str(nbcoord) <span class="string">' of the variable '</span> VarName];
1610098                           <span class="keyword">return</span>     
1620099                     <span class="keyword">end</span> 
1630100                 <span class="keyword">else</span>
1640101                     <span class="keyword">if</span> nbcoord~=numel(DimCell)
1650102                         errormsg=[<span class="string">'nbre of declared dimensions in .VarDimName{'</span> num2str(ivar) <span class="string">'} inconsistent with the nbre of dimensions ='</span> num2str(nbcoord) <span class="string">' of the variable '</span> VarName];
1660103                         <span class="keyword">return</span>
1670104                     <span class="keyword">end</span>
1680105                 <span class="keyword">end</span>
1690106                 DimIndex=[];
1700107                 <span class="keyword">for</span> idim=1:nbcoord <span class="comment">%loop on the coordinates of variable #ivar</span>
1710108                     DimName=DimCell{idim};
1720109                     testprev=0;
1730110                     <span class="keyword">for</span> iprev=1:nbdim <span class="comment">%check previously listed dimension names</span>
1740111                         <span class="keyword">if</span> strcmp(Data.ListDimName{iprev},DimName)
1750112                            <span class="keyword">if</span> ~isequal(Data.DimValue(iprev),sizvar(idim))
1760113                                <span class="keyword">if</span> isequal(Data.DimValue(idim),0)  <span class="comment">% the dimension has been already detected as range</span>
1770114                                    Data.DimValue(idim)=sizvar(idim); <span class="comment">%update with actual value</span>
1780115                                <span class="keyword">elseif</span> sizvar(idim)==2 &amp;&amp; strcmp(DimName,VarName)
1790116 <span class="comment">%                                    Data.VarType{ivar}='range';  %case of a regularly spaced coordinate defined by the first and last values</span>
1800117                                <span class="keyword">else</span>
1810118                                    errormsg=[<span class="string">'dimension declaration inconsistent with the size =['</span> num2str(sizvar) <span class="string">'] for '</span> VarName];
1820119                                    <span class="keyword">return</span> 
1830120                                <span class="keyword">end</span>
1840121                            <span class="keyword">end</span>
1850122                            DimIndex=[DimIndex iprev];
1860123                            testprev=1;
1870124                            <span class="keyword">break</span>
1880125                         <span class="keyword">end</span>
1890126                     <span class="keyword">end</span>
1900127                     <span class="keyword">if</span> ~testprev <span class="comment">% a new dimension is appended to the list</span>
1910128                         nbdim=nbdim+1;
1920129                         <span class="keyword">if</span> sizvar(idim)==2 &amp;&amp; strcmp(DimName,VarName)
1930130                             Data.DimValue(nbdim)=0; <span class="comment">%to be updated for a later variable</span>
1940131 <span class="comment">%                             Data.VarType{ivar}='range';</span>
1950132                         <span class="keyword">else</span>
1960133                             Data.DimValue(nbdim)=sizvar(idim);
1970134                         <span class="keyword">end</span>
1980135                         Data.ListDimName{nbdim}=DimName;
1990136                         DimIndex=[DimIndex nbdim];
2000137                     <span class="keyword">end</span>
2010138                 <span class="keyword">end</span>
2020139                 Data.VarDimIndex{ivar}=DimIndex;
2030140             <span class="keyword">end</span>
2040141         <span class="keyword">end</span>                               
2050142     <span class="keyword">else</span>
2060143         errormsg=<span class="string">' .ListVarNames and .VarDimName have different lengths'</span>;
2070144         <span class="keyword">return</span>
2080145     <span class="keyword">end</span>
2090146 <span class="keyword">else</span>
2100147     errormsg=<span class="string">'input field does not contain the cell of dimension names .VarDimName for variables'</span>;
2110148     <span class="keyword">return</span>
2120149 <span class="keyword">end</span>
2130150 DataOut=Data;
2140151     
2150152</pre></div>
216<hr><address>Generated on Fri 13-Nov-2009 11:17:03 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
217</body>
218</html>
Note: See TracBrowser for help on using the repository browser.