detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-20 16:48:01 +02:00
Code Issues Actions Packages Releases Activity

doc wip

Browse Source
This commit is contained in:
maliakal_d
2020-08-20 12:58:17 +02:00
parent c4fde7f7bc
commit 429eb8da53
4 changed files with 74 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
slsDetectorSoftware/src/CmdProxy.cpp
View File

@ -564,14 +564,12 @@ std::string CmdProxy::Adcphase(int action) {
if (action == defs::HELP_ACTION) {
os << "[n_value] "
"[(optional)deg]\n\t[Jungfrau][Ctb][Moench][Gotthard] "
"Phase "
"shift of ADC clock. \n\t[Jungfrau] Absolute phase shift. If deg "
"used, then shift in degrees. Changing Speed also resets "
"Phase shift of ADC clock. \n\t[Jungfrau] Absolute phase shift. "
"If deg used, then shift in degrees. Changing Speed also resets "
"adcphase to recommended defaults.\n\t[Ctb][Moench] Absolute "
"phase "
"shift. If deg used, then shift in degrees. Changing adcclk also "
"resets adcphase and sets it to previous values.\n\t[Gotthard] "
"Relative phase shift. Cannot get"
"phase shift. If deg used, then shift in degrees. Changing "
"adcclk also resets adcphase and sets it to previous "
"values.\n\t[Gotthard] Relative phase shift. Cannot get"
<< '\n';
} else {
auto det_type = det->getDetectorType().squash(defs::GENERIC);
@ -622,11 +620,9 @@ std::string CmdProxy::Dbitphase(int action) {
os << cmd << ' ';
if (action == defs::HELP_ACTION) {
os << "[n_value] [(optional)deg]\n\t[Ctb][Jungfrau] Phase shift of "
"clock to "
"latch digital bits. Absolute phase shift. If deg used, then "
"shift in degrees. \n\t[Ctb]Changing dbitclk also resets "
"dbitphase and "
"sets to previous values."
"clock to latch digital bits. Absolute phase shift. If deg used, "
"then shift in degrees. \n\t[Ctb]Changing dbitclk also resets "
"dbitphase and sets to previous values."
<< '\n';
} else {
auto det_type = det->getDetectorType().squash(defs::GENERIC);
@ -1764,8 +1760,9 @@ std::string CmdProxy::Counters(int action) {
std::ostringstream os;
os << cmd << ' ';
if (action == defs::HELP_ACTION) {
os << "[i0] [i1] [i2]... \n\t[Mythen3] List of counters enabled. Each "
"element in list can be 0 - 2 and must be non repetitive."
os << "[i0] [i1] [i2]... \n\t[Mythen3] List of counters indices "
"enabled. Each element in list can be 0 - 2 and must be non "
"repetitive."
<< '\n';
} else if (action == defs::GET_ACTION) {
if (!args.empty()) {

17
slsDetectorSoftware/src/CmdProxy.h
View File

@ -1103,7 +1103,7 @@ class CmdProxy {
/* configuration */
EXECUTE_SET_COMMAND_NOID_1ARG(
config, loadConfig,
"[fname]\n\tConfigures detector to configuration contained in fname. "
"[fname]\n\tFrees shared memory before loading configuration file. "
"Set up once.");
EXECUTE_SET_COMMAND_NOID_1ARG(
@ -1953,11 +1953,12 @@ class CmdProxy {
INTEGER_COMMAND(
auto_comp_disable, getAutoCompDisable, setAutoCompDisable,
StringTo<int>,
"[0, 1]\n\t[Jungfrau] Auto comparator disable mode. Default 0 or this "
"mode disabled(comparator enabled throughout). 1 enables mode. 0 "
"disables mode. This mode disables the on-chip gain switching "
"comparator automatically after 93.75% of exposure time (only for "
"longer than 100us).");
"[0, 1]\n\t[Jungfrau] Auto comparator disable mode. By default, the "
"on-chip gain switching is active during the entire exposure.This mode "
"disables the on - chip gain switching comparator automatically after "
"93.75% of exposure time (only for longer than 100us). \n\tDefault is "
"0 or this mode disabled(comparator enabled throughout). 1 enables "
"mode. 0 disables mode. ");
INTEGER_COMMAND_NOID(
storagecells, getNumberOfAdditionalStorageCells,
@ -2028,7 +2029,7 @@ class CmdProxy {
INTEGER_COMMAND(
asamples, getNumberOfAnalogSamples, setNumberOfAnalogSamples,
StringTo<int>,
"[0, 1]\n\t[CTB][Moench] Number of analog samples expected.");
"[n_samples]\n\t[CTB][Moench] Number of analog samples expected.");
INTEGER_COMMAND(
adcclk, getADCClock, setADCClock, StringTo<int>,
@ -2064,7 +2065,7 @@ class CmdProxy {
INTEGER_COMMAND(dsamples, getNumberOfDigitalSamples,
setNumberOfDigitalSamples, StringTo<int>,
"[0, 1]\n\t[CTB] Number of digital samples expected.");
"[n_value]\n\t[CTB] Number of digital samples expected.");
INTEGER_COMMAND(romode, getReadoutMode, setReadoutMode,
sls::StringTo<slsDetectorDefs::readoutMode>,