Skip to content
Snippets Groups Projects
Commit bdabe346 authored by Arafat NOUREDDINE's avatar Arafat NOUREDDINE
Browse files

- Update rst/html doc

parent 3da1aef1
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
doc/DanteDpp.rst
+ 16
− 8
View file @ bdabe346
......@@ -87,22 +87,30 @@ Dynamic Attributes
=============================== ======================== ================== ===================================
Attribute name Read/Write Type Description
=============================== ======================== ================== ===================================
currentAlias R String Display the current Alias used to load the *.ini* file
currentConfigFile R String Display the path+name of current loaded *.ini* file
currentRoisFile
boardType R String The Board type Fixed by the BoardType property
currentMode R String Display the current Mode : MCA, MAPPING_FULL, MAPPING_SCA
nbModules R ULong Number of Xia boards
nbChannels R ULong Number of total of Channels
nbBins R ULong Number of bins per channel
currentAlias R String Display the current Alias used to load the *.ini* file
currentMode R String Display the current Mode : MCA, MAPPING_FULL, MAPPING_SCA
currentConfigFile R String Display the path+name of current loaded *.ini* file
currentRoisAlias R String Display the current Rois Alias used to load the Rois file
currentRoisFile R String Display the path+name of current loaded Rois file.
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.
triggerMode R/W Enum The current trigger mode. Available values : INTERNAL / GATE
currentPixel R ULong Current pixel of the mapping.
nbPixels R/W ULong Number of pixels (step) for the Mapping acquisition.
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"
realTime(i) R Double The total time that the processor was taking data in seconds
liveTime(i) R Double The total time that the processor was able to acquire new events in seconds.
inputCountRate(i) R Double Input Count Rate: OCR/(1-(Deadtime/100)) => (scaler4/(scaler8/80000000.0))/(1-(scaler10 /100))
outputCountRate(i) R Double Output Count Rate: AllGood/Time => scaler4/(scaler8/80000000.0)
eventsInRun(i) R ULong Number of all event triggers => scaler3
deadTime(i) R Double Deadtime as calculated by (ICR - OCR) / ICR
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.
streamNbAcqPerFile W uLong Available only for expert user. The number of acquisitions for each Stream file.
fileGeneration R/W Boolean Available only for expert user. Enable/Disable writing the data to a file.
enableDatasetrealtime R Boolean Allows to activate or inactivate the Real Time saving in the nexus files.
enableDatasetlivetime R Boolean Allows to activate or inactivate the Live Time saving in the nexus files.
enableDatasetdeadtime R Boolean Allows to activate or inactivate the Dead Time saving in the nexus files.
......
doc/doc_html/DanteDpp.html
+ 810
− 748
View file @ bdabe346
......@@ -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>DanteDpp</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 }
......@@ -620,11 +642,31 @@ TRUE [;c:my_locationmy_file.txt] (means create my_file.txt in c:my_location)</dd
</tr>
</thead>
<tbody valign="top">
<tr><td>currentAlias</td>
<td>R</td>
<td>String</td>
<td>Display the current Alias used to load the <em>.ini</em> file</td>
</tr>
<tr><td>currentConfigFile</td>
<td>R</td>
<td>String</td>
<td>Display the path+name of current loaded <em>.ini</em> file</td>
</tr>
<tr><td>currentRoisFile</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr><td>boardType</td>
<td>R</td>
<td>String</td>
<td>The Board type Fixed by the BoardType property</td>
</tr>
<tr><td>currentMode</td>
<td>R</td>
<td>String</td>
<td>Display the current Mode : MCA, MAPPING_FULL, MAPPING_SCA</td>
</tr>
<tr><td>nbModules</td>
<td>R</td>
<td>ULong</td>
......@@ -640,45 +682,60 @@ TRUE [;c:my_locationmy_file.txt] (means create my_file.txt in c:my_location)</dd
<td>ULong</td>
<td>Number of bins per channel</td>
</tr>
<tr><td>currentAlias</td>
<tr><td>triggerMode</td>
<td>R/W</td>
<td>Enum</td>
<td>The current trigger mode. Available values : INTERNAL / GATE</td>
</tr>
<tr><td>currentPixel</td>
<td>R</td>
<td>String</td>
<td>Display the current Alias used to load the <em>.ini</em> file</td>
<td>ULong</td>
<td>Current pixel of the mapping.</td>
</tr>
<tr><td>currentMode</td>
<tr><td>nbPixels</td>
<td>R/W</td>
<td>ULong</td>
<td>Number of pixels (step) for the Mapping acquisition.</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>String</td>
<td>Display the current Mode : MCA, MAPPING_FULL, MAPPING_SCA</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>currentConfigFile</td>
<tr><td>realTime(i)</td>
<td>R</td>
<td>String</td>
<td>Display the path+name of current loaded <em>.ini</em> file</td>
<td>Double</td>
<td>The total time that the processor was taking data in seconds</td>
</tr>
<tr><td>currentRoisAlias</td>
<tr><td>liveTime(i)</td>
<td>R</td>
<td>String</td>
<td>Display the current Rois Alias used to load the Rois file</td>
<td>Double</td>
<td>The total time that the processor was able to acquire new events in seconds.</td>
</tr>
<tr><td>currentRoisFile</td>
<tr><td>inputCountRate(i)</td>
<td>R</td>
<td>String</td>
<td>Display the path+name of current loaded Rois file.</td>
<td>Double</td>
<td>Input Count Rate: OCR/(1-(Deadtime/100)) =&gt; (scaler4/(scaler8/80000000.0))/(1-(scaler10 /100))</td>
</tr>
<tr><td>peakingTime</td>
<tr><td>outputCountRate(i)</td>
<td>R</td>
<td>Double</td>
<td>Peaking time of the energy filter, specified in us</td>
<td>Output Count Rate: AllGood/Time =&gt; scaler4/(scaler8/80000000.0)</td>
</tr>
<tr><td>dynamicRange</td>
<td>R/W</td>
<td>Boolean</td>
<td>Energy range corresponding to 40% of the total ADC range, specified in eV</td>
<tr><td>eventsInRun(i)</td>
<td>R</td>
<td>ULong</td>
<td>Number of all event triggers =&gt; scaler3</td>
</tr>
<tr><td>fileGeneration</td>
<td>R/W</td>
<td>Boolean</td>
<td>Available only for expert user. Enable/Disable writing the data to a file.</td>
<tr><td>deadTime(i)</td>
<td>R</td>
<td>Double</td>
<td>Deadtime as calculated by (ICR - OCR) / ICR</td>
</tr>
<tr><td>streamType</td>
<td>W</td>
......@@ -700,6 +757,11 @@ TRUE [;c:my_locationmy_file.txt] (means create my_file.txt in c:my_location)</dd
<td>uLong</td>
<td>Available only for expert user. The number of acquisitions for each Stream file.</td>
</tr>
<tr><td>fileGeneration</td>
<td>R/W</td>
<td>Boolean</td>
<td>Available only for expert user. Enable/Disable writing the data to a file.</td>
</tr>
<tr><td>enableDatasetrealtime</td>
<td>R</td>
<td>Boolean</td>
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment

The place to be for your source code