Fix for the UT ZS decoder

This MR concerns fixes in the UT ZS decoder:

1. UT ZS decoder struggles with decoding the UTError packet whose minimal size is 128b even if empty (to comprise Flag Header). It causes an error because for an empty UT bank 32b are expected. We introduced a condition that skips this checkup for UTError smaller than 128b.
2. It also comprises several minor improvements in decoder printouts, changes in the processing of the input (RawEvent to RawBank::View), and rewriting the options file to adjust to changes introduced in the decoder.

Two fixes to UT decoder from !4559 (merged) :

1. Suppress UT clusters with 0 ADC charges.
2. Use integer to calculate LHCbID instead of float to avoid inconsistent result due to floating point rounding. Related MR: Equivalent Allen MR for LHCbID fix (Allen suppresses 0 ADC charge correctly): Allen!1607 (merged) ** ** patch generated by https://gitlab.cern.ch/lhcb/LHCb/-/jobs/38142817

UT/UTDAQ/src/component/UTRawBankToUTDigitsAlg.cpp

 /*****************************************************************************\
-* (c) Copyright 2000-2018 CERN for the benefit of the LHCb Collaboration      *
+* (c) Copyright 2000-2023 CERN for the benefit of the LHCb Collaboration      *
 *                                                                             *
 * This software is distributed under the terms of the GNU General Public      *
 * Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   *
@@ -11,15 +11,15 @@
 
 /** @class UTRawBankToUTDigitsAlg
  *
- *  Algorithm to decode UTRawBank to UTDigits (TELL40 decoder)
+ *  Algorithm to decode UTRawBank to UTDigits (CPU decoder)
  *  Implementation file for class : UTRawBankToUTDigitsAlg
  *
  *  - \b RawEventLocation: Location of UTRawBank
  *  - \b OutputDigitData:  Location of output UTDigit
  *
- *  @author Xuhao Yuan (based on code by A Beiter and M Needham)
  *  @author Wojciech Krupa (based on code by Xuhao Yuan, wokrupa@cern.ch)
- *  @date   2021-04-19  / 2023-05-25
+ *  @author Xuhao Yuan (based on code by A Beiter and M Needham)
+ *  @date   2021-04-19  / 2023-05-25 / 2024-04-17
  */
 
 #include "Event/RawBank.h"
@@ -40,27 +40,24 @@
 #include <string>
 #include <vector>
 
-class UTRawBankToUTDigitsAlg : public LHCb::Algorithm::Transformer<LHCb::UTDigits( const LHCb::RawEvent& )> {
+class UTRawBankToUTDigitsAlg : public LHCb::Algorithm::Transformer<LHCb::UTDigits( const LHCb::RawBank::View& )> {
 public:
   /// Standard constructor
   UTRawBankToUTDigitsAlg( const std::string& name, ISvcLocator* pSvcLocator )
-      : Transformer{name,
-                    pSvcLocator,
-                    {{"RawEventLocation", LHCb::RawEventLocation::Default}},
-                    {"OutputDigitData", LHCb::UTDigitLocation::UTDigits}} {
-    debug() << "UT TELL40 decoder initilisation" << endmsg;
-  }
-  LHCb::UTDigits      operator()( const LHCb::RawEvent& ) const override; ///< Algorithm execution
-  LHCb::RawBank::View UnpackBank( const LHCb::RawEvent& ) const;
+      : Transformer{name, pSvcLocator, {{"UTBank", {}}}, {"OutputDigitData", LHCb::UTDigitLocation::UTDigits}} {}
+
+  using PositionMethod = UTDecoder<::UTDAQ::version::v5>::PositionMethod;
+  LHCb::UTDigits operator()( const LHCb::RawBank::View& ) const override; ///< Algorithm execution
 
   // Counters for decoded banks
-  mutable Gaudi::Accumulators::Counter<> m_validHeaders{this, "#Nb Valid UT banks"};
-  mutable Gaudi::Accumulators::Counter<> m_validDigits{this, "#Nb Valid UT digits"};
-  mutable Gaudi::Accumulators::Counter<> m_invalidBanks{this, "#Nb Invalid banks"};
+  mutable Gaudi::Accumulators::Counter<> m_validBanks{this, "# Valid UT banks"};
+  mutable Gaudi::Accumulators::Counter<> m_validDigits{this, "# Valid UT digits"};
+  mutable Gaudi::Accumulators::Counter<> m_invalidBanks{this, "# Invalid banks"};
+  mutable Gaudi::Accumulators::Counter<> m_invalidDigits{this, "# Invalid digits - duplicate "};
+  mutable Gaudi::Accumulators::Counter<> m_errors_channel{this, "# Invalid UTChannelIDs"};
 
 private:
   // The readout tool for handling DAQID and ChannelID
-  std::string                m_eventtype;
   ToolHandle<IUTReadoutTool> readoutTool{this, "ReadoutTool", "UTReadoutTool"};
 };
 
@@ -69,36 +66,41 @@ DECLARE_COMPONENT( UTRawBankToUTDigitsAlg )
 
 using namespace LHCb;
 
-LHCb::RawBank::View UTRawBankToUTDigitsAlg::UnpackBank( const LHCb::RawEvent& rawevt ) const {
-  RawBank::BankType banktype;
-  banktype          = RawBank::UT;
-  const auto tBanks = rawevt.banks( banktype );
-  return tBanks;
-}
-
 //=============================================================================
 // Main execution
 //=============================================================================
-LHCb::UTDigits UTRawBankToUTDigitsAlg::operator()( const LHCb::RawEvent& rawevt ) const {
+LHCb::UTDigits UTRawBankToUTDigitsAlg::operator()( const LHCb::RawBank::View& rawevt ) const {
   // Retrieve  the decoded Digits
   LHCb::UTDigits digits;
-  for ( const auto& bank : UnpackBank( rawevt ) ) {
-    unsigned int source_id = LHCb::UTDAQ::boardIDfromSourceID( bank->sourceID() );
+  for ( const LHCb::RawBank* bank : rawevt ) {
+
     if ( bank->size() == 0 ) continue;
+
     if ( msgLevel( MSG::DEBUG ) ) {
       debug() << "------------------------- ------- UT RAW BANK  ------------------------------- -----------" << endmsg;
-      debug() << "UT RawBank version number " << std::hex << bank->version() << " type " << bank->type() << "sourceID "
-              << source_id << " size " << std::dec << bank->size() << endmsg;
-      debug() << "|   |      HEADER           | LANE5     | LANE4     | LANE3     | LANE2     | LANE1     | LANE0     |"
+      debug() << "Bank: 0x" << std::uppercase << std::hex << bank->sourceID() << endmsg;
+      debug() << "   Size: " << std::dec << bank->size() << "B" << endmsg;
+      debug() << "   Type: " << bank->type() << endmsg;
+      debug() << "   Version: " << bank->version() << endmsg;
+      debug() << "|     |      HEADER                 | LANE5        | LANE4        | LANE3        | LANE2        "
+                 "| LANE1        | LANE0       |"
               << endmsg;
-      // Dump raw UT bank
-      u_int8_t iw2 = 0;
+      u_int8_t     iw2     = 0;
+      unsigned int counter = 0;
       for ( const u_int8_t* w = bank->begin<u_int8_t>(); w != bank->end<u_int8_t>(); ++w ) {
         ++iw2;
         if ( ( iw2 - 1 ) % 32 == 0 ) {
-          if ( iw2 != 1 ) debug() << endmsg;
+          counter++;
+          if ( counter % 34 == 0 ) {
+            debug() << endmsg;
+            debug() << "---------------------------------------------------------------------------------------------"
+                       "-------------------------------"
+                    << endmsg;
+          }
+          debug() << endmsg;
           debug() << "0x" << std::setfill( '0' ) << std::setw( 2 ) << std::hex << unsigned( iw2 ) << " ";
         }
+        if ( ( iw2 - 1 ) % 4 == 0 ) debug() << " | ";
         debug() << std::uppercase << std::hex << std::setw( 2 ) << unsigned( *w ) << " ";
       }
       debug() << endmsg;
@@ -110,46 +112,57 @@ LHCb::UTDigits UTRawBankToUTDigitsAlg::operator()( const LHCb::RawEvent& rawevt
         std::string bxid = std::bitset<12>( decoder.getBXID() ).to_string();
         std::string flag = std::bitset<4>( decoder.getflags() ).to_string();
         debug() << "Bxid: " << bxid << " " << std::dec << decoder.getBXID() << " Flag bits: " << flag << endmsg;
-        debug() << "Clusters in lanes from 0 to 5: ";
+        debug() << "Digits in lanes from 0 to 5: ";
         for ( unsigned int lane = 0; lane < 6; lane++ ) { debug() << decoder.nClusters( lane ) << " "; }
         debug() << endmsg;
       }
-      // If there is data bank, decode ZS events
       for ( const auto& aWord : decoder.posRange() ) {
-        UTDAQID daqid;
-        daqid = UTDAQID( ( UTDAQID::BoardID )( source_id ), ( UTDAQID::LaneID )( aWord.channelID() / 512 ),
+        // Catch problems during construction of UTChannelID which may be caused by the timing violation
+        try {
+          UTDAQID                 daqid( ( UTDAQID::BoardID )( LHCb::UTDAQ::boardIDfromSourceID( bank->sourceID() ) ),
+                         ( UTDAQID::LaneID )( aWord.channelID() / 512 ),
                          ( UTDAQID::ChannelID )( aWord.channelID() & 0x1ff ) );
-        Detector::UT::ChannelID channelID = readoutTool->daqIDToChannelID( daqid );
-        if ( msgLevel( MSG::DEBUG ) ) {
-          std::string binary = std::bitset<16>( aWord.value() ).to_string();
-          debug() << "----------- DECODED DIGIT --------------------" << endmsg;
-          debug() << "Binary: " << binary << " Hex: " << std::hex << std::setfill( '0' ) << std::uppercase
-                  << std::setw( 4 ) << aWord.value() << endmsg;
-          debug() << "Channel from data bank: " << std::dec << aWord.channelID()
-                  << " ADC from data bank: " << aWord.adc() << endmsg;
-          debug() << "ClusterSize: " << aWord.clusterSize() << " ClusterCharge: " << aWord.clusterCharge()
-                  << " FracStripBits: " << aWord.fractionalStripPosition() << endmsg;
-          debug() << "ChannelID from data and event header: " << ( UTDAQID::ChannelID )( aWord.channelID() & 0x1ff )
-                  << endmsg;
-          debug() << daqid << endmsg;
-          debug() << channelID << endmsg;
+          Detector::UT::ChannelID channelID = readoutTool->daqIDToChannelID( daqid );
+          if ( msgLevel( MSG::DEBUG ) ) {
+            debug() << "----------- DECODED DIGIT --------------------" << endmsg;
+            std::string binary = std::bitset<16>( aWord.value() ).to_string();
+            debug() << "Binary: " << binary << " Hex: " << std::hex << std::setfill( '0' ) << std::uppercase
+                    << std::setw( 4 ) << aWord.value() << endmsg;
+            debug() << "Channel from data bank: " << std::dec << aWord.channelID()
+                    << " ADC from data bank: " << aWord.adc() << endmsg;
+            debug() << daqid << endmsg;
+            debug() << channelID << endmsg;
+          }
+          ++m_validDigits;
+          // Catch problem during inserting to keyed container (also may be caused by the timing violation).
+          try {
+            digits.insert( new UTDigit( channelID, aWord.adc(), daqid.id() ), channelID );
+          } catch ( const std::exception& ex ) {
+            if ( msgLevel( MSG::WARNING ) ) {
+              if ( msgLevel( MSG::WARNING ) ) warning() << ex.what() << endmsg;
+            }
+            ++m_invalidDigits;
+          }
+        } catch ( ... ) {
+          if ( msgLevel( MSG::WARNING ) ) {
+            warning() << "Warning!: Problem with channel ID: " << aWord.channelID() << endmsg;
+          }
+          ++m_errors_channel;
+          continue;
         }
-        ++m_validDigits;
-        digits.insert( new UTDigit( channelID, aWord.adc(), daqid.id() ), channelID );
       }
     };
-
     if ( ::UTDAQ::version{bank->version()} == ::UTDAQ::version::v2 ) {
       decode( UTDecoder<::UTDAQ::version::v2>{*bank} );
-      ++m_validHeaders;
+      ++m_validBanks;
     } else if ( ::UTDAQ::version{bank->version()} == ::UTDAQ::version::v5 ) {
       decode( UTDecoder<::UTDAQ::version::v5>{*bank} );
+      ++m_validBanks;
     } else {
-      debug() << "Wrong version of the RawBank" << endmsg;
+      error() << "Wrong version of the RawBank" << endmsg;
       ++m_invalidBanks;
     }
   }
-
   return digits;
 }