source: trunk/src/uvmat_doc/FUNCTIONS_DOC/read_vel.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: 6.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 read_vel</title>
6  <meta name="keywords" content="read_vel">
7  <meta name="description" content="'read_vel': reads one or two velocity fields and associated parameters from a file or a pair of files.">
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_vel.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_vel
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_vel': reads one or two velocity fields and associated parameters from a file or a pair of files.</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 [dt,time,pixcmx,pixcmy,vec_X,vec_Y,vec_Z,vec_U,vec_V,vec_W,vec_C,vec_F,fixflag,vel_type_out,error,nb_coord,nb_dim,Civ,CivStage]=read_vel(filename,vel_type,scal_type,vec_X_in,vec_Y_in,vec_Z_in); </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_vel': reads one or two velocity fields and associated parameters from a file or a pair of files.
31 In the case of two velocity fields, the difference of the two fields (linearly interpolated to the positions of
32 the first field) is given as the default output. Any other operation on the two
33 fields can be introduced by an external function 'usrtransform'.
34 OBSOLETE: REPLACED BY read_ncfield
35------------------------------------------------------------------
36 [dt,time,pixcmx,pixcmy,vec_X,vec_Y,vec_Z,vec_U,vec_V,vec_W,vec_C,vec_F,fixflag,vel_type_out,error,nb_coord,nb_dim,Ima,CivStage]...
37 =read_vel(filename,vel_type,scal_type,vec_X_in,vec_Y_in,vec_Z_in);
38 OUTPUT:
39 dt:time interval of the image pair red from a single file, or vector with
40 two values for a pair of files
41 time: absolute time of the first file
42 pixcmx,pixcmy: scaling factors (from the first file)
43 vec_X,vec_Y,vec_Z: matlab vectors, representing the set of coordinates for
44 the velocity vectors, vec_Z=zeros(size(vec_X)) for a 2D planar field
45 vec_U,vec_V,vec_W: matlab vectors, representing the set of velocity components for
46 the velocity vectors, vec_W=zeros(size(vec_X)) for a 2 component field
47 vec_C: matlab vector, representing the set of image correlations, or any scalar set by the input 'scal_type'.
48 vec_F: matlab vector, representing the set of vector flags vec_F for quality warning.
49 fixflag: matlab vector, representing the set of vector flags for removal.
50 RMQ: when two fields are read, the flags and vec_C correspond
51 to the first field. By default vec_C=1,vec_F=1,fixflag=0 if
52 it is not defined. (faulse vectors of the second field  are removed before interpolation)
53 vel_type_out: string representing the selected velocity type (civ1,civ2,filter1...)
54 error: error flag
55 error=0; OK
56 error=1; first field of file 1 not detected
57 error=2; second field of file 1 not detected
58 error=3; first field of file 2 not detected
59 error=4; second field of file 2 not detected
60 error=5; the scalar cannot be obtained
61
62 INPUT:
63 filename: cell of names (length 1 or 2) representing the file names.
64 vel_type: cell of imposed velocity types 'civ1','filter1'...if
65 vel_type={} or vel_type{1}=[], the best choice is made (first civ2, then civ1)
66 scal_type: string of a scalar name. If defined vec_C represents the value of this scalar
67 vec_X_in,vec_Y_in,vec_Z_in: optional imposed set of positions on which data are linearly interpolated (not yet implemented)
68 transform: transform.vel: name of an optional user defined function
69 [vec_U,vec_V,vec_W,vec_X,vec_Y,vec_Z]=usrtransform(vec_U,vec_V,vec_W,vec2_U,vec2_V,vec2_W,vec_X,vec_Y,vec_Z)
70 transform.scal: name of a transform function for a scalar (used if vec_C is a scalar)
71
72 FUNCTIONS called:
73 'varname_generator.m':, sets the names in the netcdf file from 'vel_type'
74 'read_netcdf.m': reads the netcdf file with a given set of variable names
75 'calc_scal.m': calculates the scalar (used for arrow colors)</pre></div>
76
77<!-- crossreference -->
78<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../../../../up.png"></a></h2>
79This function calls:
80<ul style="list-style-image:url(../../../../matlabicon.gif)">
81<li><a href="calc_scal.html" class="code" title="function [Scal]=calc_scal(ScalName,DataIn)">calc_scal</a>      'calc_scal': defines scalars and calculate them from stored fields. OBSOLETE to replace by calc_field</li><li><a href="griddata_uvmat.html" class="code" title="function ZI = griddata_uvmat(X,Y,Z,XI,YI)">griddata_uvmat</a>   'griddata_uvmat': function griddata_uvmat(vec2_X,vec2_Y,vec2_U,vec_X,vec_Y,'linear')</li><li><a href="read_netcdf.html" class="code" title="function [cte_detect,var_detect,cte_read,var_read,choice,cte2_detect,var2_detect,cte2_read,var2_read]=read_netcdf(filename,cte1,nb1,var1,cte2,nb2,var2,option)">read_netcdf</a>     'read_netcdf': reads a list of fields and constants in a netcdf file</li><li><a href="varname_generator.html" class="code" title="function [cte,nb,var,vel_type_out]=varname_generator(vel_type,display,scal_name,scal_2,scal_3)">varname_generator</a> 'varname_generator': defines the names of constants and variable fields to read in the netcdf files</li></ul>
82This function is called by:
83<ul style="list-style-image:url(../../../../matlabicon.gif)">
84<li><a href="RUN_STLIN.html" class="code" title="function RUN_STLIN(filecell_ncA,filecell_ncB,vel_type,file_st,nx_patch,ny_patch,thresh_patch,fileAxml,fileBxml)">RUN_STLIN</a> 'RUN_STLIN': combine velocity fields for stereo PIV</li></ul>
85<!-- crossreference -->
86
87
88
89<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>
90</body>
91</html>
Note: See TracBrowser for help on using the repository browser.