Adding configurable keys

Author: nicolovalle

Detectors/ITSMFT/ITS/postprocessing/studies/include/ITSStudies/ITSStudiesConfigParam.h

@@ -94,6 +94,14 @@ struct AnomalyStudyParamConfig : public o2::conf::ConfigurableParamHelper<Anomal
   O2ParamDef(AnomalyStudyParamConfig, "AnomalyStudyParam");
 };
 
+struct ITSBeamBackgroundStudyParamConfig : public o2::conf::ConfigurableParamHelper<ITSBeamBackgroundStudyParamConfig> {
+  int dumpEveryTF = 5;               // <= 0: write only at end of stream
+  int skimmedOnlyAfterTF = 150;      // TF threshold above which only the skimmed output file is written
+  bool saveClusterParameters = true; // Write per-cluster coordinates, size and row/column spans
+
+  O2ParamDef(ITSBeamBackgroundStudyParamConfig, "ITSBeamBackgroundStudyParam");
+};
+
 struct ITSEfficiencyParamConfig : public o2::conf::ConfigurableParamHelper<ITSEfficiencyParamConfig> {
   std::string outFileName = "ITS_efficiencyStudy.root";
   double b = 0; // Solenoid field in kG (+/-)
@@ -115,4 +123,4 @@ struct ITSImpactParameterParamConfig : public o2::conf::ConfigurableParamHelper<
 } // namespace its
 } // namespace o2
 
-#endif
+#endif

Detectors/ITSMFT/ITS/postprocessing/studies/src/ITSBeamBackgroundStudy.cxx

@@ -10,6 +10,7 @@
 // or submit itself to any jurisdiction.
 
 #include "ITSStudies/ITSBeamBackgroundStudy.h"
+#include "ITSStudies/ITSStudiesConfigParam.h"
 #include "DataFormatsGlobalTracking/RecoContainer.h"
 #include "DetectorsBase/GRPGeomHelper.h"
 #include "DataFormatsParameters/GRPObject.h"
@@ -26,6 +27,7 @@
 #include <algorithm>
 #include <limits>
 #include <cmath>
+#include <cstdint>
 
 #include <TTree.h>
 #include <TH2.h>
@@ -95,8 +97,9 @@ class ITSBeamBackgroundStudy : public Task
   int targetClusterMinCol = 128; // definition of anomalous cluster
   int targetClusterMaxRow = 29;  // definition of anomalous cluster
 
-  int mDumpEveryTF = 5; // use -1 to save only at the end
-  int mSkimmedOnlyAfterTF = 150;
+  int mDumpEveryTF = ITSBeamBackgroundStudyParamConfig::Instance().dumpEveryTF;
+  int mSkimmedOnlyAfterTF = ITSBeamBackgroundStudyParamConfig::Instance().skimmedOnlyAfterTF;
+  bool mSaveClusterParameters = ITSBeamBackgroundStudyParamConfig::Instance().saveClusterParameters;
   std::string mOutputChip = "chipevents";
   std::string mOutoutChipSkim = "chipeventstarget";
 
@@ -131,8 +134,10 @@ class ITSBeamBackgroundStudy : public Task
 void ITSBeamBackgroundStudy::updateTimeDependentParams(ProcessingContext& pc)
 {
   o2::base::GRPGeomHelper::instance().checkUpdates(pc);
-  mGeom = o2::its::GeometryTGeo::Instance();
-  mGeom->fillMatrixCache(o2::math_utils::bit2Mask(o2::math_utils::TransformType::L2G));
+  if (mSaveClusterParameters) {
+    mGeom = o2::its::GeometryTGeo::Instance();
+    mGeom->fillMatrixCache(o2::math_utils::bit2Mask(o2::math_utils::TransformType::L2G));
+  }
 }
 
 void ITSBeamBackgroundStudy::init(InitContext& ic)
@@ -151,6 +156,7 @@ void ITSBeamBackgroundStudy::init(InitContext& ic)
 void ITSBeamBackgroundStudy::prepareOutput()
 {
   LOGP(info, "Setting up trees and histograms. They will be dumped on file every {} TFs", mDumpEveryTF);
+  LOGP(info, "Skimmed-only output after TF {}; saving cluster parameters: {}", mSkimmedOnlyAfterTF, mSaveClusterParameters);
 
   TimeWindowCut = new TH1F("ZDC bkg region", "ZNAr, ZNCr, -ZNAl, -ZNCl", 8, 0, 8);
   TimeWindowCut->SetBinContent(1, TimeWindowZNAr.first);
@@ -186,12 +192,14 @@ void ITSBeamBackgroundStudy::prepareOutput()
   ITSChipEvtTree->Branch("bc", &Tbc, "bc/I");
   ITSChipEvtTree->Branch("chip", &Tchip, "chip/I");
   ITSChipEvtTree->Branch("phi", &Tphi, "phi/D");
-  ITSChipEvtTree->Branch("cluster_phi", &TclusterPhi);
-  ITSChipEvtTree->Branch("cluster_r", &TclusterR);
-  ITSChipEvtTree->Branch("cluster_z", &TclusterZ);
-  ITSChipEvtTree->Branch("cluster_size", &TclusterSize);
-  ITSChipEvtTree->Branch("cluster_colspan", &TclusterColSpan);
-  ITSChipEvtTree->Branch("cluster_rowspan", &TclusterRowSpan);
+  if (mSaveClusterParameters) {
+    ITSChipEvtTree->Branch("cluster_phi", &TclusterPhi);
+    ITSChipEvtTree->Branch("cluster_r", &TclusterR);
+    ITSChipEvtTree->Branch("cluster_z", &TclusterZ);
+    ITSChipEvtTree->Branch("cluster_size", &TclusterSize);
+    ITSChipEvtTree->Branch("cluster_colspan", &TclusterColSpan);
+    ITSChipEvtTree->Branch("cluster_rowspan", &TclusterRowSpan);
+  }
   ITSChipEvtTree->Branch("zdctag", &TZDCtag, "zdctag/I");
   ITSChipEvtTree->Branch("nhit", &Tnhit, "nhit/I");
   ITSChipEvtTree->Branch("nhit_no1pix", &Tnhit_no1pix, "nhit_no1pix/I");
@@ -560,23 +568,24 @@ void ITSBeamBackgroundStudy::process(o2::globaltracking::RecoContainer& recoData
       if (newchip) {
         MAPsize[chipid] = std::vector<int>{};
         MAPcols[chipid] = std::vector<int>{};
-        MAProws[chipid] = std::vector<int>{};
         MAPntarget[chipid] = 0;
         MAPcoo_mincol[chipid] = coo_col;
         MAPcoo_maxcol[chipid] = coo_col + colspan;
       }
 
       MAPsize[chipid].push_back(npix);
       MAPcols[chipid].push_back(colspan);
-      MAProws[chipid].push_back(rowspan);
-      // Grouped topologies store a rounded COG in the compact cluster; invalid
-      // pattern IDs store the bounding-box corner instead.
-      const auto pattID = compClus.getPatternID();
-      auto local = pattID == o2::itsmft::CompCluster::InvalidPatternID
-                     ? mDict->getClusterCoordinates<float>(compClus, patti, false)
-                     : (mDict->isGroup(pattID) ? mDict->getClusterCoordinates<float>(compClus, patti)
-                                               : mDict->getClusterCoordinates<float>(compClus));
-      MAPcoordinates[chipid].push_back(mGeom->getMatrixL2G(chipid)(local));
+      if (mSaveClusterParameters) {
+        MAProws[chipid].push_back(rowspan);
+        // Grouped topologies store a rounded COG in the compact cluster; invalid
+        // pattern IDs store the bounding-box corner instead.
+        const auto pattID = compClus.getPatternID();
+        auto local = pattID == o2::itsmft::CompCluster::InvalidPatternID
+                       ? mDict->getClusterCoordinates<float>(compClus, patti, false)
+                       : (mDict->isGroup(pattID) ? mDict->getClusterCoordinates<float>(compClus, patti)
+                                                 : mDict->getClusterCoordinates<float>(compClus));
+        MAPcoordinates[chipid].push_back(mGeom->getMatrixL2G(chipid)(local));
+      }
       if (colspan >= targetClusterMinCol && rowspan <= targetClusterMaxRow) {
         // Anomalous cluster found
         MAPntarget[chipid] += 1;
@@ -587,7 +596,7 @@ void ITSBeamBackgroundStudy::process(o2::globaltracking::RecoContainer& recoData
 
     } // end of loop over clusters in rof
 
-    if (ntarget_in_rof == 0 && mTFn > mSkimmedOnlyAfterTF + 2) { // extra 2 to avoid edge effects?
+    if (ntarget_in_rof == 0 && static_cast<int64_t>(mTFn) > static_cast<int64_t>(mSkimmedOnlyAfterTF) + 2) { // extra 2 to avoid edge effects?
       // do not need extra computations for this rof since it will not be saved in any case
       continue;
     }
@@ -615,16 +624,18 @@ void ITSBeamBackgroundStudy::process(o2::globaltracking::RecoContainer& recoData
       Tphi = ChipToPhi(ic);
 
       Tnclus = MAPsize[ic].size();
-      TclusterSize = MAPsize[ic]; // Save before sorting the sizes for the summaries.
-      TclusterColSpan = MAPcols[ic];
-      TclusterRowSpan = MAProws[ic];
-      TclusterPhi.clear();
-      TclusterR.clear();
-      TclusterZ.clear();
-      for (const auto& global : MAPcoordinates[ic]) {
-        TclusterPhi.push_back(std::atan2(global.Y(), global.X()));
-        TclusterR.push_back(std::hypot(global.X(), global.Y()));
-        TclusterZ.push_back(global.Z());
+      if (mSaveClusterParameters) {
+        TclusterSize = MAPsize[ic]; // Save before sorting the sizes for the summaries.
+        TclusterColSpan = MAPcols[ic];
+        TclusterRowSpan = MAProws[ic];
+        TclusterPhi.clear();
+        TclusterR.clear();
+        TclusterZ.clear();
+        for (const auto& global : MAPcoordinates[ic]) {
+          TclusterPhi.push_back(std::atan2(global.Y(), global.X()));
+          TclusterR.push_back(std::hypot(global.X(), global.Y()));
+          TclusterZ.push_back(global.Z());
+        }
       }
       Tmincol = MAPcoo_mincol[ic];
       Tmaxcol = MAPcoo_maxcol[ic];
@@ -741,12 +752,15 @@ DataProcessorSpec getITSBeamBackgroundStudy(mask_t srcTracksMask, mask_t srcClus
 
   dataRequest->requestTracks(srcTracksMask, useMC);
 
-  auto ggRequest = std::make_shared<o2::base::GRPGeomRequest>(false,                             // orbitResetTime
-                                                              true,                              // GRPECS=true
-                                                              false,                             // GRPLHCIF
-                                                              false,                             // GRPMagField
-                                                              false,                             // askMatLUT
-                                                              o2::base::GRPGeomRequest::Aligned, // geometry
+  const auto geometry = ITSBeamBackgroundStudyParamConfig::Instance().saveClusterParameters
+                          ? o2::base::GRPGeomRequest::Aligned
+                          : o2::base::GRPGeomRequest::None;
+  auto ggRequest = std::make_shared<o2::base::GRPGeomRequest>(false, // orbitResetTime
+                                                              true,  // GRPECS=true
+                                                              false, // GRPLHCIF
+                                                              false, // GRPMagField
+                                                              false, // askMatLUT
+                                                              geometry,
                                                               dataRequest->inputs,
                                                               true);
   return DataProcessorSpec{

Detectors/ITSMFT/ITS/postprocessing/studies/src/ITSStudiesConfigParam.cxx

@@ -22,13 +22,15 @@ static auto& sPIDStudyParamITS = o2::its::study::PIDStudyParamConfig::Instance()
 static auto& sCheckTracksParamsITS = o2::its::study::ITSCheckTracksParamConfig::Instance();
 static auto& sImpactParameterParamsITS = o2::its::study::ITSImpactParameterParamConfig::Instance();
 static auto& sAnomalyStudy = o2::its::study::AnomalyStudyParamConfig::Instance();
+static auto& sBeamBackgroundStudy = o2::its::study::ITSBeamBackgroundStudyParamConfig::Instance();
 static auto& sEfficiencyParamsITS = o2::its::study::ITSEfficiencyParamConfig::Instance();
 
 O2ParamImpl(o2::its::study::ITSAvgClusSizeParamConfig);
 O2ParamImpl(o2::its::study::PIDStudyParamConfig);
 O2ParamImpl(o2::its::study::ITSCheckTracksParamConfig);
 O2ParamImpl(o2::its::study::ITSImpactParameterParamConfig);
 O2ParamImpl(o2::its::study::AnomalyStudyParamConfig);
+O2ParamImpl(o2::its::study::ITSBeamBackgroundStudyParamConfig);
 O2ParamImpl(o2::its::study::ITSEfficiencyParamConfig);
 
 } // namespace study

Detectors/ITSMFT/ITS/postprocessing/studies/src/ITSStudiesLinkDef.h

@@ -19,13 +19,15 @@
 #pragma link C++ class o2::its::study::PIDStudyParamConfig + ;
 #pragma link C++ class o2::its::study::ITSImpactParameterParamConfig + ;
 #pragma link C++ class o2::its::study::AnomalyStudyParamConfig + ;
+#pragma link C++ class o2::its::study::ITSBeamBackgroundStudyParamConfig + ;
 #pragma link C++ class o2::its::study::ITSEfficiencyParamConfig + ;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::its::study::ITSAvgClusSizeParamConfig> + ;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::its::study::PIDStudyParamConfig> + ;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::its::study::ITSCheckTracksParamConfig> + ;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::its::study::ITSImpactParameterParamConfig> + ;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::its::study::AnomalyStudyParamConfig> + ;
+#pragma link C++ class o2::conf::ConfigurableParamHelper < o2::its::study::ITSBeamBackgroundStudyParamConfig> + ;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::its::study::ITSEfficiencyParamConfig> + ;
 #pragma link C++ function o2::its::studies::makeLogBinning + ;
 
-#endif
+#endif

Detectors/ITSMFT/ITS/postprocessing/workflow/standalone-postprocessing-workflow.cxx

@@ -24,6 +24,7 @@
 #include "ITSStudies/PIDStudy.h"
 #include "ITSStudies/AnomalyStudy.h"
 #include "ITSStudies/ITSBeamBackgroundStudy.h"
+#include "ITSStudies/ITSStudiesConfigParam.h"
 #include "ITSStudies/Efficiency.h"
 #include "ITSStudies/TrackCheck.h"
 #include "ITSStudies/TrackExtension.h"
@@ -41,6 +42,19 @@ void customize(std::vector<o2::framework::CallbacksPolicy>& policies)
 // we need to add workflow options before including Framework/runDataProcessing
 void customize(std::vector<ConfigParamSpec>& workflowOptions)
 {
+  const auto& beamParams = o2::its::study::ITSBeamBackgroundStudyParamConfig::Instance();
+  const std::string configHelp =
+    "Semicolon-separated key=value strings. ITS beam-background study parameters:\n"
+    "Key prefix: ITSBeamBackgroundStudyParam.\n"
+    "dumpEveryTF=<int> (default: " +
+    std::to_string(beamParams.dumpEveryTF) +
+    "): dump ROOT files every N TFs; <= 0 writes only at end of stream.\n"
+    "skimmedOnlyAfterTF=<int> (default: " +
+    std::to_string(beamParams.skimmedOnlyAfterTF) +
+    "): TF threshold above which only the skimmed output file is written.\n"
+    "saveClusterParameters=<true|false> (default: " +
+    (beamParams.saveClusterParameters ? "true" : "false") +
+    "): save cluster phi, r, z, size, colspan and rowspan vectors in output trees.";
   // option allowing to set parameters
   std::vector<o2::framework::ConfigParamSpec> options{
     {"input-from-upstream", VariantType::Bool, false, {"read clusters from the clusterer"}},
@@ -56,7 +70,7 @@ void customize(std::vector<ConfigParamSpec>& workflowOptions)
     {"its-beambkg-study", VariantType::Bool, false, {"Perform the ITS beam background study"}},
     {"track-extension-study", VariantType::Bool, false, {"Perform the track extension study"}},
     {"efficiency-study", VariantType::Bool, false, {"Perform the efficiency study"}},
-    {"configKeyValues", VariantType::String, "", {"Semicolon separated key=value strings ..."}}};
+    {"configKeyValues", VariantType::String, "", {configHelp}}};
   o2::itsmft::DPLAlpideParamInitializer::addITSConfigOption(options);
   // o2::raw::HBFUtilsInitializer::addConfigOption(options, "o2_tfidinfo.root");
   std::swap(workflowOptions, options);