| 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 validity of the field struture representation consistant with the netcdf format"> |
|---|
| 8 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
|---|
| 9 | <meta name="generator" content="m2html © 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> > <a href="index.html">.</a> > 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"> Master index</a></td> |
|---|
| 18 | <td align="right"><a href="index.html">Index for . <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 validity of the field struture representation consistant with the netcdf format</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 validity of the field struture representation consistant with the netcdf format |
|---|
| 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 | |
|---|
| 44 | INPUT: |
|---|
| 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> |
|---|
| 54 | This function calls: |
|---|
| 55 | <ul style="list-style-image:url(../matlabicon.gif)"> |
|---|
| 56 | </ul> |
|---|
| 57 | This 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 | |
|---|
| 64 | <hr><address>Generated on Wed 10-Mar-2010 20:42:36 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> © 2003</address> |
|---|
| 65 | </body> |
|---|
| 66 | </html> |
|---|
