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

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

added doc repository at the same level than src
File size: 5.3 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 name2display</title>
6  <meta name="keywords" content="name2display">
7  <meta name="description" content="'name2display': extracts the root name and field numbers from an input filename">
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; name2display.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>name2display
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>'name2display': extracts the root name and field numbers from an input filename</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 [RootPath,RootFile,field_count,str2,str_a,str_b,ext,nom_type,subdir]=name2display(fileinput) </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">'name2display': extracts the root name and field numbers from an input filename
31--------------------------------------------------------------------
32[RootPath,RootFile,field_count,str2,str_a,str_b,ext,nom_type,subdir]=name2display(fileinput)
33
34OUTPUT:
35filebasesub: filename without appendix
36field_count: string for the first number i
37str2: string for the second number i (only for .nc files)
38str_a: string for the first number j
39str_b:string for the second number j (only for .nc files)
40ext: file extension
41nom_type: char chain characterizing the file nomenclature: with values
42   nom_type='': constant name [filebase ext] (default output if 'nom_type' is undefined)
43   nom_type='*':constant name for a file representing a series (e.g. avi movie)
44   nom_type='_i': series of files with a single index i preceded by '_'(e.g. 'aa_45.png').
45   nom_type='#', series of indexed images wich is not series_i [filebase index ext], e.g. 'aa045.jpg' or 'aa45.tif'
46   nom_type='_i_j': matrix of files with two indices i and j separated by '_'(e.g. 'aa_45_2.png')
47   nom_type='_i1-i2': from pairs from a single index (e.g. 'aa_45-47.nc')
48   nom_type='_i_j1-j2': pairs of j indices (e.g. 'aa_45_2-3.nc')
49   nom_type='_i1-i2_j': pairs of i indices (e.g. 'aa_45-46_2.nc')
50   nom_type='#a','#A&quot;, with a numerical index and an index letter(e.g.'aa045b.png') (lower or upper case)
51   nom_type='raw_SMD', same as '#' but with no extension ext='', OBSOLETE
52   nom_type='#_ab', from pairs of '#' images (e.g. 'aa045bc.nc'), ext='.nc', OBSOLETE (replaced by '_i_j1-j2')
53subdir: name of the subdirectory for netcdf files
54
55INPUT:
56fileinput: complete name of the file, including path</pre></div>
57
58<!-- crossreference -->
59<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
60This function calls:
61<ul style="list-style-image:url(../matlabicon.gif)">
62</ul>
63This function is called by:
64<ul style="list-style-image:url(../matlabicon.gif)">
65<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="civ_3D.html" class="code" title="function varargout = civ_3D(varargin)">civ_3D</a>        'civ_3D': function associated with the interface 'civ_3D.fig' for PIV in volume</li><li><a href="geometry_calib.html" class="code" title="function varargout = geometry_calib(varargin)">geometry_calib</a>     'geometry_calib': performs geometric calibration from a set of reference points</li><li><a href="name_generator.html" class="code" title="function [filename,num_i1_out,num_j1_out,num_i2_out,num_j2_out,subdir_out]=name_generator(filebase,num_i1,num_j1,ext,nom_type,comp_input,num_i2,num_j2,subdir);">name_generator</a>   'name_generator': creates a file name from a root name and indices.</li><li><a href="read_xls.html" class="code" title="function [hfig_xls]=read_xls(fileinput,hfig)">read_xls</a>      'read_xls': function for reading and displaying Excel files</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><li><a href="set_grid.html" class="code" title="function varargout = set_grid(varargin)">set_grid</a>    'set_grid':produce grid for PIV with one or two images (stereo case)</li><li><a href="uvmat.html" class="code" title="function varargout = uvmat(varargin)">uvmat</a>   'uvmat': function associated with the GUI 'uvmat.fig' for images and data field visualization</li></ul>
66<!-- crossreference -->
67
68
69
70<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>
71</body>
72</html>
Note: See TracBrowser for help on using the repository browser.