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

WIP doc

Browse Source
This commit is contained in:
maliakal_d 2020-09-11 09:30:30 +02:00
parent 2805359cd0
commit 3b071cc43f
4 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
python/slsdet/detector.py
View File

@ -1209,6 +1209,12 @@ class Detector(CppDetectorApi):
@property @property
def threshold(self): def threshold(self):
"""[Eiger] Threshold in eV
Note
----
To change settings as well or set threshold without trimbits, use setThresholdEnergy.
:setter: It loads trim files from settingspath.
"""
return element_if_equal(self.getThresholdEnergy()) return element_if_equal(self.getThresholdEnergy())
@threshold.setter @threshold.setter
@ -1217,6 +1223,15 @@ class Detector(CppDetectorApi):
@property @property
def timing(self): def timing(self):
"""
Set Timing Mode of detector. Enum: timingMode
Note
-----
Default: AUTO_TIMING \n
[Jungfrau][Gotthard][Ctb][Moench][Gotthard2] AUTO_TIMING, TRIGGER_EXPOSURE \n
[Mythen3] AUTO_TIMING, TRIGGER_EXPOSURE, GATED, TRIGGER_GATED \n
[Eiger] AUTO_TIMING, TRIGGER_EXPOSURE, GATED, BURST_TRIGGER
"""
return element_if_equal(self.getTimingMode()) return element_if_equal(self.getTimingMode())
@timing.setter @timing.setter
@ -1355,6 +1370,7 @@ class Detector(CppDetectorApi):
@property @property
def tengiga(self): def tengiga(self):
"""[Eiger][Ctb][Moench][Mythen3] 10GbE Enable."""
return element_if_equal(self.getTenGiga()) return element_if_equal(self.getTenGiga())
@tengiga.setter @tengiga.setter

14
slsDetectorSoftware/include/Detector.h
View File

@ -231,9 +231,9 @@ class Detector {
Result<defs::timingMode> getTimingMode(Positions pos = {}) const; Result<defs::timingMode> getTimingMode(Positions pos = {}) const;
/** /**
* [Gotthard][Jungfrau][CTB][Moench][Mythen3] Options: * [Gotthard][Jungfrau][Gotthard][CTB][Moench][Gotthard2] Options:
* AUTO_TIMING, TRIGGER_EXPOSURE * AUTO_TIMING, TRIGGER_EXPOSURE \n
* [Gotthard2] Options: AUTO_TIMING, TRIGGER_EXPOSURE, GATED, TRIGGER_GATED * [Mythen3] Options: AUTO_TIMING, TRIGGER_EXPOSURE, GATED, TRIGGER_GATED \n
* [Eiger] Options: AUTO_TIMING, TRIGGER_EXPOSURE, GATED, BURST_TRIGGER * [Eiger] Options: AUTO_TIMING, TRIGGER_EXPOSURE, GATED, BURST_TRIGGER
*/ */
void setTimingMode(defs::timingMode value, Positions pos = {}); void setTimingMode(defs::timingMode value, Positions pos = {});
@ -367,9 +367,11 @@ class Detector {
/** gets list of dac enums for this detector */ /** gets list of dac enums for this detector */
std::vector<defs::dacIndex> getDacList() const; std::vector<defs::dacIndex> getDacList() const;
Result<int> getDAC(defs::dacIndex index, bool mV = false, Positions pos = {}) const; Result<int> getDAC(defs::dacIndex index, bool mV = false,
Positions pos = {}) const;
void setDAC(defs::dacIndex index, int value, bool mV = false, Positions pos = {}); void setDAC(defs::dacIndex index, int value, bool mV = false,
Positions pos = {});
/* [Gotthard2] */ /* [Gotthard2] */
Result<int> getOnChipDAC(defs::dacIndex index, int chipIndex, Result<int> getOnChipDAC(defs::dacIndex index, int chipIndex,
@ -851,7 +853,7 @@ class Detector {
/** [Eiger] */ /** [Eiger] */
Result<int> getThresholdEnergy(Positions pos = {}) const; Result<int> getThresholdEnergy(Positions pos = {}) const;
/** [Eiger] */ /** [Eiger] It loads trim files from settingspath */
void setThresholdEnergy(int threshold_ev, void setThresholdEnergy(int threshold_ev,
defs::detectorSettings settings = defs::STANDARD, defs::detectorSettings settings = defs::STANDARD,
bool trimbits = true, Positions pos = {}); bool trimbits = true, Positions pos = {});

3
slsDetectorSoftware/src/CmdProxy.cpp
View File

@ -1222,7 +1222,8 @@ std::string CmdProxy::Threshold(int action) {
if (action == defs::HELP_ACTION) { if (action == defs::HELP_ACTION) {
os << "[eV] [(optinal settings) standard, lowgain, veryhighgain, " os << "[eV] [(optinal settings) standard, lowgain, veryhighgain, "
"verylowgain]" "verylowgain]"
"\n\t[Eiger] Threshold in eV" "\n\t[Eiger] Threshold in eV. It loads trim files from "
"settingspath."
<< '\n'; << '\n';
} else if (action == defs::GET_ACTION) { } else if (action == defs::GET_ACTION) {
if (!args.empty()) { if (!args.empty()) {

4
slsDetectorSoftware/src/CmdProxy.h
View File

@ -1208,8 +1208,8 @@ class CmdProxy {
INTEGER_COMMAND(timing, getTimingMode, setTimingMode, INTEGER_COMMAND(timing, getTimingMode, setTimingMode,
sls::StringTo<slsDetectorDefs::timingMode>, sls::StringTo<slsDetectorDefs::timingMode>,
"[auto|trigger|gating|burst_trigger]\n\tTiming Mode of " "[auto|trigger|gating|burst_trigger]\n\tTiming Mode of "
"detector.\n\t[Jungfrau][Gotthard][Mythen3][Ctb][Moench] " "detector.\n\t[Jungfrau][Gotthard][Ctb][Moench][Gotthard2] "
"[auto|trigger]\n\t[Gotthard2] " "[auto|trigger]\n\t[Mythen3] "
"[auto|trigger|gating|trigger_gating]\n\t[Eiger] " "[auto|trigger|gating|trigger_gating]\n\t[Eiger] "
"[auto|trigger|gating|burst_trigger]"); "[auto|trigger|gating|burst_trigger]");