source: trunk/src/uvmat_doc/FUNCTIONS_DOC/nomtype2pair.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: 8.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 nomtype2pair</title>
6  <meta name="keywords" content="nomtype2pair">
7  <meta name="description" content="'nomtype2pair': creates nomencalture for index pairs.">
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; nomtype2pair.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>nomtype2pair
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>'nomtype2pair': creates nomencalture for index pairs.</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 [nom_type_pair]=nomtype2pair(nom_type,Dti,Dtj); </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">'nomtype2pair': creates nomencalture for index pairs.
31---------------------------------------------------------------------
32 [nom_type_nc]=nomtype2pair(nom_type);
33---------------------------------------------------------------------           
34 This function detects the existence the constructed file name and it can
35 find indices according to file existence if they are not specified
36%rmq: this function is related to the reverse functions display2name and name2diplay
37---------------------------------------------------------------------
38 OUTPUT:
39nom_type_nc</pre></div>
40
41<!-- crossreference -->
42<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
43This function calls:
44<ul style="list-style-image:url(../matlabicon.gif)">
45</ul>
46This function is called by:
47<ul style="list-style-image:url(../matlabicon.gif)">
48<li><a href="civ.html" class="code" title="function varargout = civ(varargin)">civ</a>  'civ': function associated with the interface 'civ.fig' for PIV, spline interpolation and stereo PIV (patch)</li><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>
49<!-- crossreference -->
50
51
52<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
53<div class="fragment"><pre>0001 <span class="comment">%'nomtype2pair': creates nomencalture for index pairs.</span>
540002 <span class="comment">%---------------------------------------------------------------------</span>
550003 <span class="comment">% [nom_type_nc]=nomtype2pair(nom_type);</span>
560004 <span class="comment">%---------------------------------------------------------------------</span>
570005 <span class="comment">% This function detects the existence the constructed file name and it can</span>
580006 <span class="comment">% find indices according to file existence if they are not specified</span>
590007 <span class="comment">%%rmq: this function is related to the reverse functions display2name and name2diplay</span>
600008 <span class="comment">%---------------------------------------------------------------------</span>
610009 <span class="comment">% OUTPUT:</span>
620010 <span class="comment">%nom_type_nc</span>
630011
640012 <span class="comment">%---------------------------------------------------------------------</span>
650013 <span class="comment">% INPUT:</span>
660014 <span class="comment">% 'nom_type': string defining the kind of nomenclature used:</span>
670015      <span class="comment">%nom_type='': constant name [filebase ext] (default output if 'nom_type' is undefined)</span>
680016      <span class="comment">%nom_type='*': the same  file [filebase ext] contains successive fields (ex avi movies)</span>
690017      <span class="comment">%nom_type='_i': series of files with a single index i preceded by '_'(e.g. 'aa_45.png').</span>
700018      <span class="comment">%nom_type='#' series of indexed images wich is not series_i [filebase index ext], e.g. 'aa045.jpg' or 'aa45.tif'</span>
710019      <span class="comment">%nom_type='_i_j' matrix of files with two indices i and j separated by '_'(e.g. 'aa_45_2.png')</span>
720020      <span class="comment">%nom_type='_i1-i2' from pairs from a single index (e.g. 'aa_45-47.nc')</span>
730021      <span class="comment">%nom_type='_i_j1-j2'pairs of j indices (e.g. 'aa_45_2-3.nc')</span>
740022      <span class="comment">%nom_type='_i1-i2_j' pairs of i indices (e.g. 'aa_45-46_2.nc')</span>
750023      <span class="comment">%nom_type='#a','#A', with a numerical index and an index letter(e.g.'aa045b.png'), OBSOLETE (replaced by 'series_i_j')</span>
760024      <span class="comment">%nom_type='%03d' or '%04d', series of indexed images with numbers completed with zeros to 3 or 4 digits, e.g.'aa045.tif'</span>
770025      <span class="comment">%nom_type='_%03d', '_%04d', or '_%05d', series of indexed images with _ and numbers completed with zeros to 3, 4 or 5 digits, e.g.'aa_045.tif'</span>
780026      <span class="comment">%nom_type='raw_SMD', same as '#a' but with no extension ext='', OBSOLETE</span>
790027      <span class="comment">%nom_type='#_ab' from pairs of '#a' images (e.g. 'aa045bc.nc'), ext='.nc', OBSOLETE (replaced by 'netc_2D')</span>
800028      <span class="comment">%nom_type='%3dab' from pairs of '%3da' images (e.g. 'aa045bc.nc'), ext='.nc', OBSOLETE (replaced by 'netc_2D')</span>
810029 <span class="comment">% Dti: ~=0 if i index pairs are used</span>
820030 <span class="comment">% Dtj: ~=0 if i index pairs are used</span>
830031
840032 <a name="_sub0" href="#_subfunctions" class="code">function [nom_type_pair]=nomtype2pair(nom_type,Dti,Dtj);</a>
850033
860034 <span class="comment">%determine nom_type_nc:</span>
870035 nom_type_nc=[];<span class="comment">%default</span>
880036 <span class="keyword">switch</span> nom_type
890037     <span class="keyword">case</span> {<span class="string">'_i_j'</span>}
900038         <span class="keyword">if</span> Dtj&gt;0 || Dtj&lt;0
910039             nom_type_pair=<span class="string">'_i_j1-j2'</span>;
920040             <span class="keyword">if</span> Dti&gt;0 || Dti&lt;0
930041                 nom_type_pair=<span class="string">'_i1-i2_j1-j2'</span>;
940042             <span class="keyword">end</span>
950043             <span class="keyword">elseif</span> Dti&gt;0 || Dti&lt;0
960044             nom_type_pair=<span class="string">'_i1-i21_j'</span>;   
970045         <span class="keyword">else</span>
980046              nom_type_pair=<span class="string">'_i_j'</span>;
990047         <span class="keyword">end</span>
1000048     <span class="keyword">case</span> {<span class="string">'_i1-i2_j'</span>}
1010049         <span class="keyword">if</span> Dtj&gt;0 || Dtj&lt;0
1020050            nom_type_pair=<span class="string">'_i1-i2_j1-j2'</span>;
1030051         <span class="keyword">else</span>
1040052             nom_type_pair=<span class="string">'_i1-i2_j'</span>;
1050053         <span class="keyword">end</span>
1060054     <span class="keyword">case</span> {<span class="string">'i_j1-j2'</span>}
1070055         <span class="keyword">if</span> Dti&gt;0 || Dti&lt;0
1080056            nom_type_pair=<span class="string">'_i1-i2_j1-j2'</span>;
1090057         <span class="keyword">else</span>
1100058             nom_type_pair=<span class="string">'_i1-i2_j'</span>;
1110059         <span class="keyword">end</span>
1120060     <span class="keyword">case</span> {<span class="string">'i1-i2_j1-j2'</span>}
1130061          nom_type_pair=<span class="string">'_i1-i2_j1-j2'</span>;
1140062     <span class="keyword">case</span> <span class="string">'#a'</span>
1150063         <span class="keyword">if</span> Dtj&gt;0 || Dtj&lt;0
1160064             nom_type_pair=<span class="string">'#_ab'</span>;
1170065         <span class="keyword">end</span>
1180066     <span class="keyword">otherwise</span>
1190067         <span class="keyword">if</span> Dti&gt;0 || Dti&lt;0
1200068            nom_type_pair=<span class="string">'_i1-i2'</span>;
1210069         <span class="keyword">end</span>
1220070 <span class="keyword">end</span></pre></div>
123<hr><address>Generated on Fri 13-Nov-2009 11:17:03 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
124</body>
125</html>
Note: See TracBrowser for help on using the repository browser.