Merge pull request #391 from slsdetectorgroup/missingsigned

signed num missing packets

RELEASE.txt

@@ -40,6 +40,7 @@ This document describes the differences between v7.0.0 and v6.x.x
 - when in discard partial frames or empty mode, the frame number doesnt increase by 1, it increases to that number (so its faster)
 - file write disabled by default
 - start non blocking acquisition at modular level
+- missingpackets signed (negative => extra packets)
 
 
 2. Resolved Issues

python/slsdet/detector.py

@@ -1911,7 +1911,7 @@ class Detector(CppDetectorApi):
     @property
     @element
     def rx_missingpackets(self):
-        """Gets the number of missing packets for each port in receiver."""
+        """Gets the number of missing packets for each port in receiver. Negative number denotes extra packets. """
         return self.getNumMissingPackets()
 
     """

python/src/detector.cpp

@@ -490,11 +490,10 @@ void init_det(py::module &m) {
              (Result<int64_t>(Detector::*)(sls::Positions) const) &
                  Detector::getFramesCaught,
              py::arg() = Positions{})
-        .def(
+        .def("getNumMissingPackets",
-            "getNumMissingPackets",
+             (Result<std::vector<int64_t>>(Detector::*)(sls::Positions) const) &
-            (Result<std::vector<uint64_t>>(Detector::*)(sls::Positions) const) &
+                 Detector::getNumMissingPackets,
-                Detector::getNumMissingPackets,
+             py::arg() = Positions{})
-            py::arg() = Positions{})
         .def("getNextFrameNumber",
              (Result<uint64_t>(Detector::*)(sls::Positions) const) &
                  Detector::getNextFrameNumber,

slsDetectorSoftware/include/sls/Detector.h

@@ -588,11 +588,9 @@ class Detector {
 
     Result<int64_t> getFramesCaught(Positions pos = {}) const;
 
-    /** Gets the number of missing packets for each port in receiver.
+    /** Gets the number of missing packets for each port in receiver. Negative
-     * Troubleshoot: If they are large numbers, convert it to signed to get
+     * number denotes extra packets. */
-     * number of access packets received */
+    Result<std::vector<int64_t>> getNumMissingPackets(Positions pos = {}) const;
-    Result<std::vector<uint64_t>>
-    getNumMissingPackets(Positions pos = {}) const;
 
     /** [Eiger][Jungfrau][Moench][CTB] */
     Result<uint64_t> getNextFrameNumber(Positions pos = {}) const;

slsDetectorSoftware/src/CmdProxy.h

@@ -1536,7 +1536,8 @@ class CmdProxy {
                 "\n\tNumber of frames caught by receiver.");
 
     GET_COMMAND(rx_missingpackets, getNumMissingPackets,
-                "\n\tNumber of missing packets for each port in receiver.");
+                "\n\tNumber of missing packets for each port in receiver. "
+                "Negative number denotes extra packets.");
 
     INTEGER_COMMAND_VEC_ID(
         nextframenumber, getNextFrameNumber, setNextFrameNumber,

slsDetectorSoftware/src/Detector.cpp

@@ -797,7 +797,7 @@ Result<int64_t> Detector::getFramesCaught(Positions pos) const {
     return pimpl->Parallel(&Module::getFramesCaughtByReceiver, pos);
 }
 
-Result<std::vector<uint64_t>>
+Result<std::vector<int64_t>>
 Detector::getNumMissingPackets(Positions pos) const {
     return pimpl->Parallel(&Module::getNumMissingPackets, pos);
 }

slsDetectorSoftware/src/Module.cpp

@@ -870,7 +870,7 @@ int64_t Module::getFramesCaughtByReceiver() const {
     return sendToReceiver<int64_t>(F_GET_RECEIVER_FRAMES_CAUGHT);
 }
 
-std::vector<uint64_t> Module::getNumMissingPackets() const {
+std::vector<int64_t> Module::getNumMissingPackets() const {
     // TODO!(Erik) Refactor
     LOG(logDEBUG1) << "Getting num missing packets";
     if (shm()->useReceiverFlag) {
@@ -882,7 +882,7 @@ std::vector<uint64_t> Module::getNumMissingPackets() const {
                 " returned error: " + client.readErrorMessage());
         } else {
             auto nports = client.Receive<int>();
-            std::vector<uint64_t> retval(nports);
+            std::vector<int64_t> retval(nports);
             client.Receive(retval);
             LOG(logDEBUG1) << "Missing packets of Receiver" << moduleIndex
                            << ": " << sls::ToString(retval);

slsDetectorSoftware/src/Module.h

@@ -200,7 +200,7 @@ class Module : public virtual slsDetectorDefs {
     runStatus getReceiverStatus() const;
     double getReceiverProgress() const;
     int64_t getFramesCaughtByReceiver() const;
-    std::vector<uint64_t> getNumMissingPackets() const;
+    std::vector<int64_t> getNumMissingPackets() const;
     uint64_t getNextFrameNumber() const;
     void setNextFrameNumber(uint64_t value);
     void sendSoftwareTrigger(const bool block);