source: MML/trunk/mml/doc_html/mml/getchro.html @ 4

Last change on this file since 4 was 4, checked in by zhangj, 10 years ago

Initial import--MML version from SOLEIL@2013
File size: 10.0 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 getchro</title>
6  <meta name="keywords" content="getchro">
7  <meta name="description" content="GETCHRO - Return the chromaticity function (from file)">
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">mml</a> &gt; getchro.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 mml&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->
19
20<h1>getchro
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>GETCHRO - Return the chromaticity function (from file)</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 [Data, FileName] = getchro(varargin) </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">GETCHRO - Return the chromaticity function (from file)
31  [Data, FileName] = getchro(Plane, FileName)
32
33
34  INPUTS
35  1. Plane - 'x' or 'Horizontal'
36             'y' or 'z' or 'Vertical'
37  2. FileName - {Default start directory: &lt;OpsData&gt;&lt;ChroFile&gt;}
38
39  Extra Flags:
40  1. 'Physics'  - For actual chromaticity units {Default}
41     'Hardware' - For hardware units, usually mm/MHz
42  2. 'Struct'  - Data structures instead of vectors
43     'Numeric' - Vector outputs {Default}
44  3. Optional override of the mode
45     'Model' or 'Simulator' - Get the model chromaticity directly from AT
46                              (same as measchro([], Family, DeviceList, 'Model'))
47
48  OUTPUTS
49  1. Data - Chromaticity data
50 
51  See also <a href="getrespmat.html" class="code" title="function [S, FileName] = getrespmat(varargin)">getrespmat</a> <a href="setchro.html" class="code" title="function [DelSext, ActuatorFamily] = setchro(varargin)">setchro</a>
52
53  Written by Greg Portmann</pre></div>
54
55<!-- crossreference -->
56<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
57This function calls:
58<ul style="list-style-image:url(../matlabicon.gif)">
59<li><a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>  GETFAMILYDATA - Gets data associated with the accelerator control</li><li><a href="getrespmat.html" class="code" title="function [S, FileName] = getrespmat(varargin)">getrespmat</a>   GETRESPMAT - Get response matrix data from a file</li><li><a href="isfamily.html" class="code" title="function  [FamilyFlag, AO] = isfamily(Family, Field)">isfamily</a>        ISFAMILY - True for family names</li><li><a href="measchro.html" class="code" title="function [Chromaticity, FileName] = measchro(varargin)">measchro</a>       MEASCHRO -  measures the chromaticity function emperically</li></ul>
60This function is called by:
61<ul style="list-style-image:url(../matlabicon.gif)">
62<li><a href="plotchro.html" class="code" title="function [c, FileName] = plotchro(varargin)">plotchro</a>       PLOTCHRO - Plot the chromaticity function</li></ul>
63<!-- crossreference -->
64
65
66<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
67<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function [Data, FileName] = getchro(varargin)</a>
680002 <span class="comment">%GETCHRO - Return the chromaticity function (from file)</span>
690003 <span class="comment">%  [Data, FileName] = getchro(Plane, FileName)</span>
700004 <span class="comment">%</span>
710005 <span class="comment">%</span>
720006 <span class="comment">%  INPUTS</span>
730007 <span class="comment">%  1. Plane - 'x' or 'Horizontal'</span>
740008 <span class="comment">%             'y' or 'z' or 'Vertical'</span>
750009 <span class="comment">%  2. FileName - {Default start directory: &lt;OpsData&gt;&lt;ChroFile&gt;}</span>
760010 <span class="comment">%</span>
770011 <span class="comment">%  Extra Flags:</span>
780012 <span class="comment">%  1. 'Physics'  - For actual chromaticity units {Default}</span>
790013 <span class="comment">%     'Hardware' - For hardware units, usually mm/MHz</span>
800014 <span class="comment">%  2. 'Struct'  - Data structures instead of vectors</span>
810015 <span class="comment">%     'Numeric' - Vector outputs {Default}</span>
820016 <span class="comment">%  3. Optional override of the mode</span>
830017 <span class="comment">%     'Model' or 'Simulator' - Get the model chromaticity directly from AT</span>
840018 <span class="comment">%                              (same as measchro([], Family, DeviceList, 'Model'))</span>
850019 <span class="comment">%</span>
860020 <span class="comment">%  OUTPUTS</span>
870021 <span class="comment">%  1. Data - Chromaticity data</span>
880022 <span class="comment">%</span>
890023 <span class="comment">%  See also getrespmat setchro</span>
900024 <span class="comment">%</span>
910025 <span class="comment">%  Written by Greg Portmann</span>
920026
930027 ModelFlag = 0;
940028 FileName = <span class="string">''</span>;
950029
960030 InputFlags = {};
970031 <span class="keyword">for</span> i = length(varargin):-1:1
980032     <span class="keyword">if</span> isstruct(varargin{i})
990033         <span class="comment">% Ignore structures</span>
1000034     <span class="keyword">elseif</span> iscell(varargin{i})
1010035         <span class="comment">% Ignore cells</span>
1020036     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Struct'</span>)
1030037         InputFlags = [InputFlags varargin(i)];
1040038         varargin(i) = [];
1050039     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Numeric'</span>)
1060040         InputFlags = [InputFlags varargin(i)];
1070041         varargin(i) = [];
1080042     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Simulator'</span>) || strcmpi(varargin{i},<span class="string">'Model'</span>)
1090043         ModelFlag = 1;
1100044         varargin(i) = [];
1110045     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Physics'</span>)
1120046         InputFlags = [InputFlags varargin(i)];
1130047         varargin(i) = [];
1140048     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Hardware'</span>)
1150049         InputFlags = [InputFlags varargin(i)];
1160050         varargin(i) = [];
1170051     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'NoDisplay'</span>)
1180052         varargin(i) = [];
1190053     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Display'</span>)
1200054         varargin(i) = [];
1210055     <span class="keyword">elseif</span> ischar(varargin{i}) &amp;&amp; ~<a href="isfamily.html" class="code" title="function  [FamilyFlag, AO] = isfamily(Family, Field)">isfamily</a>(varargin{i})
1220056         FileName = varargin{i};
1230057         varargin(i) = [];
1240058     <span class="keyword">end</span>
1250059 <span class="keyword">end</span>
1260060
1270061
1280062 <span class="comment">% Default units</span>
1290063 <span class="keyword">if</span> ~any(strcmpi(InputFlags,<span class="string">'Physics'</span>)) &amp;&amp; ~any(strcmpi(InputFlags,<span class="string">'Hardware'</span>))
1300064     InputFlags{length(InputFlags)+1} = <span class="string">'Physics'</span>;
1310065 <span class="keyword">end</span>
1320066
1330067
1340068 <span class="comment">% Look in the chromaticity file</span>
1350069 <span class="keyword">if</span> ModelFlag == 1
1360070     Data = <a href="measchro.html" class="code" title="function [Chromaticity, FileName] = measchro(varargin)">measchro</a>(<span class="string">'Model'</span>, InputFlags{:});
1370071     FileName = <span class="string">''</span>;
1380072 <span class="keyword">else</span>
1390073     <span class="keyword">if</span> FileName == -1
1400074         FileName = <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(<span class="string">'OpsData'</span>,<span class="string">'ChroFile'</span>);
1410075         DirectoryName = <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(<span class="string">'Directory'</span>, <span class="string">'OpsData'</span>);
1420076         FileName = [DirectoryName FileName];
1430077     <span class="keyword">elseif</span> isempty(FileName)
1440078         [FileName, DirectoryName] = uigetfile(<span class="string">'*.mat'</span>, <span class="string">'Select a Chromaticity File?'</span>, <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(<span class="string">'Directory'</span>,<span class="string">'ChroData'</span>));
1450079         <span class="keyword">if</span> ~ischar(FileName)
1460080             <span class="keyword">return</span>
1470081         <span class="keyword">else</span>
1480082             FileName = [DirectoryName FileName];
1490083         <span class="keyword">end</span>
1500084     <span class="keyword">end</span>
1510085     [Data, FileName] = <a href="getrespmat.html" class="code" title="function [S, FileName] = getrespmat(varargin)">getrespmat</a>(<span class="string">'TUNE'</span>, [1 1;1 2], <span class="string">'RF'</span>, [], FileName, InputFlags{:});
1520086     <span class="comment">%[Data, FileName] = getdata('Chromaticity',FileName, InputFlags{:});</span>
1530087 <span class="keyword">end</span>
1540088</pre></div>
155<hr><address>Generated on Mon 21-May-2007 15:29:18 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
156</body>
157</html>
Note: See TracBrowser for help on using the repository browser.