source: MML/trunk/mml/doc_html/mml/plotoffsetorbit.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: 9.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 plotoffsetorbit</title>
6  <meta name="keywords" content="plotoffsetorbit">
7  <meta name="description" content="PLOTOFFSETORBIT - Plots the offset orbit">
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; plotoffsetorbit.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>plotoffsetorbit
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>PLOTOFFSETORBIT - Plots the offset orbit</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 plotoffsetorbit(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">PLOTOFFSETORBIT - Plots the offset orbit
31  plotoffsetorbit(XAxisFlag)
32
33  INPUTS
34  1. XAxisFlag - 'Position' in meters {Default} or 'Phase'
35
36  See also <a href="plotgoldenorbit.html" class="code" title="function plotgoldenorbit(varargin)">plotgoldenorbit</a>
37
38 See also <a href="plotgoldenorbit.html" class="code" title="function plotgoldenorbit(varargin)">plotgoldenorbit</a>, <a href="setoffset.html" class="code" title="function varargout = setoffset(varargin)">setoffset</a>, <a href="getoffset.html" class="code" title="function Data = getoffset(varargin)">getoffset</a>, <a href="saveoffsetorbit.html" class="code" title="function saveoffsetorbit(FileName)">saveoffsetorbit</a></pre></div>
39
40<!-- crossreference -->
41<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
42This function calls:
43<ul style="list-style-image:url(../matlabicon.gif)">
44<li><a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>   FAMILY2DEV - Return the device list for a family</li><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="gethbpmfamily.html" class="code" title="function Family = gethbpmfamily">gethbpmfamily</a>   GETHBPMFAMILY - Return the default horizontal BPM family</li><li><a href="getoffset.html" class="code" title="function Data = getoffset(varargin)">getoffset</a>        GETOFFSET - Returns the offset values for a family</li><li><a href="getspos.html" class="code" title="function S = getspos(Family, DeviceList)">getspos</a>     GETSPOS - Returns the longitudinal position in meters</li><li><a href="getvbpmfamily.html" class="code" title="function Family = getvbpmfamily">getvbpmfamily</a>       GETVBPMFAMILY - Return the default vertical BPM family</li><li><a href="hw2physics.html" class="code" title="function S = hw2physics(Family, Field, value, DeviceList, Energy)">hw2physics</a>  HW2PHYSICS - Converts from 'Hardware' units to 'Physics' units</li></ul>
45This function is called by:
46<ul style="list-style-image:url(../matlabicon.gif)">
47</ul>
48<!-- crossreference -->
49
50
51<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
52<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function plotoffsetorbit(varargin)</a>
530002 <span class="comment">%PLOTOFFSETORBIT - Plots the offset orbit</span>
540003 <span class="comment">%  plotoffsetorbit(XAxisFlag)</span>
550004 <span class="comment">%</span>
560005 <span class="comment">%  INPUTS</span>
570006 <span class="comment">%  1. XAxisFlag - 'Position' in meters {Default} or 'Phase'</span>
580007 <span class="comment">%</span>
590008 <span class="comment">%  See also plotgoldenorbit</span>
600009 <span class="comment">%</span>
610010 <span class="comment">% See also plotgoldenorbit, setoffset, getoffset, saveoffsetorbit</span>
620011
630012 <span class="comment">%</span>
640013 <span class="comment">% Written by Gregory J. Portmann</span>
650014 <span class="comment">% Modifed by Laurent S. Nadolski</span>
660015
670016 XAxisFlag = <span class="string">'Position'</span>;
680017
690018 <span class="comment">% Input parsing</span>
700019 <span class="keyword">for</span> i = length(varargin):-1:1
710020     <span class="keyword">if</span> isstruct(varargin{i})
720021         <span class="comment">% Ignor structures</span>
730022     <span class="keyword">elseif</span> iscell(varargin{i})
740023         <span class="comment">% Ignor cells</span>
750024     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'struct'</span>)
760025         <span class="comment">% Just remove</span>
770026         varargin(i) = [];
780027     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'numeric'</span>)
790028         <span class="comment">% Just remove</span>
800029         varargin(i) = [];
810030     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Position'</span>)
820031         XAxisFlag = <span class="string">'Position'</span>;
830032         varargin(i) = [];
840033     <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'Phase'</span>)
850034         XAxisFlag = <span class="string">'Phase'</span>;
860035         varargin(i) = [];
870036     <span class="keyword">end</span>
880037 <span class="keyword">end</span>
890038
900039 BPMxFamily = <a href="gethbpmfamily.html" class="code" title="function Family = gethbpmfamily">gethbpmfamily</a>;
910040 BPMyFamily = <a href="getvbpmfamily.html" class="code" title="function Family = getvbpmfamily">getvbpmfamily</a>;
920041
930042 <span class="keyword">if</span> strcmpi(XAxisFlag, <span class="string">'Phase'</span>)
940043     [BPMxspos, BPMyspos, Sx, Sy, Tune] = modeltwiss(<span class="string">'Phase'</span>, BPMxFamily, [], BPMyFamily, []);
950044     BPMxspos = BPMxspos/2/pi;
960045     BPMyspos = BPMyspos/2/pi;
970046     XLabel = <span class="string">'BPM Phase'</span>;
980047 <span class="keyword">else</span>
990048     BPMxspos = <a href="getspos.html" class="code" title="function S = getspos(Family, DeviceList)">getspos</a>(BPMxFamily,<a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>(BPMxFamily));
1000049     BPMyspos = <a href="getspos.html" class="code" title="function S = getspos(Family, DeviceList)">getspos</a>(BPMyFamily,<a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>(BPMyFamily));
1010050     XLabel = <span class="string">'BPM Position [meters]'</span>;
1020051 <span class="keyword">end</span>
1030052
1040053
1050054 <span class="comment">% Get data</span>
1060055 Xoffset = <a href="getoffset.html" class="code" title="function Data = getoffset(varargin)">getoffset</a>(BPMxFamily);
1070056 Yoffset = <a href="getoffset.html" class="code" title="function Data = getoffset(varargin)">getoffset</a>(BPMyFamily);
1080057
1090058
1100059 <span class="comment">% Change to physics units</span>
1110060 <span class="keyword">if</span> any(strcmpi(<span class="string">'Physics'</span>,varargin))
1120061     Xoffset = <a href="hw2physics.html" class="code" title="function S = hw2physics(Family, Field, value, DeviceList, Energy)">hw2physics</a>(BPMxFamily, <span class="string">'Monitor'</span>, Xoffset, <a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>(BPMxFamily));
1130062     Yoffset = <a href="hw2physics.html" class="code" title="function S = hw2physics(Family, Field, value, DeviceList, Energy)">hw2physics</a>(BPMyFamily, <span class="string">'Monitor'</span>, Yoffset, <a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>(BPMyFamily));
1140063 <span class="keyword">end</span>
1150064
1160065 UnitsString = <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(<span class="string">'BPMx'</span>,<span class="string">'Monitor'</span>,<span class="string">'HWUnits'</span>);
1170066
1180067 clf reset
1190068 subplot(2,1,1);
1200069 plot(BPMxspos, Xoffset, <span class="string">'.-'</span>);
1210070 ylabel(sprintf(<span class="string">'Horizontal [%s]'</span>,UnitsString));
1220071 title(<span class="string">'Offset Orbit'</span>);
1230072 grid on
1240073
1250074 subplot(2,1,2);
1260075 plot(BPMyspos, Yoffset, <span class="string">'.-'</span>);
1270076 xlabel(XLabel);
1280077 ylabel(sprintf(<span class="string">'Vertical [%s]'</span>,UnitsString));
1290078 grid on
1300079
1310080 orient tall
1320081</pre></div>
133<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>
134</body>
135</html>
Note: See TracBrowser for help on using the repository browser.