From 1d1b55b864e24eb3e75b2f13c4c205f700e6db57 Mon Sep 17 00:00:00 2001 From: Mazzoleni Alice Francesca Date: Tue, 8 Apr 2025 15:57:11 +0200 Subject: [PATCH] changed documentation --- docs/src/masterfileattributes.rst | 4 ++-- slsDetectorSoftware/generator/commands.yaml | 2 +- slsDetectorSoftware/include/sls/Detector.h | 3 ++- slsDetectorSoftware/src/Caller.cpp | 2 +- slsReceiverSoftware/src/DataProcessor.h | 8 ++++---- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/src/masterfileattributes.rst b/docs/src/masterfileattributes.rst index 777c930ff..5190ee647 100644 --- a/docs/src/masterfileattributes.rst +++ b/docs/src/masterfileattributes.rst @@ -345,8 +345,8 @@ Chip Test Board +-----------------------+-------------------------------------------------+ | Dbit Offset | Digital offset of valid data in bytes | +-----------------------+-------------------------------------------------+ - | Dbit Reorder | Group bits of all samples together to have them | - | | contiguous in the file | + | Dbit Reorder | Reorder such that it groups each signal (0-63) | + | | from all the different samples together | +-----------------------+-------------------------------------------------+ | Dbit Bitset | Digital 64 bit mask of bits enabled in receiver | +-----------------------+-------------------------------------------------+ diff --git a/slsDetectorSoftware/generator/commands.yaml b/slsDetectorSoftware/generator/commands.yaml index 47e2e1898..f33cf7be2 100644 --- a/slsDetectorSoftware/generator/commands.yaml +++ b/slsDetectorSoftware/generator/commands.yaml @@ -1414,7 +1414,7 @@ lock: 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 actions: GET: diff --git a/slsDetectorSoftware/include/sls/Detector.h b/slsDetectorSoftware/include/sls/Detector.h index 8096f75a7..eb679a578 100644 --- a/slsDetectorSoftware/include/sls/Detector.h +++ b/slsDetectorSoftware/include/sls/Detector.h @@ -1732,7 +1732,8 @@ class Detector { /** [CTB] */ Result 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 * the board spits out, which is that all signals in a sample are grouped * together */ diff --git a/slsDetectorSoftware/src/Caller.cpp b/slsDetectorSoftware/src/Caller.cpp index c284b1957..78a6f79d7 100644 --- a/slsDetectorSoftware/src/Caller.cpp +++ b/slsDetectorSoftware/src/Caller.cpp @@ -10706,7 +10706,7 @@ std::string Caller::rx_dbitreorder(int action) { // print help if (action == slsDetectorDefs::HELP_ACTION) { 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; return os.str(); } diff --git a/slsReceiverSoftware/src/DataProcessor.h b/slsReceiverSoftware/src/DataProcessor.h index fd5b9dc1f..6e70072cd 100644 --- a/slsReceiverSoftware/src/DataProcessor.h +++ b/slsReceiverSoftware/src/DataProcessor.h @@ -96,14 +96,14 @@ class DataProcessor : private virtual slsDetectorDefs, public ThreadObject { /** * Align corresponding digital bits together (CTB only if ctbDbitlist is not * empty) - * set variable reorder to true if, data should be rearranged such that - * individual digital bits from all samples are consecutive in memory + * set variable reorder to true if data should be rearranged such that + * it groups each signal (0-63) from all the different samples together */ void ArrangeDbitData(size_t &size, char *data); /** - * reorder datastream such that individual digital bits from all samples are - * stored consecutively in memory + * reorder datastream such that each signal (0-63) from all the different + * samples are grouped together and stored consecutively in memory */ void Reorder(size_t &size, char *data);