source: trunk/src/uvmat_doc/FUNCTIONS_DOC/imadoc2struct.html @ 48

Last change on this file since 48 was 37, checked in by sommeria, 15 years ago

create_grid.fig ,
uvmat_doc and all the included files added
File size: 13.2 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 imadoc2struct</title>
6  <meta name="keywords" content="imadoc2struct">
7  <meta name="description" content="'imadoc2struct': reads the xml file for image documentation">
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; imadoc2struct.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>imadoc2struct
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>'imadoc2struct': reads the xml file for image documentation</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 [s,errormsg]=imadoc2struct(ImaDoc) </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">'imadoc2struct': reads the xml file for image documentation
31
32function [s,errormsg]=imadoc2struct(ImaDoc)
33--------------------------------------------------------
34 OUTPUT:
35 s: structutre representing ImaDoc
36 errormsg: error message
37
38 INPUT:
39 ImaDoc: full name of the xml input file with head key ImaDoc</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="RUN_STLIN.html" class="code" title="function RUN_STLIN(file_A,file_B,vel_type,file_st,nx_patch,ny_patch,thresh_patch,fileAxml,fileBxml)">RUN_STLIN</a>     'RUN_STLIN': combine velocity fields for stereo PIV</li><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="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>
49<!-- crossreference -->
50
51<h2><a name="_subfunctions"></a>SUBFUNCTIONS <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
52<ul style="list-style-image:url(../matlabicon.gif)">
53<li><a href="#_sub1" class="code">function abs_time=get_time(BurstTiming)</a></li><li><a href="#_sub2" class="code">function tsai=get_GeometryCalib(s)</a></li></ul>
54<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
55<div class="fragment"><pre>0001 <span class="comment">%'imadoc2struct': reads the xml file for image documentation</span>
560002 <span class="comment">%</span>
570003 <span class="comment">%function [s,errormsg]=imadoc2struct(ImaDoc)</span>
580004 <span class="comment">%--------------------------------------------------------</span>
590005 <span class="comment">% OUTPUT:</span>
600006 <span class="comment">% s: structutre representing ImaDoc</span>
610007 <span class="comment">% errormsg: error message</span>
620008 <span class="comment">%</span>
630009 <span class="comment">% INPUT:</span>
640010 <span class="comment">% ImaDoc: full name of the xml input file with head key ImaDoc</span>
650011
660012 <a name="_sub0" href="#_subfunctions" class="code">function [s,errormsg]=imadoc2struct(ImaDoc) </a>
670013 s=[];
680014 errormsg=[];<span class="comment">%default</span>
690015 <span class="keyword">try</span>
700016     t=xmltree(ImaDoc);
710017 <span class="keyword">catch</span>
720018     errormsg={[ImaDoc <span class="string">' is not a valid xml file'</span>]; lasterr};
730019     display(errormsg);
740020     <span class="keyword">return</span>
750021 <span class="keyword">end</span>
760022 RootKey=get(t,1,<span class="string">'name'</span>);
770023 <span class="keyword">if</span> ~isequal(RootKey,<span class="string">'ImaDoc'</span>)
780024     errormsg=[ImaDoc <span class="string">' is not an image documentation file'</span>];
790025     <span class="keyword">return</span>
800026 <span class="keyword">end</span>     
810027 s=convert(t);
820028 s.Time=[];<span class="comment">%default</span>
830029 <span class="keyword">if</span> isfield(s,<span class="string">'Camera'</span>)
840030     <span class="keyword">if</span> isfield(s.Camera,<span class="string">'BurstTiming'</span>)
850031         s.Time=<a href="#_sub1" class="code" title="subfunction abs_time=get_time(BurstTiming)">get_time</a>(s.Camera.BurstTiming);
860032         s.Camera=rmfield(s.Camera,<span class="string">'BurstTiming'</span>);
870033     <span class="keyword">end</span>
880034 <span class="keyword">end</span>
890035 <span class="keyword">if</span> isfield(s,<span class="string">'GeometryCalib'</span>)
900036     s.GeometryCalib=<a href="#_sub2" class="code" title="subfunction tsai=get_GeometryCalib(s)">get_GeometryCalib</a>(s.GeometryCalib);
910037 <span class="keyword">end</span> 
920038
930039 <span class="comment">%----------------------------------------</span>
940040 <a name="_sub1" href="#_subfunctions" class="code">function abs_time=get_time(BurstTiming)</a>
950041 abs_time=[];
960042 <span class="keyword">for</span> k=1:length(BurstTiming)
970043     
980044     Frequency=1;<span class="comment">%default</span>
990045     <span class="keyword">if</span> isfield(BurstTiming,<span class="string">'FrameFrequency'</span>)&amp;&amp;~isempty(BurstTiming.FrameFrequency)
1000046         Frequency=str2double(BurstTiming.FrameFrequency);
1010047     <span class="keyword">end</span>
1020048     
1030049     Dtj=[];<span class="comment">%default</span>
1040050     <span class="keyword">if</span> isfield(BurstTiming,<span class="string">'Dtj'</span>)
1050051        Dtj=str2num(BurstTiming.Dtj);
1060052     <span class="keyword">end</span>
1070053     
1080054     NbDtj=1;<span class="comment">%default</span>
1090055     <span class="keyword">if</span> isfield(BurstTiming,<span class="string">'NbDtj'</span>)&amp;&amp;~isempty(BurstTiming.NbDtj)
1100056         NbDtj=str2double(BurstTiming.NbDtj);
1110057     <span class="keyword">end</span>
1120058     Dti=[]; <span class="comment">%default</span>
1130059     <span class="keyword">if</span> isfield(BurstTiming,<span class="string">'Dti'</span>) 
1140060         Dti=str2num(BurstTiming.Dti);
1150061     <span class="keyword">end</span>
1160062     
1170063     NbDti=1;<span class="comment">%default</span>
1180064     <span class="keyword">if</span> isfield(BurstTiming,<span class="string">'NbDti'</span>)&amp;&amp;~isempty(BurstTiming.NbDti) 
1190065        NbDti=str2double(BurstTiming.NbDti);
1200066     <span class="keyword">end</span>   
1210067     <span class="keyword">if</span> ~isempty(Dtj)
1220068         Dtj=reshape(Dtj'*ones(1,NbDtj),1,length(Dtj)*NbDtj);
1230069     <span class="keyword">end</span>
1240070     Dtj=[0 Dtj];
1250071     dtunit=Dtj/Frequency;   
1260072     Time=[];<span class="comment">%default</span>
1270073     <span class="keyword">if</span> isfield(BurstTiming,<span class="string">'Time'</span>) &amp;&amp; ~isempty(BurstTiming.Time)
1280074         <span class="comment">%nbfield=length(BurstTiming.Time)</span>
1290075         <span class="keyword">if</span> ischar(BurstTiming.Time)
1300076              Time(1,1)=str2num(BurstTiming.Time);
1310077              nbfield=1;
1320078         <span class="keyword">else</span>
1330079             nbfield=length(BurstTiming.Time);
1340080              <span class="keyword">for</span> itime=1:nbfield   
1350081                  Time(itime,1)=str2num(BurstTiming.Time{itime});
1360082              <span class="keyword">end</span>
1370083         <span class="keyword">end</span>
1380084         abstime_read=Time*ones(1,length(Dtj))+ones(nbfield,1)*cumsum(dtunit);
1390085         abs_time=[abs_time;abstime_read];
1400086         <span class="keyword">if</span> ~isempty(Dti) &amp;&amp; size(abs_time,1)==1
1410087            abs_time=ones(NbDti+1,1)*abs_time+(Dti/Frequency)*(0:NbDti)'*ones(size(abs_time));
1420088         <span class="keyword">end</span>
1430089     <span class="keyword">end</span>
1440090 <span class="keyword">end</span>
1450091
1460092 <span class="comment">%----------------------------------------------------------------</span>
1470093 <a name="_sub2" href="#_subfunctions" class="code">function tsai=get_GeometryCalib(s)</a>
1480094 <span class="comment">%default values:</span>
1490095 tsai.f=1;
1500096 tsai.dpx=1;
1510097 tsai.dpy=1;
1520098 tsai.sx=1;
1530099 tsai.Cx=0;
1540100 tsai.Cy=0;
1550101 tsai.Tx=0;
1560102 tsai.Ty=0;
1570103 tsai.Tz=1;
1580104 tsai.R=[1 0 0; 0 1 0; 0 0 0];
1590105 tsai.kappa1=0;
1600106 <span class="keyword">if</span> isfield(s,<span class="string">'focal'</span>)
1610107     tsai.f=str2double(s.focal);
1620108 <span class="keyword">end</span>
1630109 <span class="keyword">if</span> isfield(s,<span class="string">'dpx_dpy'</span>)
1640110     dpx_dpy=str2num(s.dpx_dpy);
1650111     tsai.dpx=dpx_dpy(1);
1660112     tsai.dpy=dpx_dpy(2);
1670113 <span class="keyword">end</span>
1680114 <span class="keyword">if</span> isfield(s,<span class="string">'sx'</span>)
1690115     tsai.sx=str2double(s.sx);
1700116 <span class="keyword">end</span>
1710117 <span class="keyword">if</span> isfield(s,<span class="string">'Cx_Cy'</span>)
1720118     Cx_Cy=str2num(s.Cx_Cy);
1730119     tsai.Cx=Cx_Cy(1);
1740120     tsai.Cy=Cx_Cy(2);
1750121 <span class="keyword">end</span>
1760122 <span class="keyword">if</span> isfield(s,<span class="string">'Tx_Ty_Tz'</span>)
1770123     Tx_Ty_Tz=str2num(s.Tx_Ty_Tz);
1780124     tsai.Tx=Tx_Ty_Tz(1);
1790125     tsai.Ty=Tx_Ty_Tz(2);
1800126     tsai.Tz=Tx_Ty_Tz(3);
1810127 <span class="keyword">end</span>
1820128 <span class="keyword">if</span> isfield(s,<span class="string">'R'</span>)
1830129     tsai.R=[str2num(s.R{1});str2num(s.R{2});str2num(s.R{3})];
1840130 <span class="keyword">end</span>
1850131 <span class="keyword">if</span> isfield(s,<span class="string">'kappa1'</span>)
1860132     tsai.kappa1=str2double(s.kappa1);
1870133 <span class="keyword">end</span>
1880134 <span class="keyword">if</span> isfield(s,<span class="string">'SliceOrigin'</span>)
1890135     <span class="keyword">if</span> ischar(s.SliceOrigin)
1900136         tsai.SliceOrigin=str2num(s.SliceOrigin);
1910137     <span class="keyword">end</span>
1920138 <span class="keyword">end</span>
1930139 <span class="keyword">if</span> isfield(s,<span class="string">'SliceDZ'</span>)
1940140 <span class="comment">%     SliceOrigin=0;</span>
1950141 <span class="comment">%     SliceOZ=1;%default</span>
1960142     NbSlice=1;<span class="comment">%default</span>
1970143     <span class="keyword">if</span> ischar(s.NbSlice)
1980144         NbSlice=str2double(s.NbSlice);
1990145     <span class="keyword">end</span>
2000146     <span class="keyword">if</span> ischar(s.SliceOrigin)
2010147         SliceOrigin=str2num(s.SliceOrigin);
2020148         <span class="keyword">if</span> length(SliceOrigin)==3
2030149             tsai.SliceCoord(1,:)=SliceOrigin;<span class="comment">%to generalize for angles</span>
2040150         <span class="keyword">end</span>
2050151     <span class="keyword">end</span>
2060152     <span class="keyword">if</span> ischar(s.SliceDZ)
2070153         SliceOZ=str2double(s.SliceDZ);
2080154         tsai.SliceCoord=tsai.SliceZ+SliceOZ*(0:NbSlice-1);
2090155     <span class="keyword">end</span>
2100156     <span class="keyword">if</span> iscell(s.SliceDZ)
2110157         <span class="keyword">for</span> j=1:length(s.SliceDZ)
2120158             tsai.SliceCoord(j,:)=tsai.SliceZ(j-1,:)+str2num(s.SliceDZ{j});
2130159         <span class="keyword">end</span>
2140160     <span class="keyword">end</span>
2150161 <span class="keyword">end</span>
2160162 <span class="keyword">if</span> isfield(s,<span class="string">'PlanePos'</span>)<span class="comment">%Obsolete</span>
2170163     <span class="keyword">if</span> ischar(s.PlanePos)
2180164         tsai.SliceCoord(1,:)=str2num(s.PlanePos);
2190165     <span class="keyword">else</span>
2200166         <span class="keyword">for</span> j=1:length(s.PlanePos)
2210167             PlanePos=str2num(s.PlanePos{j});
2220168             tsai.SliceCoord(j,:)=PlanePos;
2230169         <span class="keyword">end</span>
2240170     <span class="keyword">end</span>
2250171 <span class="keyword">end</span>
2260172
2270173 <span class="comment">%look for laser plane definitions</span>
2280174
2290175
2300176
2310177</pre></div>
232<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>
233</body>
234</html>
Note: See TracBrowser for help on using the repository browser.