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 setrf</title> |
---|
6 | <meta name="keywords" content="setrf"> |
---|
7 | <meta name="description" content="SETRF - Sets the RF frequency"> |
---|
8 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
---|
9 | <meta name="generator" content="m2html © 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> > <a href="index.html">mml</a> > setrf.m</div> |
---|
16 | |
---|
17 | <!--<table width="100%"><tr><td align="left"><a href="../index.html"><img alt="<" border="0" src="../left.png"> Master index</a></td> |
---|
18 | <td align="right"><a href="index.html">Index for mml <img alt=">" border="0" src="../right.png"></a></td></tr></table>--> |
---|
19 | |
---|
20 | <h1>setrf |
---|
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>SETRF - Sets the RF frequency</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 setrf(RF, 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">SETRF - Sets the RF frequency |
---|
31 | setrf(RF, WaitFlag) |
---|
32 | |
---|
33 | INPUTS |
---|
34 | 1. RF - RF frequency |
---|
35 | 2. WaitFlag = 0 -> return immediately {SLAC default} |
---|
36 | > 0 -> wait until ramping is done then adds an extra delay equal to WaitFlag |
---|
37 | = -1 -> wait until ramping is done |
---|
38 | = -2 -> wait until ramping is done then adds an extra delay for fresh data |
---|
39 | from the BPMs {ALS default} |
---|
40 | = -3 -> wait until ramping is done then adds an extra delay for fresh data |
---|
41 | from the tune measurement system |
---|
42 | = -4 -> wait until ramping is done then wait for a carriage return |
---|
43 | 3. 'Physics' - Use physics units (optional override of units) |
---|
44 | 'Hardware' - Use hardware units (optional override of units) |
---|
45 | The actual physics or hardware strings can also be used. |
---|
46 | For example, if the physics and hardware modes corresponds |
---|
47 | to Hz and MHz then strings 'Hz' or 'MHz' can be used to specify units. |
---|
48 | 4. 'Online' - Set data online (optional override of the mode) |
---|
49 | 'Model' - Set data on the model (optional override of the mode) |
---|
50 | 'Manual' - Set data manually (optional override of the mode) |
---|
51 | |
---|
52 | setrf converts a string input to a number, hence, setrf 476.3 is the same as setrf(476.3) |
---|
53 | |
---|
54 | EXAMPES |
---|
55 | 1. setrf(476, 'MHz') or setrf 476 MHz => sets the RF frequency 476 KHz |
---|
56 | 2. setrf 476000000 Hz => sets the RF frequency 476 KHz |
---|
57 | |
---|
58 | NOTES |
---|
59 | 1. 'Hardware', 'Physics', 'MHz', 'Hz', 'Numeric', and 'Struct' are not case sensitive |
---|
60 | 2. The length(RFam) will equal the number of cavities in the ring |
---|
61 | |
---|
62 | Written by Greg Portmann</pre></div> |
---|
63 | |
---|
64 | <!-- crossreference --> |
---|
65 | <h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2> |
---|
66 | This function calls: |
---|
67 | <ul style="list-style-image:url(../matlabicon.gif)"> |
---|
68 | <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="setpv.html" class="code" title="function ErrorFlag = setpv(varargin)">setpv</a> SETPV - Setpoint change of the online system or model</li></ul> |
---|
69 | This function is called by: |
---|
70 | <ul style="list-style-image:url(../matlabicon.gif)"> |
---|
71 | <li><a href="findrf1.html" class="code" title="function [DeltaRF, RFnew, frf] = findrf1(DeltaRF, BPMFamily, BPMList, FileName)">findrf1</a> FINDRF1 - Finds the RF frequency that minimizes the horizonal dispersion</li><li><a href="measchro.html" class="code" title="function [Chromaticity, FileName] = measchro(varargin)">measchro</a> MEASCHRO - measures the chromaticity function emperically</li><li><a href="steprf.html" class="code" title="function steprf(varargin)">steprf</a> STEPRF - Increment change in the RF frequency</li></ul> |
---|
72 | <!-- crossreference --> |
---|
73 | |
---|
74 | |
---|
75 | <h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2> |
---|
76 | <div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function setrf(RF, varargin)</a> |
---|
77 | 0002 <span class="comment">%SETRF - Sets the RF frequency</span> |
---|
78 | 0003 <span class="comment">% setrf(RF, WaitFlag)</span> |
---|
79 | 0004 <span class="comment">%</span> |
---|
80 | 0005 <span class="comment">% INPUTS</span> |
---|
81 | 0006 <span class="comment">% 1. RF - RF frequency</span> |
---|
82 | 0007 <span class="comment">% 2. WaitFlag = 0 -> return immediately {SLAC default}</span> |
---|
83 | 0008 <span class="comment">% > 0 -> wait until ramping is done then adds an extra delay equal to WaitFlag</span> |
---|
84 | 0009 <span class="comment">% = -1 -> wait until ramping is done</span> |
---|
85 | 0010 <span class="comment">% = -2 -> wait until ramping is done then adds an extra delay for fresh data</span> |
---|
86 | 0011 <span class="comment">% from the BPMs {ALS default}</span> |
---|
87 | 0012 <span class="comment">% = -3 -> wait until ramping is done then adds an extra delay for fresh data</span> |
---|
88 | 0013 <span class="comment">% from the tune measurement system</span> |
---|
89 | 0014 <span class="comment">% = -4 -> wait until ramping is done then wait for a carriage return</span> |
---|
90 | 0015 <span class="comment">% 3. 'Physics' - Use physics units (optional override of units)</span> |
---|
91 | 0016 <span class="comment">% 'Hardware' - Use hardware units (optional override of units)</span> |
---|
92 | 0017 <span class="comment">% The actual physics or hardware strings can also be used.</span> |
---|
93 | 0018 <span class="comment">% For example, if the physics and hardware modes corresponds</span> |
---|
94 | 0019 <span class="comment">% to Hz and MHz then strings 'Hz' or 'MHz' can be used to specify units.</span> |
---|
95 | 0020 <span class="comment">% 4. 'Online' - Set data online (optional override of the mode)</span> |
---|
96 | 0021 <span class="comment">% 'Model' - Set data on the model (optional override of the mode)</span> |
---|
97 | 0022 <span class="comment">% 'Manual' - Set data manually (optional override of the mode)</span> |
---|
98 | 0023 <span class="comment">%</span> |
---|
99 | 0024 <span class="comment">% setrf converts a string input to a number, hence, setrf 476.3 is the same as setrf(476.3)</span> |
---|
100 | 0025 <span class="comment">%</span> |
---|
101 | 0026 <span class="comment">% EXAMPES</span> |
---|
102 | 0027 <span class="comment">% 1. setrf(476, 'MHz') or setrf 476 MHz => sets the RF frequency 476 KHz</span> |
---|
103 | 0028 <span class="comment">% 2. setrf 476000000 Hz => sets the RF frequency 476 KHz</span> |
---|
104 | 0029 <span class="comment">%</span> |
---|
105 | 0030 <span class="comment">% NOTES</span> |
---|
106 | 0031 <span class="comment">% 1. 'Hardware', 'Physics', 'MHz', 'Hz', 'Numeric', and 'Struct' are not case sensitive</span> |
---|
107 | 0032 <span class="comment">% 2. The length(RFam) will equal the number of cavities in the ring</span> |
---|
108 | 0033 <span class="comment">%</span> |
---|
109 | 0034 <span class="comment">% Written by Greg Portmann</span> |
---|
110 | 0035 |
---|
111 | 0036 |
---|
112 | 0037 <span class="keyword">if</span> nargin < 1 |
---|
113 | 0038 error(<span class="string">'No RF frequency input'</span>) |
---|
114 | 0039 <span class="keyword">end</span> |
---|
115 | 0040 <span class="keyword">if</span> ischar(RF) |
---|
116 | 0041 RF = str2num(RF); |
---|
117 | 0042 <span class="keyword">end</span> |
---|
118 | 0043 |
---|
119 | 0044 WaitFlag = []; |
---|
120 | 0045 |
---|
121 | 0046 |
---|
122 | 0047 <span class="comment">% Allow actual units for conversions</span> |
---|
123 | 0048 HWUnits = <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(<span class="string">'RF'</span>,<span class="string">'Setpoint'</span>,<span class="string">'HWUnits'</span>); |
---|
124 | 0049 PhysicsUnits = <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(<span class="string">'RF'</span>,<span class="string">'Setpoint'</span>,<span class="string">'PhysicsUnits'</span>); |
---|
125 | 0050 |
---|
126 | 0051 |
---|
127 | 0052 <span class="comment">% Input line search</span> |
---|
128 | 0053 <span class="keyword">for</span> i = length(varargin):-1:1 |
---|
129 | 0054 <span class="keyword">if</span> strcmpi(varargin{i}, <span class="string">'Struct'</span>) |
---|
130 | 0055 <span class="comment">% Pass input thru to setpv</span> |
---|
131 | 0056 <span class="keyword">elseif</span> strcmpi(varargin{i}, <span class="string">'Numeric'</span>) |
---|
132 | 0057 <span class="comment">% Pass input thru to setpv</span> |
---|
133 | 0058 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'simulator'</span>) || strcmpi(varargin{i},<span class="string">'model'</span>) |
---|
134 | 0059 <span class="comment">% Pass input thru to setpv</span> |
---|
135 | 0060 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'online'</span>) |
---|
136 | 0061 <span class="comment">% Pass input thru to setpv</span> |
---|
137 | 0062 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'manual'</span>) |
---|
138 | 0063 <span class="comment">% Pass input thru to setpv</span> |
---|
139 | 0064 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Inc'</span>) || strcmpi(varargin{i},<span class="string">'Incremental'</span>) |
---|
140 | 0065 <span class="comment">% Pass input thru to setpv</span> |
---|
141 | 0066 IncrementalFlag = 1; |
---|
142 | 0067 <span class="keyword">elseif</span> strcmpi(varargin{i}, <span class="string">'Physics'</span>) || strcmpi(varargin{i}, PhysicsUnits) |
---|
143 | 0068 varargin{i} = <span class="string">'Physics'</span>; |
---|
144 | 0069 <span class="keyword">elseif</span> strcmpi(varargin{i}, <span class="string">'Hardware'</span>) || strcmpi(varargin{i}, HWUnits) |
---|
145 | 0070 varargin{i} = <span class="string">'Hardware'</span>; |
---|
146 | 0071 <span class="keyword">elseif</span> isnumeric(varargin{i}) |
---|
147 | 0072 WaitFlag = varargin{i}; |
---|
148 | 0073 varargin(i) = []; |
---|
149 | 0074 <span class="keyword">else</span> |
---|
150 | 0075 <span class="keyword">if</span> ~isempty(varargin{i}) |
---|
151 | 0076 <span class="keyword">if</span> ischar(varargin{i}) |
---|
152 | 0077 fprintf(<span class="string">' Input ''%s'' ignored'</span>, varargin{i}); |
---|
153 | 0078 <span class="keyword">else</span> |
---|
154 | 0079 fprintf(<span class="string">' Input ''%f'' ignored'</span>, varargin{i}); |
---|
155 | 0080 <span class="keyword">end</span> |
---|
156 | 0081 <span class="keyword">end</span> |
---|
157 | 0082 varargin(i) = []; |
---|
158 | 0083 <span class="keyword">end</span> |
---|
159 | 0084 <span class="keyword">end</span> |
---|
160 | 0085 |
---|
161 | 0086 |
---|
162 | 0087 <span class="comment">% Set RF</span> |
---|
163 | 0088 <span class="keyword">if</span> isstruct(RF) |
---|
164 | 0089 <a href="setpv.html" class="code" title="function ErrorFlag = setpv(varargin)">setpv</a>(RF, WaitFlag, varargin{:}); |
---|
165 | 0090 <span class="keyword">else</span> |
---|
166 | 0091 <a href="setpv.html" class="code" title="function ErrorFlag = setpv(varargin)">setpv</a>(<span class="string">'RF'</span>, <span class="string">'Setpoint'</span>, RF, [], WaitFlag, varargin{:}); |
---|
167 | 0092 <span class="keyword">end</span> |
---|
168 | 0093 |
---|
169 | 0094 |
---|
170 | 0095 |
---|
171 | 0096 |
---|
172 | 0097 |
---|
173 | 0098 <span class="comment">% % Used for conversions</span> |
---|
174 | 0099 <span class="comment">% Units = getfamilydata('RF','Setpoint','Units');</span> |
---|
175 | 0100 <span class="comment">% HWUnits = getfamilydata('RF','Setpoint','HWUnits');</span> |
---|
176 | 0101 <span class="comment">% PhysicsUnits = getfamilydata('RF','Setpoint','PhysicsUnits');</span> |
---|
177 | 0102 <span class="comment">%</span> |
---|
178 | 0103 <span class="comment">%</span> |
---|
179 | 0104 <span class="comment">% % Input line search (if not a data structure)</span> |
---|
180 | 0105 <span class="comment">% if isstruct(RF)</span> |
---|
181 | 0106 <span class="comment">% UnitsInput = RF.Units;</span> |
---|
182 | 0107 <span class="comment">% UnitsString = RF.UnitsString;</span> |
---|
183 | 0108 <span class="comment">% RF = RF.Data;</span> |
---|
184 | 0109 <span class="comment">% else</span> |
---|
185 | 0110 <span class="comment">% UnitsInput = '';</span> |
---|
186 | 0111 <span class="comment">% for i = length(varargin):-1:1</span> |
---|
187 | 0112 <span class="comment">% if strcmpi(varargin{i}, 'Physics') | strcmpi(varargin{i}, PhysicsUnits)</span> |
---|
188 | 0113 <span class="comment">% UnitsInput = 'Physics';</span> |
---|
189 | 0114 <span class="comment">% elseif strcmpi(varargin{i}, 'Hardware') | strcmpi(varargin{i}, HWUnits)</span> |
---|
190 | 0115 <span class="comment">% UnitsInput = 'Hardware';</span> |
---|
191 | 0116 <span class="comment">% else</span> |
---|
192 | 0117 <span class="comment">% if ~isempty(varargin{i})</span> |
---|
193 | 0118 <span class="comment">% if ischar(varargin{i})</span> |
---|
194 | 0119 <span class="comment">% fprintf(' Input %s ignored', varargin{i});</span> |
---|
195 | 0120 <span class="comment">% else</span> |
---|
196 | 0121 <span class="comment">% fprintf(' Input %f ignored', varargin{i});</span> |
---|
197 | 0122 <span class="comment">% end</span> |
---|
198 | 0123 <span class="comment">% end</span> |
---|
199 | 0124 <span class="comment">% end</span> |
---|
200 | 0125 <span class="comment">% varargin(i) = [];</span> |
---|
201 | 0126 <span class="comment">% end</span> |
---|
202 | 0127 <span class="comment">% end</span> |
---|
203 | 0128 <span class="comment">%</span> |
---|
204 | 0129 <span class="comment">% % Convert units if necessary</span> |
---|
205 | 0130 <span class="comment">% if ~isempty(UnitsInput)</span> |
---|
206 | 0131 <span class="comment">% % 'Physics', 'Hardware', 'Hz', or 'Mz' was input</span> |
---|
207 | 0132 <span class="comment">% if strcmpi(UnitsInput, 'Physics') & strcmpi(Units, 'Hardware')</span> |
---|
208 | 0133 <span class="comment">% RF = physics2hw('RF', 'Setpoint', RF);</span> |
---|
209 | 0134 <span class="comment">% elseif strcmpi(UnitsInput, 'Physics') & strcmpi(Units, 'Physics')</span> |
---|
210 | 0135 <span class="comment">% % OK as is</span> |
---|
211 | 0136 <span class="comment">% elseif strcmpi(UnitsInput, 'Hardware') & strcmpi(Units, 'Physics')</span> |
---|
212 | 0137 <span class="comment">% RF = hw2physics('RF', 'Setpoint', RF);</span> |
---|
213 | 0138 <span class="comment">% elseif strcmpi(UnitsInput, 'Hardware') & strcmpi(Units, 'Hardware')</span> |
---|
214 | 0139 <span class="comment">% % OK as is</span> |
---|
215 | 0140 <span class="comment">% else</span> |
---|
216 | 0141 <span class="comment">% error(sprintf('"%s" units are an unknown type, hence no change to the RF frequency', UnitsInput));</span> |
---|
217 | 0142 <span class="comment">% end</span> |
---|
218 | 0143 <span class="comment">% end</span> |
---|
219 | 0144 <span class="comment">%</span> |
---|
220 | 0145 <span class="comment">%</span> |
---|
221 | 0146 <span class="comment">% setsp('RF', RF);</span></pre></div> |
---|
222 | <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> © 2003</address> |
---|
223 | </body> |
---|
224 | </html> |
---|