Suppress HBFUtils.bcFirst (1st BC always 0), add orbitFirstSampled for MC, set default nHBFPerTF=128

Author: shahor02

Detectors/MUON/MCH/Raw/test/testClosureCoDec.cxx

@@ -112,7 +112,6 @@ std::vector<std::byte> createBuffer(gsl::span<std::string> data,
 
   const o2::raw::HBFUtils& hbfutils = o2::raw::HBFUtils::Instance();
   o2::conf::ConfigurableParam::setValue<uint32_t>("HBFUtils", "orbitFirst", orbit);
-  o2::conf::ConfigurableParam::setValue<uint16_t>("HBFUtils", "bcFirst", bc);
   std::vector<std::byte> out = o2::mch::raw::paginate(buffer,
                                                       isUserLogicFormat<FORMAT>::value,
                                                       isChargeSumMode<CHARGESUM>::value,

Detectors/MUON/MID/Raw/src/Encoder.cxx

@@ -102,7 +102,7 @@ void Encoder::finalize(bool closeFile)
 {
   /// Writes remaining data and closes the file
   if (mLastIR.isDummy()) {
-    mLastIR.bc = mRawWriter.getHBFUtils().bcFirst;
+    mLastIR.bc = 0;
     mLastIR.orbit = mRawWriter.getHBFUtils().orbitFirst;
   }
   auto ir = getOrbitIR(mLastIR.orbit);

Detectors/Raw/include/DetectorsRaw/HBFUtils.h

@@ -27,7 +27,7 @@ namespace raw
 {
 /*
     In the MC->Raw conversion we have to make sure that
-    1) The HB and TF starts are in sync for all detectors regardless on time (bc/orbir)
+    1) The HB and TF starts are in sync for all detectors regardless on time (0/orbit)
     distribution of its signal.
     2) All HBF and TF (RAWDataHeaders with corresponding HB and TF trigger flags) are present
     in the emulated raw data, even if some of them had no data in particular detector.
@@ -42,8 +42,7 @@ namespace raw
 struct HBFUtils : public o2::conf::ConfigurableParamHelper<HBFUtils> {
   using IR = o2::InteractionRecord;
 
-
-  IR getFirstIR() const { return {bcFirst, orbitFirst}; }
+  IR getFirstIR() const { return {0, orbitFirst}; }
 
   int getNOrbitsPerTF() const { return nHBFPerTF; }
 
@@ -69,6 +68,9 @@ struct HBFUtils : public o2::conf::ConfigurableParamHelper<HBFUtils> {
   ///< get 1st IR of the TF corresponding to provided interaction record
   IR getFirstIRofTF(const IR& rec) const { return getIRTF(getTF(rec)); }
 
+  ///< get 1st IR of TF corresponding to the 1st sampled orbit (in MC)
+  IR getFirstSampledTFIR() const { return getFirstIRofTF({0, orbitFirstSampled}); }
+
   ///< get TF and HB (abs) for this IR
   std::pair<int, int> getTFandHB(const IR& rec) const
   {
@@ -123,10 +125,12 @@ struct HBFUtils : public o2::conf::ConfigurableParamHelper<HBFUtils> {
 
   void print() const { printKeyValues(true); }
 
-  int nHBFPerTF = 1 + 0xff; // number of orbits per BC
-  uint16_t bcFirst = 0;     ///< BC of 1st TF
-  uint32_t orbitFirst = 0;  ///< orbit of 1st TF
-  uint32_t maxNOrbits = 0xffffffff; // max number of orbits to accept, used in digit->raw conversion
+  int nHBFPerTF = 128;     ///< number of orbits per BC
+  uint32_t orbitFirst = 0; ///< orbit of 1st TF of the run
+
+  // used for MC
+  uint32_t orbitFirstSampled = 0;   ///< 1st orbit sampled in the MC
+  uint32_t maxNOrbits = 0xffffffff; ///< max number of orbits to accept, used in digit->raw conversion
 
   O2ParamDef(HBFUtils, "HBFUtils");
 };
@@ -140,10 +144,10 @@ void HBFUtils::updateRDH(H& rdh, const IR& rec, bool setHBTF) const
 
   if (setHBTF) { // need to set the HBF IR and HB / TF trigger flags
     auto tfhb = getTFandHBinTF(rec);
-    RDHUtils::setHeartBeatBC(rdh, bcFirst);
+    RDHUtils::setHeartBeatBC(rdh, 0);
     RDHUtils::setHeartBeatOrbit(rdh, rec.orbit);
 
-    if (rec.bc == bcFirst) { // if we are starting new HB, set the HB trigger flag
+    if (rec.bc == 0) { // if we are starting new HB, set the HB trigger flag
       auto trg = RDHUtils::getTriggerType(rdh) | (o2::trigger::ORBIT | o2::trigger::HB);
       if (tfhb.second == 0) { // if we are starting new TF, set the TF trigger flag
         trg |= o2::trigger::TF;

Detectors/Raw/include/DetectorsRaw/RawFileReader.h

@@ -267,7 +267,7 @@ class RawFileReader
   o2::header::DataDescription getDefaultDataSpecification() const { return mDefDataDescription; }
   ReadoutCardType getDefaultReadoutCardType() const { return mDefCardType; }
 
-  void imposeFirstTF(uint32_t orbit, uint16_t bc);
+  void imposeFirstTF(uint32_t orbit);
   void setTFAutodetect(FirstTFDetection v) { mFirstTFAutodetect = v; }
   void setPreferCalculatedTFStart(bool v) { mPreferCalculatedTFStart = v; }
   FirstTFDetection getTFAutodetect() const { return mFirstTFAutodetect; }

Detectors/Raw/src/HBFUtils.cxx

@@ -26,7 +26,7 @@ uint32_t HBFUtils::getHBF(const IR& rec) const
   auto diff = rec.differenceInBC(getFirstIR());
   if (diff < 0) {
     LOG(ERROR) << "IR " << rec.bc << '/' << rec.orbit << " is ahead of the reference IR "
-               << bcFirst << '/' << orbitFirst;
+               << "0/" << orbitFirst;
     throw std::runtime_error("Requested IR is ahead of the reference IR");
   }
   return diff / o2::constants::lhc::LHCMaxBunches;
@@ -39,7 +39,7 @@ int HBFUtils::fillHBIRvector(std::vector<IR>& dst, const IR& fromIR, const IR& t
   // BCs between interaction records "fromIR" and "toIR" (inclusive).
   dst.clear();
   int hb0 = getHBF(fromIR), hb1 = getHBF(toIR);
-  if (fromIR.bc != bcFirst) { // unless we are just starting the HBF of fromIR, it was already counted
+  if (fromIR.bc != 0) { // unless we are just starting the HBF of fromIR, it was already counted
     hb0++;
   }
   for (int ihb = hb0; ihb <= hb1; ihb++) {

Detectors/Raw/src/RawFileReader.cxx

@@ -374,7 +374,7 @@ bool RawFileReader::LinkData::preprocessCRUPage(const RDHAny& rdh, bool newSPage
         }
       }
       if (!irOfSOX.isDummy() && reader->getTFAutodetect() == FirstTFDetection::Pending) {
-        reader->imposeFirstTF(irOfSOX.orbit, irOfSOX.bc);
+        reader->imposeFirstTF(irOfSOX.orbit);
       }
     }
     auto newTFCalc = blocks.empty() || HBU.getTF(blocks.back().ir) < HBU.getTF(ir);
@@ -482,7 +482,7 @@ bool RawFileReader::LinkData::preprocessCRUPage(const RDHAny& rdh, bool newSPage
     if (newTF) {
       if (reader->getTFAutodetect() == FirstTFDetection::Pending) { // impose first TF
         if (cruDetector) {
-          reader->imposeFirstTF(hbIR.orbit, hbIR.bc);
+          reader->imposeFirstTF(hbIR.orbit);
           bl.tfID = HBU.getTF(hbIR); // update
         } else {
           throw std::runtime_error("HBFUtil first orbit/bc autodetection cannot be done with first link from CRORC detector");
@@ -901,14 +901,13 @@ RawFileReader::InputsMap RawFileReader::parseInput(const std::string& confUri)
   return entries;
 }
 
-void RawFileReader::imposeFirstTF(uint32_t orbit, uint16_t bc)
+void RawFileReader::imposeFirstTF(uint32_t orbit)
 {
   if (mFirstTFAutodetect != FirstTFDetection::Pending) {
     throw std::runtime_error("reader was not expecting imposing first TF");
   }
   auto& hbu = o2::raw::HBFUtils::Instance();
   o2::raw::HBFUtils::setValue("HBFUtils", "orbitFirst", orbit);
-  o2::raw::HBFUtils::setValue("HBFUtils", "bcFirst", bc);
   LOG(INFO) << "Imposed data-driven TF start";
   mFirstTFAutodetect = FirstTFDetection::Done;
   hbu.printKeyValues();