source: trunk/doc/FUNCTIONS_DOC/struct2nc_toolbox.html @ 51

Last change on this file since 51 was 51, checked in by gostiaux, 11 years ago

added doc repository at the same level than src

File size: 4.6 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 struct2nc_toolbox</title>
6  <meta name="keywords" content="struct2nc_toolbox">
7  <meta name="description" content="'struct2nc_toolbox': create a netcdf file from a Matlab structure: use of netcdf toolbox">
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; struct2nc_toolbox.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>struct2nc_toolbox
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>'struct2nc_toolbox': create a netcdf file from a Matlab structure: use of netcdf toolbox</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 errormsg=struct2nc_toolbox(flname,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">'struct2nc_toolbox': create a netcdf file from a Matlab structure: use of netcdf toolbox
31---------------------------------------------------------------------
32 errormsg=struct2nc_toolbox(flname,Data)
33
34OUPUT:
35errormsg=error message, =[]: default, no error
36
37INPUT:
38flname: name of the netcdf file to create (must end with the extension '.nc')
39  Data: structure containing all the information of the netcdf file (or netcdf object)
40           with fields:
41    .ListGlobalAttribute: cell listing the names of the global attributes (note that a global atribute with the same name as a variable is excluded)
42        .Att_1,Att_2... : values of the global attributes
43            .ListDimName: cell listing the names of the array dimensions
44               .DimValue: array dimension values (Matlab vector with the same length as .ListDimName
45            .ListVarName: cell listing the names of the variables
46            .VarDimIndex: cell containing the set of dimension indices (in list .ListDimName) for each variable of .ListVarName
47           .VarAttribute: cell of structures s containing names and values of variable attributes (s.name=value) for each variable of .ListVarName
48        .Var1, .Var2....: variables (Matlab arrays) with names listed in .ListVarName
49
50AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
51  Copyright Joel Sommeria, 2008, LEGI / CNRS-UJF-INPG, sommeria@coriolis-legi.org.
52AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
53     This file is part of the toolbox UVMAT.
54 
55     UVMAT is free software; you can redistribute it and/or modify
56     it under the terms of the GNU General Public License as published by
57     the Free Software Foundation; either version 2 of the License, or
58     (at your option) any later version.
59 
60     UVMAT is distributed in the hope that it will be useful,
61     but WITHOUT ANY WARRANTY; without even the implied warranty of
62     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
63     GNU General Public License (file UVMAT/COPYING.txt) for more details.
64AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA</pre></div>
65
66<!-- crossreference -->
67<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
68This function calls:
69<ul style="list-style-image:url(../matlabicon.gif)">
70<li><a href="check_field_structure.html" class="code" title="function [DataOut,errormsg]=check_field_structure(Data)">check_field_structure</a> 'check_field_structure': check the validity of the field struture representation consistant with the netcdf format</li></ul>
71This function is called by:
72<ul style="list-style-image:url(../matlabicon.gif)">
73<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></ul>
74<!-- crossreference -->
75
76
77
78<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> &copy; 2003</address>
79</body>
80</html>
Note: See TracBrowser for help on using the repository browser.