- Update rst/html doc

b115be22 · Arafat NOUREDDINE · 5550bf0a · b115be22 · b115be22
Commit b115be22 authored Jan 20, 2023 by Arafat NOUREDDINE
--- a/doc/XiaDxp.rst
+++ b/doc/XiaDxp.rst
@@ -81,7 +81,7 @@ GetRoisFilesAlias           Void            Array of String         Get the list
 =========================== =============== ======================= ===========================================


-Dynamic Attributes
+Attributes
 ````````````````````````````

 =============================== ======================== ================== ===============================================
@@ -97,6 +97,19 @@ currentConfigFile               R                        String             Disp
 peakingTime                     R                        Double             Peaking time of the energy filter, specified in us
 dynamicRange                    R/W                      Boolean            Energy range corresponding to 40% of the total ADC range, specified in eV                                                   
 fileGeneration                  R/W                      Boolean            Available only for expert user. Enable/Disable writing the data to a file.
+triggerLiveTime                 R                        Double             The livetime run statistic as measured by the trigger filter, reported in seconds.
+realTime(i)                     R                        Double             The total time that the processor was taking data in seconds
+deadTime(i)                     R                        Double             Deadtime as calculated by (ICR - OCR) / ICR
+inputCountRate                  R                        Double             This is the total number of triggers divided by the runtime in counts per second.
+outputCountRate                 R                        Double             This is the total number of events in the run divided by the runtime in counts per second.    
+eventsInRun                     R                        Double             The total number of events in a run that are written into the MCA spectrum.
+presetValue                     R/W                      Double             This value is either the number of counts or the time (specified in seconds) it depends on preset_type parameter.
+presetType                      R                        Double             Sets the preset run type: "NONE", "FIXED_REAL", "FIXED_LIVE", "FIXED_EVENTS", "FIXED_TRIGGERS"
+channel                         R                        ULong              Fluo spectrum for
+pixelAdvanceMode                R                        String             Available values : GATE, SYNC
+rois(i)_(j)       		        R                        Double             Region Of Interest j for channel i : spectrum sum for roi user input
+hrois(i)_(j)                    R                        ULong              Historized roi
+channel                         R                        ULong              Fluo spectrum for
 streamType                      W                        String             Available only for expert user. The curent stream type. Available values :NO_STREAM - NEXUS_STREAM - CSV_STREAM.
 streamTargetPath                W                        String             Available only for expert user. The root path for generated Stream files.
 streamTargetFile                W                        String             Available only for expert user. The file name for generated Stream files.

--- a/doc/doc_html/XiaDxp.html
+++ b/doc/doc_html/XiaDxp.html
@@ -3,18 +3,18 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 <title>XiaDxp</title>
 <style type="text/css">

 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
+:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
 :Copyright: This stylesheet has been placed in the public domain.

 Default cascading style sheet for the HTML output of Docutils.

-See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
 */

@@ -37,6 +37,14 @@ table.borderless td, table.borderless th {
 .hidden {
  display: none }

+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
 a.toc-backref {
  text-decoration: none ;
  color: black }
@@ -161,12 +169,12 @@ h2.subtitle {
 hr.docutils {
  width: 75% }

-img.align-left, .figure.align-left, object.align-left {
+img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

-img.align-right, .figure.align-right, object.align-right {
+img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }
@@ -177,6 +185,11 @@ img.align-center, .figure.align-center, object.align-center {
  margin-right: auto;
 }

+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
 .align-left {
  text-align: left }

@@ -194,6 +207,15 @@ div.align-right {
 /* div.align-center * { */
 /*   text-align: left } */

+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
 ol.simple, ul.simple {
  margin-bottom: 1em }

@@ -603,8 +625,8 @@ TRUE [;c:my_locationmy_file.txt] (means create my_file.txt in c:my_location)</dd
 </tbody>
 </table>
 </div>
-<div class="section" id="dynamic-attributes">
-<h1>Dynamic Attributes</h1>
+<div class="section" id="attributes">
+<h1>Attributes</h1>
 <table border="1" class="docutils">
 <colgroup>
 <col width="17%" />
@@ -670,6 +692,71 @@ TRUE [;c:my_locationmy_file.txt] (means create my_file.txt in c:my_location)</dd
 <td>Boolean</td>
 <td>Available only for expert user. Enable/Disable writing the data to a file.</td>
 </tr>
+<tr><td>triggerLiveTime</td>
+<td>R</td>
+<td>Double</td>
+<td>The livetime run statistic as measured by the trigger filter, reported in seconds.</td>
+</tr>
+<tr><td>realTime(i)</td>
+<td>R</td>
+<td>Double</td>
+<td>The total time that the processor was taking data in seconds</td>
+</tr>
+<tr><td>deadTime(i)</td>
+<td>R</td>
+<td>Double</td>
+<td>Deadtime as calculated by (ICR - OCR) / ICR</td>
+</tr>
+<tr><td>inputCountRate</td>
+<td>R</td>
+<td>Double</td>
+<td>This is the total number of triggers divided by the runtime in counts per second.</td>
+</tr>
+<tr><td>outputCountRate</td>
+<td>R</td>
+<td>Double</td>
+<td>This is the total number of events in the run divided by the runtime in counts per second.</td>
+</tr>
+<tr><td>eventsInRun</td>
+<td>R</td>
+<td>Double</td>
+<td>The total number of events in a run that are written into the MCA spectrum.</td>
+</tr>
+<tr><td>presetValue</td>
+<td>R/W</td>
+<td>Double</td>
+<td>This value is either the number of counts or the time (specified in seconds) it depends on preset_type parameter.</td>
+</tr>
+<tr><td>presetType</td>
+<td>R</td>
+<td>Double</td>
+<td>Sets the preset run type: &quot;NONE&quot;, &quot;FIXED_REAL&quot;, &quot;FIXED_LIVE&quot;, &quot;FIXED_EVENTS&quot;, &quot;FIXED_TRIGGERS&quot;</td>
+</tr>
+<tr><td>channel</td>
+<td>R</td>
+<td>ULong</td>
+<td>Fluo spectrum for</td>
+</tr>
+<tr><td>pixelAdvanceMode</td>
+<td>R</td>
+<td>String</td>
+<td>Available values : GATE, SYNC</td>
+</tr>
+<tr><td>rois(i)_(j)</td>
+<td>R</td>
+<td>Double</td>
+<td>Region Of Interest j for channel i : spectrum sum for roi user input</td>
+</tr>
+<tr><td>hrois(i)_(j)</td>
+<td>R</td>
+<td>ULong</td>
+<td>Historized roi</td>
+</tr>
+<tr><td>channel</td>
+<td>R</td>
+<td>ULong</td>
+<td>Fluo spectrum for</td>
+</tr>
 <tr><td>streamType</td>
 <td>W</td>
 <td>String</td>