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

added documentation of order in hostname command in quick start guide, udp header format for row and column values and in command line hostname (#1099)

Browse Source
This commit is contained in:
maliakal_d 2025-02-18 11:11:33 +01:00 committed by GitHub
parent 436d180e93
commit 6b149244d3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/quick_start_guide.rst
View File

@ -128,6 +128,10 @@ For Multiple Modules
# set file path # set file path
fpath /tmp fpath /tmp
.. note ::
The **hostname** and **detsize** command in a multi module system can affect the row and column values in the udp/zmq header. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
Gui Gui
---- ----

4
docs/src/udpheader.rst
View File

@ -73,9 +73,9 @@ Description
* **modId**: module ID picked up from det_id_[detector type].txt on the detector cpu. * **modId**: module ID picked up from det_id_[detector type].txt on the detector cpu.
* **row**: row position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command. * **row**: row position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
* **column**: column position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command. * **column**: column position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
* **detType**: detector type from enum of detectorType in the package. * **detType**: detector type from enum of detectorType in the package.

4
python/slsdet/detector.py
View File

@ -152,6 +152,10 @@ class Detector(CppDetectorApi):
"""Frees shared memory and sets hostname (or IP address) of all modules concatenated by + """Frees shared memory and sets hostname (or IP address) of all modules concatenated by +
Virtual servers can already use the port in hostname separated by ':' and ports incremented by 2 to accomodate the stop server as well. Virtual servers can already use the port in hostname separated by ':' and ports incremented by 2 to accomodate the stop server as well.
Note
-----
The row and column values in the udp/zmq header are affected by the order in this command and the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on. This only affects row and column in udp/zmq header.
Example Example
------- -------
>>> d.hostname = 'beb031+beb032+' >>> d.hostname = 'beb031+beb032+'

7
slsDetectorSoftware/include/sls/Detector.h
View File

@ -65,7 +65,12 @@ class Detector {
Result<std::string> getHostname(Positions pos = {}) const; Result<std::string> getHostname(Positions pos = {}) const;
/**Frees shared memory, adds detectors to the list. */ /**Frees shared memory, adds detectors to the list. The row and column
* values in the udp/zmq header are affected by the order in this command
* and the setDetectorSize function. The modules are stacked row by row
* until they reach the y-axis limit set by detsize (if specified). Then,
* stacking continues in the next column and so on. This only affects row
* and column in udp/zmq header.*/
void setHostname(const std::vector<std::string> &hostname); void setHostname(const std::vector<std::string> &hostname);
/** connects to n servers at local host starting at specific control port. /** connects to n servers at local host starting at specific control port.

7
slsDetectorSoftware/src/CallerSpecial.cpp
View File

@ -198,7 +198,12 @@ std::string Caller::hostname(int action) {
os << "\n\tFrees shared memory and sets hostname (or IP address) of " os << "\n\tFrees shared memory and sets hostname (or IP address) of "
"all modules concatenated by +.\n\t Virtual servers can already " "all modules concatenated by +.\n\t Virtual servers can already "
"use the port in hostname separated by ':' and ports incremented " "use the port in hostname separated by ':' and ports incremented "
"by 2 to accomodate the stop server as well." "by 2 to accomodate the stop server as well. The row and column "
"values in the udp/zmq header are affected by the order in this "
"command and the detsize command. The modules are stacked row by "
"row until they reach the y-axis limit set by detsize (if "
"specified). Then, stacking continues in the next column and so "
"on. This only affects row and column in udp/zmq header."
<< '\n'; << '\n';
} else if (action == defs::GET_ACTION) { } else if (action == defs::GET_ACTION) {
if (!args.empty()) { if (!args.empty()) {