source: trunk/src/uvmat_doc/FUNCTIONS_DOC/read_ncdata.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: 4.7 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 read_ncdata</title>
6  <meta name="keywords" content="read_ncdata">
7  <meta name="description" content="'read_ncdata': reads variables from netcdf files, recognizing civx data.">
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="#">coriolis</a> &gt; <a href="#">bigone</a> &gt; <a href="#">PROJETS</a> &gt; <a href="#">UVMAT.new</a> &gt; read_ncdata.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 /coriolis/bigone/PROJETS/UVMAT.new&nbsp;<img alt=">" border="0" src="../../../../right.png"></a></td></tr></table>-->
19
20<h1>read_ncdata
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>'read_ncdata': reads variables from netcdf files, recognizing civx data.</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 [Field,VelTypeOut]=read_ncdata(filename,FieldNames,VelType); </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">'read_ncdata': reads variables from netcdf files, recognizing civx data.
31------------------------------------------------------------------
32 COMBINE ET REMPLACE read_ncfield, read_vel et read_scalar_new
33------------------------------------------------------------------
34 OUTPUT:
35 nb_coord,nb_dim,
36 Civ: =0 or 1, indicates whether the data is civ (A SUPPRIMER ?)
37 CivStage: =0, ??? A UTILISER POUR REMPLACER civ
38           =1, civ1 has been performed only
39           =2, fix1 has been performed
40           =3, pacth1 has been performed
41           =4, civ2 has been performed
42           =5, fix2 has been performed
43           =6, pacth2 has been performed
44 time: absolute time
45 Field
46            .Txt: (char string) error message if any
47            .NbDim: number of dimensions (=0 by default)
48            .NbCoord: number of vector components
49            .CoordType: expresses the type of coordinate ('px' for image, 'sig' for instruments, or 'phys')
50            .dt: time interval for the corresponding image pair
51            .X, .Y, .Z: set of vector coordinates
52            .U,.V,.W: corresponding set of vector components
53            .F: warning flags
54            .FF: false flag, =0 for good vectors
55            .C: scalar associated with velocity (used for vector colors)
56            .CoordType
57            .DijU; matrix of spatial derivatives (DijU(1,1,:)=DUDX,
58            DijU(1,2,:)=DUDY, Dij(2,1,:)=DVDX, DijU(2,2,:)=DVDY
59            .A, .AX, .AY: additional scalar
60 dt:time interval of the image pair red from a single file, or vector with</pre></div>
61
62<!-- crossreference -->
63<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../../../../up.png"></a></h2>
64This function calls:
65<ul style="list-style-image:url(../../../../matlabicon.gif)">
66<li><a href="nc2struct.html" class="code" title="function [Data,var_detect,ichoice]=nc2struct(nc,ListVarName)">nc2struct</a>    'nc2struct': transform a netcdf file in a corresponding matlab structure</li><li><a href="read_ncvar.html" class="code" title="function [cte_detect,var_detect,cte_read,var_read,choice,cte2_detect,var2_detect,cte2_read,var2_read,choice2]=read_ncvar(filename,cte1,nb1,var1,cte2,nb2,var2)">read_ncvar</a>   'read_ncvar': reads a list of fields and constants in a netcdf file</li><li><a href="varcivx_generator.html" class="code" title="function [var,role,vel_type_out]=varcivx_generator(FieldName,vel_type)">varcivx_generator</a>  'varname_generator': defines the names of  variabless to read in civx type netcdf files</li></ul>
67This function is called by:
68<ul style="list-style-image:url(../../../../matlabicon.gif)">
69<li><a href="series.html" class="code" title="function varargout = series(varargin)">series</a> 'series': master function associated to the GUI series.m for analysis field series</li></ul>
70<!-- crossreference -->
71
72
73
74<hr><address>Generated on Tue 14-Apr-2009 22:21:41 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
75</body>
76</html>
Note: See TracBrowser for help on using the repository browser.