source: MML/trunk/mml/at/doc_html/at/getcavity.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: 6.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 getcavity</title>
6  <meta name="keywords" content="getcavity">
7  <meta name="description" content="GETCAVITY - Returns the RF cavity state ('On' / 'Off')">
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">at</a> &gt; getcavity.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 at&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->
19
20<h1>getcavity
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>GETCAVITY - Returns the RF cavity state ('On' / 'Off')</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 [CavityState, PassMethod, ATCavityIndex, RF, HarmNumber] = getcavity </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">GETCAVITY - Returns the RF cavity state ('On' / 'Off')
31  [CavityState, PassMethod, ATCavityIndex, RF, HarmonicNumber] = getcavity
32
33  OUTPUTS
34  1. CavityState
35  2. PassMethod
36  3. ATCavityIndex - AT Index of the RF cavities
37  4. RF - RF frequency [Hz]
38  5. HarmonicNumber - Harmonic number
39
40  See also <a href="setcavity.html" class="code" title="function ATCavityIndex = setcavity(InputString)">setcavity</a>, <a href="setradiation.html" class="code" title="function [PassMethod, ATIndex, FamName, PassMethodOld, ATIndexOld, FamNameOld] = setradiation(InputString)">setradiation</a>
41
42  Written by Greg Portmann</pre></div>
43
44<!-- crossreference -->
45<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
46This function calls:
47<ul style="list-style-image:url(../matlabicon.gif)">
48</ul>
49This function is called by:
50<ul style="list-style-image:url(../matlabicon.gif)">
51<li><a href="calccoupling.html" class="code" title="function [Tilt, Eta, Ratio, ENV, DP, DL] = calccoupling">calccoupling</a>   CALCCOUPLING - Calculates the coupling and tilt of the AT model</li><li><a href="getharmonicnumber.html" class="code" title="function HarmNumber = getharmonicnumber">getharmonicnumber</a>     GETHARMONICNUMBER - Returns the harmonic number from the AT model</li><li><a href="getpvmodel.html" class="code" title="function [AM, tout, DataTime, ErrorFlag] = getpvmodel(varargin)">getpvmodel</a> GETPVMODEL - Get the model value</li><li><a href="modelchro.html" class="code" title="function [Chro, Tune] = modelchro(varargin)">modelchro</a>        MODELCHRO - Returns the AT model chromaticity</li><li><a href="modeldisp.html" class="code" title="function [Dx, Dy, Sx, Sy] = modeldisp(varargin)">modeldisp</a>       MODELDISP - Returns the dispersion function of the model</li><li><a href="modeltune.html" class="code" title="function [FractionalTune, IntegerTune] = modeltune">modeltune</a> MODELTUNE - Returns the model tune (2x1 vector)</li></ul>
52<!-- crossreference -->
53
54
55<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
56<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function [CavityState, PassMethod, ATCavityIndex, RF, HarmNumber] = getcavity</a>
570002 <span class="comment">%GETCAVITY - Returns the RF cavity state ('On' / 'Off')</span>
580003 <span class="comment">%  [CavityState, PassMethod, ATCavityIndex, RF, HarmonicNumber] = getcavity</span>
590004 <span class="comment">%</span>
600005 <span class="comment">%  OUTPUTS</span>
610006 <span class="comment">%  1. CavityState</span>
620007 <span class="comment">%  2. PassMethod</span>
630008 <span class="comment">%  3. ATCavityIndex - AT Index of the RF cavities</span>
640009 <span class="comment">%  4. RF - RF frequency [Hz]</span>
650010 <span class="comment">%  5. HarmonicNumber - Harmonic number</span>
660011 <span class="comment">%</span>
670012 <span class="comment">%  See also setcavity, setradiation</span>
680013 <span class="comment">%</span>
690014 <span class="comment">%  Written by Greg Portmann</span>
700015
710016
720017 <span class="keyword">global</span> THERING
730018
740019 ATCavityIndex = findcells(THERING, <span class="string">'Frequency'</span>);
750020
760021 CavityState = <span class="string">''</span>;
770022 PassMethod = <span class="string">''</span>;
780023 RF = [];
790024 HarmNumber = [];
800025
810026 <span class="keyword">if</span> isempty(ATCavityIndex)
820027     <span class="comment">%disp('   No cavities were found in the lattice');</span>
830028     <span class="keyword">return</span>
840029 <span class="keyword">end</span>
850030
860031 ATCavityIndex =ATCavityIndex(:)';
870032 <span class="keyword">for</span> ii = ATCavityIndex(:)'
880033     <span class="keyword">if</span> strcmpi(THERING{ii}.PassMethod, <span class="string">'DriftPass'</span>) || strcmpi(THERING{ii}.PassMethod, <span class="string">'IdentityPass'</span>)
890034         CavityState = strvcat(CavityState,<span class="string">'Off'</span>);
900035     <span class="keyword">else</span>
910036         CavityState = strvcat(CavityState,<span class="string">'On'</span>);
920037     <span class="keyword">end</span>
930038     PassMethod = strvcat(PassMethod, THERING{ii}.PassMethod);
940039     RF =  [RF; THERING{ii}.Frequency];
950040     
960041     <span class="keyword">if</span> isfield(THERING{ii}, <span class="string">'HarmNumber'</span>)
970042         HarmNumber = THERING{ii}.HarmNumber;
980043     <span class="keyword">end</span>
990044 <span class="keyword">end</span>
1000045
1010046 ATCavityIndex = ATCavityIndex(:);
1020047
1030048</pre></div>
104<hr><address>Generated on Fri 18-May-2007 17:13:39 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
105</body>
106</html>
Note: See TracBrowser for help on using the repository browser.