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

WIP doc

Browse Source
This commit is contained in:
maliakal_d
2020-08-21 13:05:33 +02:00
parent 3aa75ce167
commit 4f45110cda
4 changed files with 63 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
slsDetectorSoftware/include/Detector.h
View File

@ -214,10 +214,9 @@ class Detector {
Result<int> getDynamicRange(Positions pos = {}) const;
/**
* [Eiger] Options: 4, 8, 16, 32
* [Mythen3] Options: 8, 16, 32
* [Eiger] If i is 32, also sets clkdivider to 2, if 16, sets clkdivider to
* 1
* [Eiger] Options: 4, 8, 16, 32. If i is 32, also sets clkdivider to 2, if
* 16, sets clkdivider to 1 \n [Mythen3] Options: 8, 16, 32 \n
* [Jungfrau][Gotthard][Ctb][Moench][Mythen3][Gotthard2] 16
*/
void setDynamicRange(int value);
@ -355,7 +354,7 @@ class Detector {
*/
Result<int> getTemperature(defs::dacIndex index, Positions pos = {}) const;
/** gets list of dac indices for this detector */
/** gets list of dac enums for this detector */
std::vector<defs::dacIndex> getDacList() const;
Result<int> getDAC(defs::dacIndex index, bool mV, Positions pos = {}) const;
@ -680,6 +679,7 @@ class Detector {
Result<std::string> getFilePath(Positions pos = {}) const;
/** If path does not exist, it will try to create it */
void setFilePath(const std::string &fpath, Positions pos = {});
Result<std::string> getFileNamePrefix(Positions pos = {}) const;
@ -692,16 +692,17 @@ class Detector {
Result<int64_t> getAcquisitionIndex(Positions pos = {}) const;
/** file or Acquisition index in receiver */
void setAcquisitionIndex(int64_t i, Positions pos = {});
Result<bool> getFileWrite(Positions pos = {}) const;
/** default writes */
/** default enabled */
void setFileWrite(bool value, Positions pos = {});
Result<bool> getMasterFileWrite(Positions pos = {}) const;
/* default writes */
/* default enabled */
void setMasterFileWrite(bool value, Positions pos = {});
Result<bool> getFileOverWrite(Positions pos = {}) const;

3
slsDetectorSoftware/src/CmdProxy.cpp
View File

@ -472,7 +472,8 @@ std::string CmdProxy::DynamicRange(int action) {
os << "[value]\n\tDynamic Range or number of bits per "
"pixel in detector.\n\t"
"[Eiger] Options: 4, 8, 16, 32\n\t"
"[Mythen3] Options: 8, 16, 32"
"[Mythen3] Options: 8, 16, 32\n\t"
"[Jungfrau][Gotthard][Ctb][Moench][Mythen3][Gotthard2] 16"
<< '\n';
} else if (action == defs::GET_ACTION) {
if (!args.empty()) {

8
slsDetectorSoftware/src/CmdProxy.h
View File

@ -1805,15 +1805,17 @@ class CmdProxy {
STRING_COMMAND(
fpath, getFilePath, setFilePath,
"[path]\n\tDirectory where output data files are written in receiver.");
"[path]\n\tDirectory where output data files are written in receiver. "
"If path does not exist, it will try to create it.");
STRING_COMMAND(fname, getFileNamePrefix, setFileNamePrefix,
"[path]\n\tFile name prefix for output data file. Default "
"[name]\n\tFile name prefix for output data file. Default "
"is run. File name: [file name prefix]_d[detector "
"index]_f[sub file index]_[acquisition/file index].raw.");
INTEGER_COMMAND(findex, getAcquisitionIndex, setAcquisitionIndex,
StringTo<int64_t>, "[0, 1]\n\tFile or Acquisition index.");
StringTo<int64_t>,
"[n_value]\n\tFile or Acquisition index.");
INTEGER_COMMAND(
fwrite, getFileWrite, setFileWrite, StringTo<int>,