[4] | 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 getroll</title> |
---|
| 6 | <meta name="keywords" content="getroll"> |
---|
| 7 | <meta name="description" content="GETROLL - Returns the roll values for a family (radians)"> |
---|
| 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> > getroll.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>getroll |
---|
| 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>GETROLL - Returns the roll values for a family (radians)</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 = getroll(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">GETROLL - Returns the roll values for a family (radians) |
---|
| 31 | Roll = getroll(Family, Field, DeviceList) |
---|
| 32 | Roll = getroll(Family, DeviceList) |
---|
| 33 | Roll = getroll(Family) |
---|
| 34 | |
---|
| 35 | INPUTS |
---|
| 36 | 1. Family - Family Name |
---|
| 37 | Data Structure |
---|
| 38 | Accelerator Object |
---|
| 39 | 2. Field - Accelerator Object field name ('Monitor', 'Setpoint', etc) {Default: 'Monitor' for BPM, 'Setpoint' for magnet} |
---|
| 40 | 3. DeviceList ([Sector Device #] or [element #]) {Default: whole family} |
---|
| 41 | 4. 'Physics' or 'Hardware' inputs are ignored |
---|
| 42 | 5. 'Numeric' - Numeric output {Default} |
---|
| 43 | 'Struct' - Data structure output |
---|
| 44 | |
---|
| 45 | OUTPUTS |
---|
| 46 | 1. Roll - Roll value for the family [radians] {Default: 0} |
---|
| 47 | |
---|
| 48 | NOTES |
---|
| 49 | 1. If Family is a cell array, then DeviceList can also be a cell arrays |
---|
| 50 | |
---|
| 51 | See also: <a href="getgain.html" class="code" title="function Data = getgain(varargin)">getgain</a>, <a href="getcrunch.html" class="code" title="function Data = getcrunch(varargin)">getcrunch</a>, <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>, <a href="getgolden.html" class="code" title="function Data = getgolden(varargin)">getgolden</a>, <a href="raw2real.html" class="code" title="function DataOut = raw2real(varargin)">raw2real</a>, <a href="real2raw.html" class="code" title="function DataOut = real2raw(varargin)">real2raw</a></pre></div> |
---|
| 52 | |
---|
| 53 | <!-- crossreference --> |
---|
| 54 | <h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2> |
---|
| 55 | This function calls: |
---|
| 56 | <ul style="list-style-image:url(../matlabicon.gif)"> |
---|
| 57 | <li><a href="family2datastruct.html" class="code" title="function [DataStruct, ErrorFlag] = family2datastruct(varargin)">family2datastruct</a> FAMILY2DATASTRUCTURE - Returns a datastructure corresponding to 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="getphysdata.html" class="code" title="function [Data, iNotFound] = getphysdata(Family, Field, DeviceList)">getphysdata</a> GETPHYSDATA - Gets physics data</li><li><a href="getroll.html" class="code" title="function Data = getroll(varargin)">getroll</a> GETROLL - Returns the roll values for a family (radians)</li><li><a href="getunits.html" class="code" title="function [Units, UnitsString] = getunits(Family, Field)">getunits</a> GETUNITS - Return the present family units and units string</li><li><a href="inputparsingffd.html" class="code" title="function [Family, Field, DeviceList, UnitsFlag, ModelFlag] = inputparsingffd(varargin)">inputparsingffd</a> INPUTPARSINGFFD - Parses the typical input line of Family, Field, DeviceList</li><li><a href="ismemberof.html" class="code" title="function [IsTest, Index] = ismemberof(FamilyName, Field, MemberString)">ismemberof</a> ISMEMBEROF - Returns turn if the membership information of a family (cell of strings)</li></ul> |
---|
| 58 | This function is called by: |
---|
| 59 | <ul style="list-style-image:url(../matlabicon.gif)"> |
---|
| 60 | <li><a href="getroll.html" class="code" title="function Data = getroll(varargin)">getroll</a> GETROLL - Returns the roll values for a family (radians)</li><li><a href="quadplot.html" class="code" title="function [QMS, WarningString] = quadplot(Input1, FigureHandle, sigmaBPM)">quadplot</a> QUADPLOT - Plots quadrupole centering data</li><li><a href="quadplotphysics.html" class="code" title="function [QMS, WarningString] = quadplotphysics(Input1, FigureHandle, sigmaBPM)">quadplotphysics</a> QUADPLOTPHYSICS - Plots quadrupole centering data in physics units</li></ul> |
---|
| 61 | <!-- crossreference --> |
---|
| 62 | |
---|
| 63 | |
---|
| 64 | <h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2> |
---|
| 65 | <div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function Data = getroll(varargin)</a> |
---|
| 66 | 0002 <span class="comment">%GETROLL - Returns the roll values for a family (radians)</span> |
---|
| 67 | 0003 <span class="comment">% Roll = getroll(Family, Field, DeviceList)</span> |
---|
| 68 | 0004 <span class="comment">% Roll = getroll(Family, DeviceList)</span> |
---|
| 69 | 0005 <span class="comment">% Roll = getroll(Family)</span> |
---|
| 70 | 0006 <span class="comment">%</span> |
---|
| 71 | 0007 <span class="comment">% INPUTS</span> |
---|
| 72 | 0008 <span class="comment">% 1. Family - Family Name</span> |
---|
| 73 | 0009 <span class="comment">% Data Structure</span> |
---|
| 74 | 0010 <span class="comment">% Accelerator Object</span> |
---|
| 75 | 0011 <span class="comment">% 2. Field - Accelerator Object field name ('Monitor', 'Setpoint', etc) {Default: 'Monitor' for BPM, 'Setpoint' for magnet}</span> |
---|
| 76 | 0012 <span class="comment">% 3. DeviceList ([Sector Device #] or [element #]) {Default: whole family}</span> |
---|
| 77 | 0013 <span class="comment">% 4. 'Physics' or 'Hardware' inputs are ignored</span> |
---|
| 78 | 0014 <span class="comment">% 5. 'Numeric' - Numeric output {Default}</span> |
---|
| 79 | 0015 <span class="comment">% 'Struct' - Data structure output</span> |
---|
| 80 | 0016 <span class="comment">%</span> |
---|
| 81 | 0017 <span class="comment">% OUTPUTS</span> |
---|
| 82 | 0018 <span class="comment">% 1. Roll - Roll value for the family [radians] {Default: 0}</span> |
---|
| 83 | 0019 <span class="comment">%</span> |
---|
| 84 | 0020 <span class="comment">% NOTES</span> |
---|
| 85 | 0021 <span class="comment">% 1. If Family is a cell array, then DeviceList can also be a cell arrays</span> |
---|
| 86 | 0022 <span class="comment">%</span> |
---|
| 87 | 0023 <span class="comment">% See also: getgain, getcrunch, getfamilydata, getgolden, raw2real, real2raw</span> |
---|
| 88 | 0024 |
---|
| 89 | 0025 <span class="comment">%</span> |
---|
| 90 | 0026 <span class="comment">% Written by Gregory Portmann</span> |
---|
| 91 | 0027 |
---|
| 92 | 0028 |
---|
| 93 | 0029 <span class="comment">%%%%%%%%%%%%%%%%%</span> |
---|
| 94 | 0030 <span class="comment">% Input Parsing %</span> |
---|
| 95 | 0031 <span class="comment">%%%%%%%%%%%%%%%%%</span> |
---|
| 96 | 0032 UnitsFlagCell = {}; |
---|
| 97 | 0033 StructOutputFlag = 0; |
---|
| 98 | 0034 <span class="keyword">for</span> i = length(varargin):-1:1 |
---|
| 99 | 0035 <span class="keyword">if</span> isstruct(varargin{i}) |
---|
| 100 | 0036 <span class="comment">% Ignor structures</span> |
---|
| 101 | 0037 <span class="keyword">elseif</span> iscell(varargin{i}) |
---|
| 102 | 0038 <span class="comment">% Ignor cells</span> |
---|
| 103 | 0039 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'struct'</span>) |
---|
| 104 | 0040 StructOutputFlag = 1; |
---|
| 105 | 0041 varargin(i) = []; |
---|
| 106 | 0042 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'numeric'</span>) |
---|
| 107 | 0043 StructOutputFlag = 0; |
---|
| 108 | 0044 varargin(i) = []; |
---|
| 109 | 0045 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'simulator'</span>) || strcmpi(varargin{i},<span class="string">'model'</span>) || strcmpi(varargin{i},<span class="string">'Online'</span>) || strcmpi(varargin{i},<span class="string">'Manual'</span>) |
---|
| 110 | 0046 <span class="comment">% Remove and ignor</span> |
---|
| 111 | 0047 varargin(i) = []; |
---|
| 112 | 0048 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'physics'</span>) |
---|
| 113 | 0049 UnitsFlagCell = {<span class="string">'Physics'</span>}; |
---|
| 114 | 0050 varargin(i) = []; |
---|
| 115 | 0051 <span class="keyword">elseif</span> strcmpi(varargin{i},<span class="string">'hardware'</span>) |
---|
| 116 | 0052 UnitsFlagCell = {<span class="string">'Hardware'</span>}; |
---|
| 117 | 0053 varargin(i) = []; |
---|
| 118 | 0054 <span class="keyword">end</span> |
---|
| 119 | 0055 <span class="keyword">end</span> |
---|
| 120 | 0056 |
---|
| 121 | 0057 <span class="keyword">if</span> isempty(varargin) |
---|
| 122 | 0058 error(<span class="string">'Must have at least a family name input'</span>); |
---|
| 123 | 0059 <span class="keyword">end</span> |
---|
| 124 | 0060 |
---|
| 125 | 0061 |
---|
| 126 | 0062 <span class="comment">%%%%%%%%%%%%%%</span> |
---|
| 127 | 0063 <span class="comment">% Cell input %</span> |
---|
| 128 | 0064 <span class="comment">%%%%%%%%%%%%%%</span> |
---|
| 129 | 0065 <span class="keyword">if</span> iscell(varargin{1}) |
---|
| 130 | 0066 <span class="keyword">for</span> i = 1:length(varargin{1}) |
---|
| 131 | 0067 <span class="keyword">if</span> length(varargin) < 2 |
---|
| 132 | 0068 Data{i} = <a href="getroll.html" class="code" title="function Data = getroll(varargin)">getroll</a>(varargin{1}{i}, UnitsFlagCell{:}); |
---|
| 133 | 0069 <span class="keyword">elseif</span> length(varargin) < 3 |
---|
| 134 | 0070 <span class="keyword">if</span> iscell(varargin{2}) |
---|
| 135 | 0071 Data{i} = <a href="getroll.html" class="code" title="function Data = getroll(varargin)">getroll</a>(varargin{1}{i}, varargin{2}{i}, UnitsFlagCell{:}); |
---|
| 136 | 0072 <span class="keyword">else</span> |
---|
| 137 | 0073 Data{i} = <a href="getroll.html" class="code" title="function Data = getroll(varargin)">getroll</a>(varargin{1}{i}, varargin{2}, UnitsFlagCell{:}); |
---|
| 138 | 0074 <span class="keyword">end</span> |
---|
| 139 | 0075 <span class="keyword">else</span> |
---|
| 140 | 0076 <span class="keyword">if</span> iscell(varargin{3}) |
---|
| 141 | 0077 Data{i} = <a href="getroll.html" class="code" title="function Data = getroll(varargin)">getroll</a>(varargin{1}{i}, varargin{2}{i}, varargin{3}{i}, UnitsFlagCell{:}); |
---|
| 142 | 0078 <span class="keyword">else</span> |
---|
| 143 | 0079 Data{i} = <a href="getroll.html" class="code" title="function Data = getroll(varargin)">getroll</a>(varargin{1}{i}, varargin{2}{i}, varargin{3}, UnitsFlagCell{:}); |
---|
| 144 | 0080 <span class="keyword">end</span> |
---|
| 145 | 0081 <span class="keyword">end</span> |
---|
| 146 | 0082 <span class="keyword">end</span> |
---|
| 147 | 0083 <span class="keyword">return</span> |
---|
| 148 | 0084 <span class="keyword">end</span> |
---|
| 149 | 0085 |
---|
| 150 | 0086 |
---|
| 151 | 0087 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 152 | 0088 <span class="comment">% Parse Family, Field, DeviceList %</span> |
---|
| 153 | 0089 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 154 | 0090 [Family, Field, DeviceList, UnitsFlag] = <a href="inputparsingffd.html" class="code" title="function [Family, Field, DeviceList, UnitsFlag, ModelFlag] = inputparsingffd(varargin)">inputparsingffd</a>(varargin{:}); |
---|
| 155 | 0091 |
---|
| 156 | 0092 <span class="comment">% Units flag</span> |
---|
| 157 | 0093 <span class="keyword">if</span> isempty(UnitsFlagCell) |
---|
| 158 | 0094 <span class="comment">% For structure inputs, use the units in the structure (from inputparsingffd)</span> |
---|
| 159 | 0095 <span class="comment">% Else, get the default family value</span> |
---|
| 160 | 0096 <span class="keyword">if</span> isempty(UnitsFlag) |
---|
| 161 | 0097 UnitsFlag = <a href="getunits.html" class="code" title="function [Units, UnitsString] = getunits(Family, Field)">getunits</a>(Family); |
---|
| 162 | 0098 <span class="keyword">end</span> |
---|
| 163 | 0099 <span class="keyword">else</span> |
---|
| 164 | 0100 <span class="comment">% Input override has priority</span> |
---|
| 165 | 0101 UnitsFlag = UnitsFlagCell{1}; |
---|
| 166 | 0102 <span class="keyword">end</span> |
---|
| 167 | 0103 |
---|
| 168 | 0104 |
---|
| 169 | 0105 <span class="comment">% Default field is Monitor for BPMs else Setpoint</span> |
---|
| 170 | 0106 <span class="keyword">if</span> isempty(Field) |
---|
| 171 | 0107 <span class="keyword">if</span> <a href="ismemberof.html" class="code" title="function [IsTest, Index] = ismemberof(FamilyName, Field, MemberString)">ismemberof</a>(Family,<span class="string">'BPM'</span>) |
---|
| 172 | 0108 Field = <span class="string">'Monitor'</span>; |
---|
| 173 | 0109 <span class="keyword">else</span> |
---|
| 174 | 0110 Field = <span class="string">'Setpoint'</span>; |
---|
| 175 | 0111 <span class="keyword">end</span> |
---|
| 176 | 0112 <span class="keyword">end</span> |
---|
| 177 | 0113 |
---|
| 178 | 0114 |
---|
| 179 | 0115 <span class="comment">%%%%%%%%%%%%</span> |
---|
| 180 | 0116 <span class="comment">% Get data %</span> |
---|
| 181 | 0117 <span class="comment">%%%%%%%%%%%%</span> |
---|
| 182 | 0118 |
---|
| 183 | 0119 <span class="comment">% 1. Try the AO and AD</span> |
---|
| 184 | 0120 Data = <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(Family, Field, <span class="string">'Roll'</span>, DeviceList); |
---|
| 185 | 0121 <span class="keyword">if</span> isempty(Data) |
---|
| 186 | 0122 Data = <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(Family, <span class="string">'Roll'</span>, DeviceList); |
---|
| 187 | 0123 <span class="keyword">end</span> |
---|
| 188 | 0124 |
---|
| 189 | 0125 <span class="comment">% 2. Then look in PhysData</span> |
---|
| 190 | 0126 <span class="keyword">if</span> isempty(Data) |
---|
| 191 | 0127 <span class="keyword">try</span> |
---|
| 192 | 0128 Data = <a href="getphysdata.html" class="code" title="function [Data, iNotFound] = getphysdata(Family, Field, DeviceList)">getphysdata</a>(Family, <span class="string">'Roll'</span>, DeviceList); |
---|
| 193 | 0129 <span class="keyword">catch</span> |
---|
| 194 | 0130 <span class="comment">% Default</span> |
---|
| 195 | 0131 Data = zeros(size(DeviceList,1),1); |
---|
| 196 | 0132 <span class="keyword">end</span> |
---|
| 197 | 0133 <span class="keyword">end</span> |
---|
| 198 | 0134 |
---|
| 199 | 0135 |
---|
| 200 | 0136 |
---|
| 201 | 0137 |
---|
| 202 | 0138 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 203 | 0139 <span class="comment">% Change to physics units if requested %</span> |
---|
| 204 | 0140 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 205 | 0141 <span class="comment">%if strcmpi(UnitsFlag,'Physics')</span> |
---|
| 206 | 0142 <span class="comment">% Data = hw2physics(Family, Field, Data, DeviceList);</span> |
---|
| 207 | 0143 <span class="comment">%end</span> |
---|
| 208 | 0144 |
---|
| 209 | 0145 |
---|
| 210 | 0146 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 211 | 0147 <span class="comment">% Return a data structure if requested %</span> |
---|
| 212 | 0148 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 213 | 0149 <span class="keyword">if</span> StructOutputFlag |
---|
| 214 | 0150 DataNumeric = Data; |
---|
| 215 | 0151 <span class="keyword">if</span> isempty(UnitsFlag) |
---|
| 216 | 0152 Data = <a href="family2datastruct.html" class="code" title="function [DataStruct, ErrorFlag] = family2datastruct(varargin)">family2datastruct</a>(Family, Field, DeviceList); |
---|
| 217 | 0153 <span class="keyword">else</span> |
---|
| 218 | 0154 Data = <a href="family2datastruct.html" class="code" title="function [DataStruct, ErrorFlag] = family2datastruct(varargin)">family2datastruct</a>(Family, Field, DeviceList, UnitsFlag); |
---|
| 219 | 0155 <span class="keyword">end</span> |
---|
| 220 | 0156 Data.Data = DataNumeric; |
---|
| 221 | 0157 Data.DataDescriptor = sprintf(<span class="string">'%s.%s Roll'</span>, Family, Field); |
---|
| 222 | 0158 Data.CreatedBy = <span class="string">'getroll'</span>; |
---|
| 223 | 0159 <span class="keyword">end</span> |
---|
| 224 | 0160</pre></div> |
---|
| 225 | <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> |
---|
| 226 | </body> |
---|
| 227 | </html> |
---|