Deploying to gh-pages from @ 525cda5 🚀

Author: JeanLucPons

_modules/pyaml/control/abstract_impl.html

@@ -46,7 +46,6 @@ <h1>Source code for pyaml.control.abstract_impl</h1><div class="highlight"><pre>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_plant</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFPlant</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_transmitter</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFTransmitter</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..common.abstract_aggregator</span><span class="w"> </span><span class="kn">import</span> <span class="n">ScalarAggregator</span>
-
 <span class="kn">from</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="kn">import</span> <span class="n">double</span>
 <span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">numpy.typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">NDArray</span>
@@ -563,6 +562,33 @@ <h1>Source code for pyaml.control.abstract_impl</h1><div class="highlight"><pre>
 </div>
 
 
+<span class="c1">#------------------------------------------------------------------------------</span>
+
+<div class="viewcode-block" id="RBetatronTuneArray">
+<a class="viewcode-back" href="../../../modules/control.html#pyaml.control.abstract_impl.RBetatronTuneArray">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">RBetatronTuneArray</span><span class="p">(</span><span class="n">abstract</span><span class="o">.</span><span class="n">ReadFloatScalar</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Class providing read write access to betatron tune of a control system.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tune_monitor</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__tune_monitor</span> <span class="o">=</span> <span class="n">tune_monitor</span>
+
+<div class="viewcode-block" id="RBetatronTuneArray.get">
+<a class="viewcode-back" href="../../../modules/control.html#pyaml.control.abstract_impl.RBetatronTuneArray.get">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">NDArray</span><span class="p">:</span>
+        <span class="c1"># Return horizontal and vertical betatron tunes as a NumPy array</span>
+        <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">__tune_monitor</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">tune_h</span><span class="o">.</span><span class="n">get</span><span class="p">(),</span> 
+               <span class="bp">self</span><span class="o">.</span><span class="n">__tune_monitor</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">tune_v</span><span class="o">.</span><span class="n">get</span><span class="p">()])</span></div>
+
+
+<div class="viewcode-block" id="RBetatronTuneArray.unit">
+<a class="viewcode-back" href="../../../modules/control.html#pyaml.control.abstract_impl.RBetatronTuneArray.unit">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">unit</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__tune_monitor</span><span class="o">.</span><span class="n">_cfg</span><span class="o">.</span><span class="n">tune_v</span><span class="o">.</span><span class="n">unit</span><span class="p">()</span></div>
+</div>
+
+
 </pre></div>
 
             <div class="clearer"></div>

_modules/pyaml/control/controlsystem.html

@@ -43,10 +43,12 @@ <h1>Source code for pyaml.control.controlsystem</h1><div class="highlight"><pre>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..lattice.element</span><span class="w"> </span><span class="kn">import</span> <span class="n">Element</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..control.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">RWHardwareScalar</span><span class="p">,</span><span class="n">RWHardwareArray</span><span class="p">,</span><span class="n">RWStrengthScalar</span><span class="p">,</span><span class="n">RWStrengthArray</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..bpm.bpm</span><span class="w"> </span><span class="kn">import</span> <span class="n">BPM</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">..diagnostics.tune_monitor</span><span class="w"> </span><span class="kn">import</span> <span class="n">BetatronTuneMonitor</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..control.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">RWBpmTiltScalar</span><span class="p">,</span><span class="n">RWBpmOffsetArray</span><span class="p">,</span> <span class="n">RBpmArray</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..control.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">RWRFFrequencyScalar</span><span class="p">,</span><span class="n">RWRFVoltageScalar</span><span class="p">,</span><span class="n">RWRFPhaseScalar</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..control.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">CSScalarAggregator</span><span class="p">,</span><span class="n">CSStrengthScalarAggregator</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..common.abstract_aggregator</span><span class="w"> </span><span class="kn">import</span> <span class="n">ScalarAggregator</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">..control.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">RBetatronTuneArray</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..magnet.magnet</span><span class="w"> </span><span class="kn">import</span> <span class="n">Magnet</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..magnet.cfm_magnet</span><span class="w"> </span><span class="kn">import</span> <span class="n">CombinedFunctionMagnet</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_plant</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFPlant</span><span class="p">,</span><span class="n">RWTotalVoltage</span>
@@ -191,7 +193,11 @@ <h1>Source code for pyaml.control.controlsystem</h1><div class="highlight"><pre>
              <span class="n">frequency</span> <span class="o">=</span> <span class="n">RWRFFrequencyScalar</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
              <span class="n">voltage</span> <span class="o">=</span> <span class="n">RWTotalVoltage</span><span class="p">(</span><span class="n">attachedTrans</span><span class="p">)</span>
              <span class="n">ne</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="n">frequency</span><span class="p">,</span><span class="n">voltage</span><span class="p">)</span>
-             <span class="bp">self</span><span class="o">.</span><span class="n">add_rf_plant</span><span class="p">(</span><span class="n">ne</span><span class="o">.</span><span class="n">get_name</span><span class="p">(),</span><span class="n">ne</span><span class="p">)</span></div>
+             <span class="bp">self</span><span class="o">.</span><span class="n">add_rf_plant</span><span class="p">(</span><span class="n">ne</span><span class="o">.</span><span class="n">get_name</span><span class="p">(),</span><span class="n">ne</span><span class="p">)</span>
+          <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span><span class="n">BetatronTuneMonitor</span><span class="p">):</span>
+              <span class="n">betatron_tune</span> <span class="o">=</span> <span class="n">RBetatronTuneArray</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
+              <span class="n">e</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="n">betatron_tune</span><span class="p">)</span>
+              <span class="bp">self</span><span class="o">.</span><span class="n">add_betatron_tune_monitor</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">get_name</span><span class="p">(),</span> <span class="n">e</span><span class="p">)</span></div>
 </div>
 
 </pre></div>

_modules/pyaml/lattice/abstract_impl.html

@@ -591,6 +591,31 @@ <h1>Source code for pyaml.lattice.abstract_impl</h1><div class="highlight"><pre>
 </div>
 
 
+<span class="c1">#------------------------------------------------------------------------------</span>
+
+<div class="viewcode-block" id="RBetatronTuneArray">
+<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RBetatronTuneArray">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">RBetatronTuneArray</span><span class="p">(</span><span class="n">abstract</span><span class="o">.</span><span class="n">ReadFloatScalar</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Class providing read-only access to the betatron tune of a ring.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ring</span><span class="p">:</span> <span class="n">at</span><span class="o">.</span><span class="n">Lattice</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__ring</span> <span class="o">=</span> <span class="n">ring</span>
+        
+<div class="viewcode-block" id="RBetatronTuneArray.get">
+<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RBetatronTuneArray.get">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__ring</span><span class="o">.</span><span class="n">get_tune</span><span class="p">()[:</span><span class="mi">2</span><span class="p">]</span></div>
+
+
+<div class="viewcode-block" id="RBetatronTuneArray.unit">
+<a class="viewcode-back" href="../../../modules/lattice.html#pyaml.lattice.abstract_impl.RBetatronTuneArray.unit">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">unit</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+        <span class="k">return</span> <span class="s1">&#39;1&#39;</span></div>
+</div>
+
+
 </pre></div>
 
             <div class="clearer"></div>

_modules/pyaml/lattice/simulator.html

@@ -44,6 +44,7 @@ <h1>Source code for pyaml.lattice.simulator</h1><div class="highlight"><pre>
 <span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..magnet.magnet</span><span class="w"> </span><span class="kn">import</span> <span class="n">Magnet</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">pyaml.bpm.bpm</span><span class="w"> </span><span class="kn">import</span> <span class="n">BPM</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">pyaml.diagnostics.tune_monitor</span><span class="w"> </span><span class="kn">import</span> <span class="n">BetatronTuneMonitor</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..magnet.cfm_magnet</span><span class="w"> </span><span class="kn">import</span> <span class="n">CombinedFunctionMagnet</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_plant</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFPlant</span><span class="p">,</span><span class="n">RWTotalVoltage</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..rf.rf_transmitter</span><span class="w"> </span><span class="kn">import</span> <span class="n">RFTransmitter</span>
@@ -52,6 +53,7 @@ <h1>Source code for pyaml.lattice.simulator</h1><div class="highlight"><pre>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..lattice.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">RWRFFrequencyScalar</span><span class="p">,</span><span class="n">RWRFVoltageScalar</span><span class="p">,</span><span class="n">RWRFPhaseScalar</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..common.element_holder</span><span class="w"> </span><span class="kn">import</span> <span class="n">ElementHolder</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..common.abstract_aggregator</span><span class="w"> </span><span class="kn">import</span> <span class="n">ScalarAggregator</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">..lattice.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">RBetatronTuneArray</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..lattice.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">RWBpmTiltScalar</span><span class="p">,</span><span class="n">RWBpmOffsetArray</span><span class="p">,</span> <span class="n">RBpmArray</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..lattice.abstract_impl</span><span class="w"> </span><span class="kn">import</span> <span class="n">BPMHScalarAggregator</span><span class="p">,</span><span class="n">BPMScalarAggregator</span><span class="p">,</span><span class="n">BPMVScalarAggregator</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">..common.exception</span><span class="w"> </span><span class="kn">import</span> <span class="n">PyAMLException</span>
@@ -184,6 +186,10 @@ <h1>Source code for pyaml.lattice.simulator</h1><div class="highlight"><pre>
              <span class="n">voltage</span> <span class="o">=</span> <span class="n">RWTotalVoltage</span><span class="p">(</span><span class="n">attachedTrans</span><span class="p">)</span>
              <span class="n">ne</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="n">frequency</span><span class="p">,</span><span class="n">voltage</span><span class="p">)</span>
              <span class="bp">self</span><span class="o">.</span><span class="n">add_rf_plant</span><span class="p">(</span><span class="n">ne</span><span class="o">.</span><span class="n">get_name</span><span class="p">(),</span><span class="n">ne</span><span class="p">)</span>
+          <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">BetatronTuneMonitor</span><span class="p">):</span>
+             <span class="n">betatron_tune</span> <span class="o">=</span> <span class="n">RBetatronTuneArray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ring</span><span class="p">)</span>
+             <span class="n">e</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="n">betatron_tune</span><span class="p">)</span>
+             <span class="bp">self</span><span class="o">.</span><span class="n">add_betatron_tune_monitor</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">get_name</span><span class="p">(),</span> <span class="n">e</span><span class="p">)</span>
 
 
     <span class="k">def</span><span class="w"> </span><span class="nf">get_at_elems</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">element</span><span class="p">:</span><span class="n">Element</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">at</span><span class="o">.</span><span class="n">Element</span><span class="p">]:</span>

_sources/generated/pyaml.control.abstract_impl.rst.txt

@@ -10,6 +10,7 @@ pyaml.control.abstract\_impl
 
       CSScalarAggregator
       CSStrengthScalarAggregator
+      RBetatronTuneArray
       RBpmArray
       RWBpmOffsetArray
       RWBpmTiltScalar

_sources/generated/pyaml.lattice.abstract_impl.rst.txt

@@ -11,6 +11,7 @@ pyaml.lattice.abstract\_impl
       BPMHScalarAggregator
       BPMScalarAggregator
       BPMVScalarAggregator
+      RBetatronTuneArray
       RBpmArray
       RWBpmOffsetArray
       RWBpmTiltScalar