source: MML/trunk/mml/doc_html/mml/gethbpmfamily.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.4 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 gethbpmfamily</title>
6  <meta name="keywords" content="gethbpmfamily">
7  <meta name="description" content="GETHBPMFAMILY - Return the default horizontal BPM family">
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; gethbpmfamily.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>gethbpmfamily
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>GETHBPMFAMILY - Return the default horizontal BPM family</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 Family = gethbpmfamily </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">GETHBPMFAMILY - Return the default horizontal BPM family
31  Family = gethbpmfamily
32
33  The family name is determined by the MemberOf field equal to 'BPMx' or 'HBPM'
34
35  See also <a href="getvbpmfamily.html" class="code" title="function Family = getvbpmfamily">getvbpmfamily</a>, <a href="gethcmfamily.html" class="code" title="function Family = gethcmfamily">gethcmfamily</a>, <a href="getvcmfamily.html" class="code" title="function Family = getvcmfamily">getvcmfamily</a>
36
37  Writen by Greg Portmann</pre></div>
38
39<!-- crossreference -->
40<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
41This function calls:
42<ul style="list-style-image:url(../matlabicon.gif)">
43<li><a href="findmemberof.html" class="code" title="function  FamilyName = findmemberof(MemberString, Field)">findmemberof</a>  FINDMEMBEROF - Finds all family members</li></ul>
44This function is called by:
45<ul style="list-style-image:url(../matlabicon.gif)">
46<li><a href="amp2mm.html" class="code" title="function mm = amp2mm(CMfamily, Amps, CMDevList, varargin)">amp2mm</a>     AMPS2MM - Returns the maximum millimeter orbit change per change in corrector</li><li><a href="getbpm.html" class="code" title="function [BPM1, BPM2, FileName]=getbpm(varargin);">getbpm</a>   GETBPM - Returns the horizontal and vertical orbit</li><li><a href="getbpmresp.html" class="code" title="function [S, FileName] = getbpmresp(varargin)">getbpmresp</a>  GETBPMRESP - Returns the BPM response matrix in the horizontal and vertical planes</li><li><a href="getdisp.html" class="code" title="function [Data, FileName] = getdisp(varargin)">getdisp</a>        GETDISP - Returns the dispersion for a family (from file)</li><li><a href="getnumberofsectors.html" class="code" title="function N = getnumberofsectors">getnumberofsectors</a> GETNUMBEROFSECTORS - Number of sectors in the lattice</li><li><a href="getx.html" class="code" title="function [AM, tout, DataTime, ErrorFlag] = getx(varargin)">getx</a>       GETX - Returns the horizontal orbit</li><li><a href="loadorbit.html" class="code" title="function varargout = loadorbit(varargin)">loadorbit</a>        LOADORBIT -  Loads orbit by file/directory specification - or - Golden %orbit by default</li><li><a href="magstep.html" class="code" title="">magstep</a>       HCM Step</li><li><a href="measbpmresp.html" class="code" title="function [Rmat, OutputFileName] = measbpmresp(varargin)">measbpmresp</a>        MEASBPMRESP - Measures the BPM response matrix in the horizontal and vertical planes</li><li><a href="measbpmresplinearity.html" class="code" title="function measbpmresplinearity(CMFamily, mm, CMDeviceList, XAxisFlag)">measbpmresplinearity</a>     MEASBPMRESPLINEARITY - Compute BPMlinearity</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="meascmhysteresis.html" class="code" title="function meascmhysteresis(BPMList, CMFamily, CMList, MaxChange, NSteps)">meascmhysteresis</a>    MEASCMHYSTERESIS - Measure corrector magnet hysteresis</li><li><a href="measdisp.html" class="code" title="function [Dx, Dy, FileName] = measdisp(varargin);">measdisp</a>      MEASDISP - Measures the dispersion function</li><li><a href="mm2amp.html" class="code" title="function Amps = mm2amp(CMfamily, mm, CMDevList, varargin)">mm2amp</a>     MM2AMPS - Returns the change in corrector need for a maximum orbit change</li><li><a href="orbitcorrectionmethods.html" class="code" title="function [OCS, SmatNoWeights, S, U, V] = orbitcorrectionmethods(OCS, Smat, S, U, V)">orbitcorrectionmethods</a>     ORBITCORRECTIONMETHODS - Some the orbit correction methods used on light sources</li><li><a href="plotdisp.html" class="code" title="function [DxOut, DyOut, FileName] = plotdisp(varargin)">plotdisp</a>       PLOTDISP - Plots the dispersion function</li><li><a href="plotgoldenorbit.html" class="code" title="function plotgoldenorbit(varargin)">plotgoldenorbit</a>     PLOTGOLDENORBIT - Plots the golden orbit</li><li><a href="plotoffsetorbit.html" class="code" title="function plotoffsetorbit(varargin)">plotoffsetorbit</a>     PLOTOFFSETORBIT - Plots the offset orbit</li><li><a href="plotorbit.html" class="code" title="function plotorbit(varargin)">plotorbit</a>       PLOTORBIT - Plot the present orbit w.r.t. the golden or offset orbit</li><li><a href="plotorbitdata.html" class="code" title="function [BPMx, BPMy] = plotorbitdata(varargin)">plotorbitdata</a>        PLOTORBITDATA - Plots BPM statistics</li><li><a href="quad2bpm.html" class="code" title="function [BPMFamilyOutput, BPMDevOutput, DeltaSpos, PhaseAdvance] = quad2bpm(QUADFamily, QUADDev, LocationFlag)">quad2bpm</a>  QUAD2BPM - Returns the nearest BPM to the specified quadrupole</li><li><a href="quadcenterfit.html" class="code" title="function [XOffset, YOffset] = quadcenterfit(varargin)">quadcenterfit</a>        BBASEARCH - Model search method to find a quarupole center</li><li><a href="saveoffsetorbit.html" class="code" title="function saveoffsetorbit(FileName)">saveoffsetorbit</a>   SAVEOFFSETORBIT - Save offset orbit into file</li><li><a href="setgolden.html" class="code" title="function varargout = setgolden(varargin)">setgolden</a>      SETGOLDEN - Set the golden values</li><li><a href="setoffset.html" class="code" title="function varargout = setoffset(varargin)">setoffset</a>  SETOFFSET - Set the offset</li><li><a href="setorbit.html" class="code" title="function [OCS, OCS0, V, S, ErrorFlag] = setorbit(varargin)">setorbit</a> SETORBIT - Orbit correction function</li><li><a href="setorbitbump.html" class="code" title="function [OCS, OCS0, V, S, ErrorFlag] = setorbitbump(varargin)">setorbitbump</a>   SETORBITBUMP - Local bump program (uses setorbit)</li><li><a href="setorbitsetup.html" class="code" title="function [BPM, CM, Flags, EVectors] = setorbitsetup(varargin)">setorbitsetup</a>     SETORBITSETUP - BPM & CM setup function for setorbitgui</li></ul>
47<!-- crossreference -->
48
49
50<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
51<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function Family = gethbpmfamily</a>
520002 <span class="comment">%GETHBPMFAMILY - Return the default horizontal BPM family</span>
530003 <span class="comment">%  Family = gethbpmfamily</span>
540004 <span class="comment">%</span>
550005 <span class="comment">%  The family name is determined by the MemberOf field equal to 'BPMx' or 'HBPM'</span>
560006 <span class="comment">%</span>
570007 <span class="comment">%  See also getvbpmfamily, gethcmfamily, getvcmfamily</span>
580008 <span class="comment">%</span>
590009 <span class="comment">%  Writen by Greg Portmann</span>
600010
610011 <span class="keyword">persistent</span> WarningFlag
620012
630013 Family = <a href="findmemberof.html" class="code" title="function  FamilyName = findmemberof(MemberString, Field)">findmemberof</a>(<span class="string">'BPMx'</span>);
640014
650015 <span class="keyword">if</span> isempty(Family)
660016     Family = <a href="findmemberof.html" class="code" title="function  FamilyName = findmemberof(MemberString, Field)">findmemberof</a>(<span class="string">'HBPM'</span>);
670017     <span class="keyword">if</span> isempty(Family)
680018         <span class="comment">%Family = {'BPMx'};</span>
690019         <span class="keyword">if</span> isempty(WarningFlag)
700020             fprintf(<span class="string">'\n   No default horizontal BPM family has been specified in the MML.\n'</span>);
710021             fprintf(<span class="string">'   To define one, add ''BPMx'' or ''HBPM'' to the .MemberOf field for the default family.\n\n'</span>);
720022             WarningFlag = 1;
730023         <span class="keyword">end</span>
740024
750025         Family = {<span class="string">''</span>};
760026     <span class="keyword">end</span>
770027 <span class="keyword">end</span>
780028
790029 Family = Family{1};
800030</pre></div>
81<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>
82</body>
83</html>
Note: See TracBrowser for help on using the repository browser.