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

wip, doc

Browse Source
This commit is contained in:
maliakal_d 2020-09-21 17:27:49 +02:00
parent f5b8681811
commit a8cc47d25c
3 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
python/slsdet/detector.py
View File

@ -253,11 +253,12 @@ class Detector(CppDetectorApi):
----- -----
This value is used to calculate row and column positions for each module and included into udp data packet header. \n This value is used to calculate row and column positions for each module and included into udp data packet header. \n
By default, it adds modules in y dimension for 2d detectors and in x dimension for 1d detectors. By default, it adds modules in y dimension for 2d detectors and in x dimension for 1d detectors.
:setter: Not implemented
Example Example
------- -------
>>> d.detsize >>> d.detsize
Geometry(x=3840, y=1) Geometry(x=3840, y=1)
>>> d.detsize = [1024, 512]
Geometry(x=1024, y = 512)
""" """
return to_geo(self.getDetectorSize()) return to_geo(self.getDetectorSize())
@ -2761,6 +2762,14 @@ class Detector(CppDetectorApi):
@property @property
def initialchecks(self): def initialchecks(self):
"""
Enable or disable intial compatibility and other checks at detector start up.
Note
----
It is enabled by default. Must come before 'hostname' command to take effect. \n
Can be used to reprogram fpga when current firmware is incompatible. \n
Advanced user function!
"""
return self.getInitialChecks() return self.getInitialChecks()
@initialchecks.setter @initialchecks.setter

13
slsDetectorSoftware/include/Detector.h
View File

@ -353,9 +353,9 @@ class Detector {
Result<int> getImageTestMode(Positions pos = {}); Result<int> getImageTestMode(Positions pos = {});
/** [Gotthard] If 1, adds channel intensity with precalculated values. /** [Gotthard] If 1, adds channel intensity with precalculated values.
* Default is 0 * Default is 0 \n
* [Eiger virtual] If 1, pixels are saturated. If 0, increasing intensity * [Eiger][Jungfrau] Only for virtual servers, if 1, pixels are saturated.
* Only for virtual servers */ * If 0, increasing intensity */
void setImageTestMode(const int value, Positions pos = {}); void setImageTestMode(const int value, Positions pos = {});
/** gets list of temperature indices for this detector */ /** gets list of temperature indices for this detector */
@ -1122,6 +1122,7 @@ class Detector {
Result<std::array<int, 2>> getInjectChannel(Positions pos = {}); Result<std::array<int, 2>> getInjectChannel(Positions pos = {});
/** [Gotthard2] /** [Gotthard2]
* Inject channels with current source for calibration.
* offsetChannel is starting channel to be injected * offsetChannel is starting channel to be injected
* incrementChannel is determines succeeding channels to be injected */ * incrementChannel is determines succeeding channels to be injected */
void setInjectChannel(const int offsetChannel, const int incrementChannel, void setInjectChannel(const int offsetChannel, const int incrementChannel,
@ -1577,8 +1578,10 @@ class Detector {
/** Advanced user Function! */ /** Advanced user Function! */
bool getInitialChecks() const; bool getInitialChecks() const;
/** initial compaibility and other server start up checks /** Enables/disabled initial compaibility and other server start up checks.
* default enabled Advanced user Function! */ * \n Default is enabled. Must come before 'hostname' command to take
* effect. \n Can be used to reprogram fpga when current firmware is
* incompatible. \n Advanced user Function! */
void setInitialChecks(const bool value); void setInitialChecks(const bool value);
/** [CTB][Moench][Jungfrau] Advanced user Function! */ /** [CTB][Moench][Jungfrau] Advanced user Function! */

3
slsDetectorSoftware/src/CmdProxy.cpp
View File

@ -2612,7 +2612,8 @@ std::string CmdProxy::InitialChecks(int action) {
os << "[0, 1]\n\tEnable or disable intial compatibility and other " os << "[0, 1]\n\tEnable or disable intial compatibility and other "
"checks at detector start up. It is enabled by default. Must " "checks at detector start up. It is enabled by default. Must "
"come before 'hostname' command to take effect. Can be used to " "come before 'hostname' command to take effect. Can be used to "
"reprogram fpga when current firmware is incompatible." "reprogram fpga when current firmware is "
"incompatible.\n\tAdvanced User function!"
<< '\n'; << '\n';
} else if (action == defs::GET_ACTION) { } else if (action == defs::GET_ACTION) {
if (det_id != -1) { if (det_id != -1) {