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

changed documentation

Browse Source
This commit is contained in:
Mazzoleni Alice Francesca
2025-04-08 15:57:11 +02:00
parent 96ae1a1cca
commit 1d1b55b864
5 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/masterfileattributes.rst
View File

@ -345,8 +345,8 @@ Chip Test Board
+-----------------------+-------------------------------------------------+ +-----------------------+-------------------------------------------------+
| Dbit Offset | Digital offset of valid data in bytes | | Dbit Offset | Digital offset of valid data in bytes |
+-----------------------+-------------------------------------------------+ +-----------------------+-------------------------------------------------+
| Dbit Reorder | Group bits of all samples together to have them | | Dbit Reorder | Reorder such that it groups each signal (0-63) |
| | contiguous in the file | | | from all the different samples together |
+-----------------------+-------------------------------------------------+ +-----------------------+-------------------------------------------------+
| Dbit Bitset | Digital 64 bit mask of bits enabled in receiver | | Dbit Bitset | Digital 64 bit mask of bits enabled in receiver |
+-----------------------+-------------------------------------------------+ +-----------------------+-------------------------------------------------+

2
slsDetectorSoftware/generator/commands.yaml
View File

@ -1414,7 +1414,7 @@ lock:
rx_dbitreorder: rx_dbitreorder:
help: "[0, 1]\n\t[Ctb] Reorder digital data to group together all samples per signal. Default is 1. Setting to 0 means 'do not reorder' and to keep what the board spits out, which is that all signals in a sample are grouped together." help: "[0, 1]\n\t[Ctb] Reorder digital data such that it groups each signal (0-63) from all the different samples together . Default is 1. Setting to 0 means 'do not reorder' and to keep what the board spits out, which is that all signals in a sample are grouped together."
inherit_actions: INTEGER_COMMAND_VEC_ID inherit_actions: INTEGER_COMMAND_VEC_ID
actions: actions:
GET: GET:

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

@ -1732,7 +1732,8 @@ class Detector {
/** [CTB] */ /** [CTB] */
Result<bool> getRxDbitReorder(Positions pos = {}) const; Result<bool> getRxDbitReorder(Positions pos = {}) const;
/** [CTB] Reorder digital data to group together all samples per signal. /** [CTB] Reorder digital data such that it groups each signal (0-63)
* from all the different samples together.
* Default is true. Setting to false means 'do not reorder' and to keep what * Default is true. Setting to false means 'do not reorder' and to keep what
* the board spits out, which is that all signals in a sample are grouped * the board spits out, which is that all signals in a sample are grouped
* together */ * together */

2
slsDetectorSoftware/src/Caller.cpp
View File

@ -10706,7 +10706,7 @@ std::string Caller::rx_dbitreorder(int action) {
// print help // print help
if (action == slsDetectorDefs::HELP_ACTION) { if (action == slsDetectorDefs::HELP_ACTION) {
os << R"V0G0N([0, 1] os << R"V0G0N([0, 1]
[Ctb] Reorder digital data to group together all samples per signal. Default is 1. Setting to 0 means 'do not reorder' and to keep what the board spits out, which is that all signals in a sample are grouped together. )V0G0N" [Ctb] Reorder digital data such that it groups each signal (0-63) from all the different samples together . Default is 1. Setting to 0 means 'do not reorder' and to keep what the board spits out, which is that all signals in a sample are grouped together. )V0G0N"
<< std::endl; << std::endl;
return os.str(); return os.str();
} }

8
slsReceiverSoftware/src/DataProcessor.h
View File

@ -96,14 +96,14 @@ class DataProcessor : private virtual slsDetectorDefs, public ThreadObject {
/** /**
* Align corresponding digital bits together (CTB only if ctbDbitlist is not * Align corresponding digital bits together (CTB only if ctbDbitlist is not
* empty) * empty)
* set variable reorder to true if, data should be rearranged such that * set variable reorder to true if data should be rearranged such that
* individual digital bits from all samples are consecutive in memory * it groups each signal (0-63) from all the different samples together
*/ */
void ArrangeDbitData(size_t &size, char *data); void ArrangeDbitData(size_t &size, char *data);
/** /**
* reorder datastream such that individual digital bits from all samples are * reorder datastream such that each signal (0-63) from all the different
* stored consecutively in memory * samples are grouped together and stored consecutively in memory
*/ */
void Reorder(size_t &size, char *data); void Reorder(size_t &size, char *data);