| 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 nc2struct_toolbox</title> |
|---|
| 6 | <meta name="keywords" content="nc2struct_toolbox"> |
|---|
| 7 | <meta name="description" content="'nc2struct_toolbox': transform a netcdf file in a corresponding matlab structure, USE OLD NETCDF LIBRARY"> |
|---|
| 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> > nc2struct_toolbox.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>nc2struct_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>'nc2struct_toolbox': transform a netcdf file in a corresponding matlab structure, USE OLD NETCDF LIBRARY</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 [Data,var_detect,ichoice]=nc2struct_toolbox(nc,varargin) </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">'nc2struct_toolbox': transform a netcdf file in a corresponding matlab structure, USE OLD NETCDF LIBRARY |
|---|
| 31 | ---------------------------------------------------------------------- |
|---|
| 32 | function [Data,var_detect,ichoice]=nc2struct_toolbox(nc,ListField) |
|---|
| 33 | |
|---|
| 34 | OUTPUT: |
|---|
| 35 | Data: structure containing all the information of the netcdf file (or netcdf object) |
|---|
| 36 | with fields: |
|---|
| 37 | .ListGlobalAttribute: cell listing the names of the global attributes |
|---|
| 38 | .Att_1,Att_2... : values of the global attributes |
|---|
| 39 | .ListDimName: cell listing the names of the array dimensions |
|---|
| 40 | .DimValue: array dimension values (Matlab vector with the same length as .ListDimName |
|---|
| 41 | .ListVarName: cell listing the names of the variables |
|---|
| 42 | .VarDimIndex: cell containing the set of dimension indices (in list .ListDimName) for each variable of .ListVarName |
|---|
| 43 | .VarDimName: cell containing a cell of dimension names (in list .ListDimName) for each variable of .ListVarName |
|---|
| 44 | .VarAttribute: cell of structures s containing names and values of variable attributes (s.name=value) for each variable of .ListVarName |
|---|
| 45 | .Var1, .Var2....: variables (Matlab arrays) with names listed in .ListVarName |
|---|
| 46 | var_detect: vector with same length as ListVarName, with 1 for each detected variable and 0 else. |
|---|
| 47 | ichoice: = line |
|---|
| 48 | |
|---|
| 49 | INPUT: |
|---|
| 50 | nc: name of a netcdf file (char string) or netcdf object |
|---|
| 51 | ListField: optional list of variable names to select (cell array of char strings {'VarName1', 'VarName2',...} ) |
|---|
| 52 | if ListField is absent or ='*', ALL the attributes and variables are read. % |
|---|
| 53 | if ListField='ListGlobalAttribute', followed by the arguments 'name1', name2'..., only thes global attributes will be read (short option) |
|---|
| 54 | if ListField=[] or{}, no variables is read (only global attributes and lists of vdimensions, variables and attriburtes) |
|---|
| 55 | if ListField is a cell array with n lines, the set of variables |
|---|
| 56 | will be sought by order of priority in the list, while output names will be set by the first line |
|---|
| 57 | |
|---|
| 58 | AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |
|---|
| 59 | Copyright Joel Sommeria, 2008, LEGI / CNRS-UJF-INPG, sommeria@coriolis-legi.org. |
|---|
| 60 | AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |
|---|
| 61 | This file is part of the toolbox UVMAT. |
|---|
| 62 | |
|---|
| 63 | UVMAT is free software; you can redistribute it and/or modify |
|---|
| 64 | it under the terms of the GNU General Public License as published by |
|---|
| 65 | the Free Software Foundation; either version 2 of the License, or |
|---|
| 66 | (at your option) any later version. |
|---|
| 67 | |
|---|
| 68 | UVMAT is distributed in the hope that it will be useful, |
|---|
| 69 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 70 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 71 | GNU General Public License (file UVMAT/COPYING.txt) for more details. |
|---|
| 72 | AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA</pre></div> |
|---|
| 73 | |
|---|
| 74 | <!-- crossreference --> |
|---|
| 75 | <h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2> |
|---|
| 76 | This function calls: |
|---|
| 77 | <ul style="list-style-image:url(../matlabicon.gif)"> |
|---|
| 78 | </ul> |
|---|
| 79 | This function is called by: |
|---|
| 80 | <ul style="list-style-image:url(../matlabicon.gif)"> |
|---|
| 81 | <li><a href="nc2struct.html" class="code" title="function [Data,var_detect,ichoice]=nc2struct(nc,varargin)">nc2struct</a> 'nc2struct': transform a netcdf file in a corresponding matlab structure</li></ul> |
|---|
| 82 | <!-- crossreference --> |
|---|
| 83 | |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | <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> |
|---|
| 87 | </body> |
|---|
| 88 | </html> |
|---|
