Add HMPID to CTF workflows + CTF unit test

Author: shahor02

Detectors/CTF/CMakeLists.txt

@@ -95,3 +95,11 @@ o2_add_test(trd
             SOURCES test/test_ctf_io_trd.cxx
             COMPONENT_NAME ctf
             LABELS ctf)
+    
+o2_add_test(hmpid
+            PUBLIC_LINK_LIBRARIES O2::CTFWorkflow
+                                  O2::DataFormatsHMP
+                                  O2::HMPIDReconstruction
+            SOURCES test/test_ctf_io_hmpid.cxx
+            COMPONENT_NAME ctf
+            LABELS ctf)

Detectors/CTF/test/test_ctf_io_hmpid.cxx

@@ -0,0 +1,103 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+#define BOOST_TEST_MODULE Test HMPIDCTFIO
+#define BOOST_TEST_MAIN
+#define BOOST_TEST_DYN_LINK
+#include <boost/test/unit_test.hpp>
+#include "DetectorsCommonDataFormats/NameConf.h"
+#include "HMPIDReconstruction/CTFCoder.h"
+#include "DataFormatsHMP/CTF.h"
+#include "Framework/Logger.h"
+#include <TFile.h>
+#include <TRandom.h>
+#include <TStopwatch.h>
+#include <TSystem.h>
+#include <cstring>
+
+using namespace o2::hmpid;
+
+BOOST_AUTO_TEST_CASE(CTFTest)
+{
+  std::vector<Trigger> triggers;
+  std::vector<Digit> digits;
+  TStopwatch sw;
+  sw.Start();
+  o2::InteractionRecord ir(0, 0);
+  Digit clu;
+  for (int irof = 0; irof < 1000; irof++) {
+    ir += 1 + gRandom->Integer(200);
+
+    auto start = digits.size();
+    uint8_t chID = 0;
+    int n = 0;
+    while ((chID += gRandom->Integer(10)) < 0xff) {
+      uint16_t q = gRandom->Integer(0xffff);
+      uint8_t ph = gRandom->Integer(0xff);
+      uint8_t x = gRandom->Integer(0xff);
+      uint8_t y = gRandom->Integer(0xff);
+      digits.emplace_back(chID, ph, x, y, q);
+    }
+    triggers.emplace_back(ir, start, digits.size() - start);
+  }
+
+  sw.Start();
+  std::vector<o2::ctf::BufferType> vec;
+  {
+    CTFCoder coder;
+    coder.encode(vec, triggers, digits); // compress
+  }
+  sw.Stop();
+  LOG(INFO) << "Compressed in " << sw.CpuTime() << " s";
+
+  // writing
+  {
+    sw.Start();
+    auto* ctfImage = o2::hmpid::CTF::get(vec.data());
+    TFile flOut("test_ctf_hmpid.root", "recreate");
+    TTree ctfTree(std::string(o2::base::NameConf::CTFTREENAME).c_str(), "O2 CTF tree");
+    ctfImage->print();
+    ctfImage->appendToTree(ctfTree, "HMP");
+    ctfTree.Write();
+    sw.Stop();
+    LOG(INFO) << "Wrote to tree in " << sw.CpuTime() << " s";
+  }
+
+  // reading
+  vec.clear();
+  LOG(INFO) << "Start reading from tree ";
+  {
+    sw.Start();
+    TFile flIn("test_ctf_hmpid.root");
+    std::unique_ptr<TTree> tree((TTree*)flIn.Get(std::string(o2::base::NameConf::CTFTREENAME).c_str()));
+    BOOST_CHECK(tree);
+    o2::hmpid::CTF::readFromTree(vec, *(tree.get()), "HMP");
+    sw.Stop();
+    LOG(INFO) << "Read back from tree in " << sw.CpuTime() << " s";
+  }
+
+  std::vector<Trigger> triggersD;
+  std::vector<Digit> digitsD;
+
+  sw.Start();
+  const auto ctfImage = o2::hmpid::CTF::getImage(vec.data());
+  {
+    CTFCoder coder;
+    coder.decode(ctfImage, triggersD, digitsD); // decompress
+  }
+  sw.Stop();
+  LOG(INFO) << "Decompressed in " << sw.CpuTime() << " s";
+
+  BOOST_CHECK(triggersD.size() == triggers.size());
+  BOOST_CHECK(digitsD.size() == digits.size());
+
+  BOOST_TEST(triggersD == triggers, boost::test_tools::per_element());
+  BOOST_TEST(digitsD == digits, boost::test_tools::per_element());
+}

Detectors/CTF/workflow/CMakeLists.txt

@@ -23,7 +23,8 @@ o2_add_library(CTFWorkflow
                                      O2::DataFormatsMID
                                      O2::DataFormatsPHOS
                                      O2::DataFormatsCPV
-                                     O2::DataFormatsZDC             
+                                     O2::DataFormatsZDC
+                                     O2::DataFormatsHMP				     
                                      O2::DataFormatsParameters
                                      O2::ITSMFTWorkflow
                                      O2::TPCWorkflow
@@ -37,6 +38,7 @@ o2_add_library(CTFWorkflow
                                      O2::PHOSWorkflow
                                      O2::CPVWorkflow
                                      O2::ZDCWorkflow
+				     O2::HMPIDWorkflow
                                      O2::Algorithm
                                      O2::CommonUtils)
 

Detectors/CTF/workflow/src/CTFReaderSpec.cxx

@@ -35,6 +35,7 @@
 #include "DataFormatsPHOS/CTF.h"
 #include "DataFormatsCPV/CTF.h"
 #include "DataFormatsZDC/CTF.h"
+#include "DataFormatsHMP/CTF.h"
 #include "Algorithm/RangeTokenizer.h"
 #include <TStopwatch.h>
 
@@ -224,6 +225,13 @@ void CTFReaderSpec::run(ProcessingContext& pc)
     setFirstTFOrbit(det.getName());
   }
 
+  det = DetID::HMP;
+  if (detsTF[det]) {
+    auto& bufVec = pc.outputs().make<std::vector<o2::ctf::BufferType>>({det.getName()}, sizeof(o2::hmpid::CTF));
+    o2::hmpid::CTF::readFromTree(bufVec, *(tree.get()), det.getName());
+    setFirstTFOrbit(det.getName());
+  }
+
   mTimer.Stop();
   LOG(INFO) << "Read CTF " << inputFile << " in " << mTimer.CpuTime() - cput << " s";
 

Detectors/CTF/workflow/src/CTFWriterSpec.cxx

@@ -24,6 +24,7 @@
 #include "DataFormatsITSMFT/CTF.h"
 #include "DataFormatsTPC/CTF.h"
 #include "DataFormatsTRD/CTF.h"
+#include "DataFormatsHMP/CTF.h"
 #include "DataFormatsFT0/CTF.h"
 #include "DataFormatsFV0/CTF.h"
 #include "DataFormatsFDD/CTF.h"
@@ -225,6 +226,7 @@ void CTFWriterSpec::run(ProcessingContext& pc)
   processDet<o2::phos::CTF>(pc, DetID::PHS, header, treeOut.get());
   processDet<o2::cpv::CTF>(pc, DetID::CPV, header, treeOut.get());
   processDet<o2::zdc::CTF>(pc, DetID::ZDC, header, treeOut.get());
+  processDet<o2::hmpid::CTF>(pc, DetID::HMP, header, treeOut.get());
 
   mTimer.Stop();
 
@@ -299,6 +301,8 @@ void CTFWriterSpec::storeDictionaries()
   storeDictionary<o2::phos::CTF>(DetID::PHS, header);
   storeDictionary<o2::cpv::CTF>(DetID::CPV, header);
   storeDictionary<o2::zdc::CTF>(DetID::ZDC, header);
+  storeDictionary<o2::hmpid::CTF>(DetID::HMP, header);
+
   // close remnants
   if (mDictTreeOut) {
     closeDictionaryTreeAndFile(header);

Detectors/CTF/workflow/src/ctf-reader-workflow.cxx

@@ -23,6 +23,7 @@
 #include "ITSMFTWorkflow/EntropyDecoderSpec.h"
 #include "TPCWorkflow/EntropyDecoderSpec.h"
 #include "TRDWorkflow/EntropyDecoderSpec.h"
+#include "HMPIDWorkflow/EntropyDecoderSpec.h"
 #include "FT0Workflow/EntropyDecoderSpec.h"
 #include "FV0Workflow/EntropyDecoderSpec.h"
 #include "FDDWorkflow/EntropyDecoderSpec.h"
@@ -112,6 +113,9 @@ WorkflowSpec defineDataProcessing(ConfigContext const& configcontext)
   if (dets[DetID::ZDC]) {
     specs.push_back(o2::zdc::getEntropyDecoderSpec());
   }
+  if (dets[DetID::HMP]) {
+    specs.push_back(o2::hmpid::getEntropyDecoderSpec());
+  }
 
   return std::move(specs);
 }