mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-11-15 15:13:52 +01:00
Update Documentation for developer
This commit is contained in:
github-actions committed
1 parent
e8433c1deb
commit
6367a01bfc
23 files changed
+461
-461
No files matched your search
@@ -289,7 +289,7 @@ and then use list slicing to get the values for the modules you are interested i
|
||||
<span class="go">50001</span>
|
||||
|
||||
<span class="go">#For some but not all properties you can also pass in a dictionary with module index as key</span>
|
||||
<span class="gp">>>> </span><span class="n">ip</span> <span class="o">=</span> <span class="n">IpAddr</span><span class="p">(</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">ip</span> <span class="o">=</span> <span class="n">IpAddr</span><span class="p">(</span><span class="s1">'127.0.0.1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">udp_dstip</span> <span class="o">=</span> <span class="p">{</span><span class="mi">1</span><span class="p">:</span><span class="n">ip</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@@ -301,26 +301,26 @@ can use dir()</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">slsdet</span><span class="w"> </span><span class="kn">import</span> <span class="n">Detector</span>
|
||||
<span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="n">Detector</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="nb">dir</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
|
||||
<span class="go">['__class__', '__delattr__', '__dict__', '__dir__', '__doc__',</span>
|
||||
<span class="go">'__eq__', '__format__', '__ge__', '__getattribute__', '__gt__',</span>
|
||||
<span class="go">'__hash__', '__init__', '__init_subclass__', '__le__', '__len__',</span>
|
||||
<span class="go">'__lt__', '__module__', '__ne__', '__new__', '__reduce__',</span>
|
||||
<span class="go">'__reduce_ex__', '__repr__', '__setattr__', '__sizeof__',</span>
|
||||
<span class="go">'__str__', '__subclasshook__', '_adc_register', '_frozen',</span>
|
||||
<span class="go">'_register', 'acquire', 'adcclk', 'adcphase', 'adcpipeline',</span>
|
||||
<span class="go">'adcreg', 'asamples', 'auto_comp_disable', 'clearAcquiringFlag',</span>
|
||||
<span class="go">'clearBit', 'clearROI', 'client_version', 'config',</span>
|
||||
<span class="go">'counters', 'daclist', 'dacvalues', 'dbitclk', 'dbitphase' ...</span>
|
||||
<span class="go">['__class__', '__delattr__', '__dict__', '__dir__', '__doc__',</span>
|
||||
<span class="go">'__eq__', '__format__', '__ge__', '__getattribute__', '__gt__',</span>
|
||||
<span class="go">'__hash__', '__init__', '__init_subclass__', '__le__', '__len__',</span>
|
||||
<span class="go">'__lt__', '__module__', '__ne__', '__new__', '__reduce__',</span>
|
||||
<span class="go">'__reduce_ex__', '__repr__', '__setattr__', '__sizeof__',</span>
|
||||
<span class="go">'__str__', '__subclasshook__', '_adc_register', '_frozen',</span>
|
||||
<span class="go">'_register', 'acquire', 'adcclk', 'adcphase', 'adcpipeline',</span>
|
||||
<span class="go">'adcreg', 'asamples', 'auto_comp_disable', 'clearAcquiringFlag',</span>
|
||||
<span class="go">'clearBit', 'clearROI', 'client_version', 'config',</span>
|
||||
<span class="go">'counters', 'daclist', 'dacvalues', 'dbitclk', 'dbitphase' ...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Since the list for Detector is rather long it’s an good idea to filter it.
|
||||
The following example gives you properties and methods containing time in
|
||||
their name.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> <span class="k">if</span> <span class="s1">'time'</span> <span class="ow">in</span> <span class="n">item</span><span class="p">]</span>
|
||||
<span class="go">['compdisabletime', 'exptime', 'exptimel', 'frametime', 'getExptime',</span>
|
||||
<span class="go">'getExptimeForAllGates', 'getExptimeLeft', 'getSubExptime', 'patwaittime',</span>
|
||||
<span class="go">'patwaittime0', 'patwaittime1', 'patwaittime2', 'runtime', 'setExptime',</span>
|
||||
<span class="go">'setSubExptime', 'subdeadtime', 'subexptime']</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">d</span><span class="p">)</span> <span class="k">if</span> <span class="s1">'time'</span> <span class="ow">in</span> <span class="n">item</span><span class="p">]</span>
|
||||
<span class="go">['compdisabletime', 'exptime', 'exptimel', 'frametime', 'getExptime',</span>
|
||||
<span class="go">'getExptimeForAllGates', 'getExptimeLeft', 'getSubExptime', 'patwaittime',</span>
|
||||
<span class="go">'patwaittime0', 'patwaittime1', 'patwaittime2', 'runtime', 'setExptime',</span>
|
||||
<span class="go">'setSubExptime', 'subdeadtime', 'subexptime']</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The above method works on any Python object but for convenience we also
|
||||
@@ -328,7 +328,7 @@ included two functions to find names. View prints the names one per line
|
||||
while find returns a list of names.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">slsdet.lookup</span><span class="w"> </span><span class="kn">import</span> <span class="n">view</span><span class="p">,</span> <span class="n">find</span>
|
||||
|
||||
<span class="o">>>></span> <span class="n">view</span><span class="p">(</span><span class="s1">'exptime'</span><span class="p">)</span>
|
||||
<span class="o">>>></span> <span class="n">view</span><span class="p">(</span><span class="s1">'exptime'</span><span class="p">)</span>
|
||||
<span class="n">exptime</span>
|
||||
<span class="n">exptimel</span>
|
||||
<span class="n">getExptime</span>
|
||||
@@ -340,9 +340,9 @@ while find returns a list of names.</p>
|
||||
<span class="n">subexptime</span>
|
||||
|
||||
|
||||
<span class="o">>>></span> <span class="n">find</span><span class="p">(</span><span class="s1">'exptime'</span><span class="p">)</span>
|
||||
<span class="p">[</span><span class="s1">'exptime'</span><span class="p">,</span> <span class="s1">'getExptime'</span><span class="p">,</span> <span class="s1">'getExptimeForAllGates'</span><span class="p">,</span> <span class="s1">'getExptimeLeft'</span><span class="p">,</span>
|
||||
<span class="s1">'getSubExptime'</span><span class="p">,</span> <span class="s1">'setExptime'</span><span class="p">,</span> <span class="s1">'setSubExptime'</span><span class="p">,</span> <span class="s1">'subexptime'</span><span class="p">]</span>
|
||||
<span class="o">>>></span> <span class="n">find</span><span class="p">(</span><span class="s1">'exptime'</span><span class="p">)</span>
|
||||
<span class="p">[</span><span class="s1">'exptime'</span><span class="p">,</span> <span class="s1">'getExptime'</span><span class="p">,</span> <span class="s1">'getExptimeForAllGates'</span><span class="p">,</span> <span class="s1">'getExptimeLeft'</span><span class="p">,</span>
|
||||
<span class="s1">'getSubExptime'</span><span class="p">,</span> <span class="s1">'setExptime'</span><span class="p">,</span> <span class="s1">'setSubExptime'</span><span class="p">,</span> <span class="s1">'subexptime'</span><span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -397,12 +397,12 @@ to pass in an enum.</p>
|
||||
</div>
|
||||
<p>The enums can be found in slsdet.enums</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">slsdet</span>
|
||||
<span class="o">>>></span> <span class="p">[</span><span class="n">e</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">slsdet</span><span class="o">.</span><span class="n">enums</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">e</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'_'</span><span class="p">)]</span>
|
||||
<span class="p">[</span><span class="s1">'M3_GainCaps'</span><span class="p">,</span> <span class="s1">'burstMode'</span><span class="p">,</span> <span class="s1">'clockIndex'</span><span class="p">,</span> <span class="s1">'cls'</span><span class="p">,</span> <span class="s1">'dacIndex'</span><span class="p">,</span> <span class="s1">'detectorSettings'</span><span class="p">,</span>
|
||||
<span class="s1">'detectorType'</span><span class="p">,</span> <span class="s1">'dimension'</span><span class="p">,</span> <span class="s1">'externalSignalFlag'</span><span class="p">,</span> <span class="s1">'fileFormat'</span><span class="p">,</span>
|
||||
<span class="s1">'frameDiscardPolicy'</span><span class="p">,</span> <span class="s1">'gainMode'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">,</span> <span class="s1">'polarity'</span><span class="p">,</span> <span class="s1">'portPosition'</span><span class="p">,</span>
|
||||
<span class="s1">'readoutMode'</span><span class="p">,</span> <span class="s1">'runStatus'</span><span class="p">,</span> <span class="s1">'speedLevel'</span><span class="p">,</span> <span class="s1">'streamingInterface'</span><span class="p">,</span> <span class="s1">'timingMode'</span><span class="p">,</span>
|
||||
<span class="s1">'timingSourceType'</span><span class="p">,</span> <span class="s1">'vetoAlgorithm'</span><span class="p">]</span>
|
||||
<span class="o">>>></span> <span class="p">[</span><span class="n">e</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">slsdet</span><span class="o">.</span><span class="n">enums</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">e</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'_'</span><span class="p">)]</span>
|
||||
<span class="p">[</span><span class="s1">'M3_GainCaps'</span><span class="p">,</span> <span class="s1">'burstMode'</span><span class="p">,</span> <span class="s1">'clockIndex'</span><span class="p">,</span> <span class="s1">'cls'</span><span class="p">,</span> <span class="s1">'dacIndex'</span><span class="p">,</span> <span class="s1">'detectorSettings'</span><span class="p">,</span>
|
||||
<span class="s1">'detectorType'</span><span class="p">,</span> <span class="s1">'dimension'</span><span class="p">,</span> <span class="s1">'externalSignalFlag'</span><span class="p">,</span> <span class="s1">'fileFormat'</span><span class="p">,</span>
|
||||
<span class="s1">'frameDiscardPolicy'</span><span class="p">,</span> <span class="s1">'gainMode'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">,</span> <span class="s1">'polarity'</span><span class="p">,</span> <span class="s1">'portPosition'</span><span class="p">,</span>
|
||||
<span class="s1">'readoutMode'</span><span class="p">,</span> <span class="s1">'runStatus'</span><span class="p">,</span> <span class="s1">'speedLevel'</span><span class="p">,</span> <span class="s1">'streamingInterface'</span><span class="p">,</span> <span class="s1">'timingMode'</span><span class="p">,</span>
|
||||
<span class="s1">'timingSourceType'</span><span class="p">,</span> <span class="s1">'vetoAlgorithm'</span><span class="p">]</span>
|
||||
|
||||
|
||||
<span class="c1"># Even though importing using * is not recommended one could</span>
|
||||
|
||||
Reference in new issue
Block a user