[Common] Unified, simple, fully self-configuring mult/cent provider

Common/DataModel/Centrality.h

@@ -1,4 +1,4 @@
 // Copyright 2019-2020 CERN and copyright holders of ALICE O2.
 // See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
 // All rights not expressly granted are reserved.
 //
@@ -8,7 +8,7 @@
 // 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.
 #ifndef COMMON_DATAMODEL_CENTRALITY_H_
 #define COMMON_DATAMODEL_CENTRALITY_H_
 
 #include "Framework/AnalysisDataModel.h"
@@ -60,6 +60,11 @@
 // Run 3 variant tables
 DECLARE_SOA_TABLE(CentFT0CVariant1s, "AOD", "CENTFT0Cvar1", cent::CentFT0CVariant1); //! Run 3 FT0C variant 1
 
+// Run 3 centrality per BC (joinable with BC)
+DECLARE_SOA_TABLE(BCCentFT0Ms, "AOD", "BCCENTFT0M", cent::CentFT0M, o2::soa::Marker<1>); //! Run 3 FT0M BC centrality table
+DECLARE_SOA_TABLE(BCCentFT0As, "AOD", "BCCENTFT0A", cent::CentFT0A, o2::soa::Marker<1>); //! Run 3 FT0A BC centrality table
+DECLARE_SOA_TABLE(BCCentFT0Cs, "AOD", "BCCENTFT0C", cent::CentFT0C, o2::soa::Marker<1>); //! Run 3 FT0C BC centrality table
+
 using CentRun2V0M = CentRun2V0Ms::iterator;
 using CentRun2V0A = CentRun2V0As::iterator;
 using CentRun2SPDTrk = CentRun2SPDTrks::iterator;
@@ -77,6 +82,10 @@
 using CentNGlobal = CentNGlobals::iterator;
 using CentMFT = CentMFTs::iterator;
 
+using BCCentFT0M = BCCentFT0Ms::iterator;
+using BCCentFT0A = BCCentFT0As::iterator;
+using BCCentFT0C = BCCentFT0Cs::iterator;
+
 template <typename T>
 concept HasRun2Centrality = requires(T&& t) {
   { t.centRun2V0M() };

Common/TableProducer/CMakeLists.txt

@@ -32,6 +32,11 @@
                     PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore
                     COMPONENT_NAME Analysis)
 
+o2physics_add_dpl_workflow(multcenttable
+                    SOURCES multCentTable.cxx
+                    PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore
+                    COMPONENT_NAME Analysis)
+
 o2physics_add_dpl_workflow(multiplicity-extra-table
                     SOURCES multiplicityExtraTable.cxx
                     PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore
@@ -72,7 +77,7 @@
                     PUBLIC_LINK_LIBRARIES O2::DataFormatsPHOS O2::PHOSBase O2::PHOSReconstruction O2Physics::DataModel
                     COMPONENT_NAME Analysis)
 
 o2physics_add_dpl_workflow(fwdtrackextension
                     SOURCES fwdtrackextension.cxx
                     PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore
                                           O2::ReconstructionDataFormats
@@ -95,12 +100,12 @@
                     PUBLIC_LINK_LIBRARIES O2Physics::AnalysisCore
                     COMPONENT_NAME Analysis)
 
 o2physics_add_dpl_workflow(qvector-table
                     SOURCES qVectorsTable.cxx
                     PUBLIC_LINK_LIBRARIES O2::Framework
                                           O2Physics::AnalysisCore
                                           O2::DetectorsCommonDataFormats
                                           O2Physics::DataModel
                                           O2::CCDB
                     COMPONENT_NAME Analysis)
 
@@ -109,7 +114,7 @@
                     PUBLIC_LINK_LIBRARIES O2::Framework
                                           O2Physics::AnalysisCore
                                           ONNXRuntime::ONNXRuntime
                                           O2::CCDB O2Physics::MLCore
                                           O2::ReconstructionDataFormats
                     COMPONENT_NAME Analysis)
 
@@ -118,7 +123,7 @@
                     PUBLIC_LINK_LIBRARIES O2::Framework O2Physics::AnalysisCore
                                           O2::ReconstructionDataFormats
                                           O2::DetectorsBase O2::DetectorsCommonDataFormats
                     COMPONENT_NAME Analysis)
 
 o2physics_add_dpl_workflow(zdc-task-intercalib
                     SOURCES zdc-task-intercalib.cxx

Common/TableProducer/multCentTable.cxx

@@ -0,0 +1,204 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// 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.
+
+/// \file multCentTable.cxx
+/// \brief unified, self-configuring mult/cent provider
+/// \author ALICE
+
+//===============================================================
+//
+// Unified, self-configuring multiplicity+centrality task
+// still work in progress: use at your own discretion
+//
+//===============================================================
+
+#include "Framework/AnalysisDataModel.h"
+#include "Framework/AnalysisTask.h"
+#include "Framework/runDataProcessing.h"
+#include "Framework/RunningWorkflowInfo.h"
+#include "Common/DataModel/TrackSelectionTables.h"
+#include "Common/Core/trackUtilities.h"
+#include "ReconstructionDataFormats/DCA.h"
+#include "DetectorsBase/Propagator.h"
+#include "DetectorsBase/GeometryManager.h"
+#include "CommonUtils/NameConf.h"
+#include "CCDB/CcdbApi.h"
+#include "DataFormatsParameters/GRPMagField.h"
+#include "CCDB/BasicCCDBManager.h"
+#include "Framework/HistogramRegistry.h"
+#include "DataFormatsCalibration/MeanVertexObject.h"
+#include "CommonConstants/GeomConstants.h"
+#include "Common/Tools/TrackPropagationModule.h"
+#include "Common/Tools/StandardCCDBLoader.h"
+#include "Framework/O2DatabasePDGPlugin.h"
+#include "MetadataHelper.h"
+#include "Common/Tools/MultModule.h"
+
+using namespace o2;
+using namespace o2::framework;
+// using namespace o2::framework::expressions;
+
+MetadataHelper metadataInfo; // Metadata helper
+
+struct MultCentTable {
+  o2::common::multiplicity::standardConfigurables opts;
+  o2::common::multiplicity::products products;
+  o2::common::multiplicity::MultModule module;
+
+  // CCDB boilerplate declarations
+  o2::framework::Configurable<std::string> ccdburl{"ccdburl", "http://alice-ccdb.cern.ch", "url of the ccdb repository"};
+  Service<o2::ccdb::BasicCCDBManager> ccdb;
+  Service<o2::framework::O2DatabasePDG> pdg;
+
+  // hold multiplicity values for layover to centrality calculation
+  std::vector<o2::common::multiplicity::multEntry> mults;
+
+  // slicers
+  Preslice<soa::Join<aod::TracksIU, aod::TracksExtra>> slicerTracksIU = o2::aod::track::collisionId;
+  Preslice<soa::Join<aod::TracksIU, aod::TracksExtra, aod::TrackSelection, aod::TrackSelectionExtension>> slicerTracksIUwithSelections = o2::aod::track::collisionId;
+  Preslice<soa::Join<aod::Tracks, aod::TracksExtra>> slicerTrackRun2 = o2::aod::track::collisionId;
+
+  void init(o2::framework::InitContext& initContext)
+  {
+    // CCDB boilerplate init
+    ccdb->setCaching(true);
+    ccdb->setLocalObjectValidityChecking();
+    ccdb->setURL(ccdburl.value);
+
+    // task-specific
+    module.init(opts, initContext);
+  }
+
+  void processRun2(soa::Join<aod::Collisions, aod::Run2MatchedSparse> const& collisions,
+                   soa::Join<aod::Tracks, aod::TracksExtra> const& tracks,
+                   soa::Join<aod::BCs, aod::Run2BCInfos, aod::Timestamps> const& bcs,
+                   aod::Zdcs const&,
+                   aod::FV0As const&,
+                   aod::FV0Cs const&,
+                   aod::FT0s const&)
+  {
+    mults.clear();
+    for (auto const& collision : collisions) {
+      o2::common::multiplicity::multEntry mult;
+      const auto& bc = bcs.rawIteratorAt(collision.getId<aod::indices::BCId>());
+      const uint64_t collIdx = collision.globalIndex();
+      auto tracksThisCollision = tracks.sliceBy(slicerTrackRun2, collIdx);
+      mult = module.collisionProcessRun2(collision, tracksThisCollision, bc, products);
+      mults.push_back(mult);
+    }
+  }
+
+  void processRun3(soa::Join<aod::Collisions, aod::EvSels> const& collisions,
+                   soa::Join<aod::TracksIU, aod::TracksExtra> const& tracks,
+                   soa::Join<aod::BCs, aod::Timestamps, aod::Run3MatchedToBCSparse> const&,
+                   aod::Zdcs const&,
+                   aod::FV0As const&,
+                   aod::FT0s const&,
+                   aod::FDDs const&)
+  {
+    mults.clear();
+    for (auto const& collision : collisions) {
+      o2::common::multiplicity::multEntry mult;
+      const auto& bc = collision.bc_as<soa::Join<aod::BCs, aod::Timestamps, aod::Run3MatchedToBCSparse>>();
+      const uint64_t collIdx = collision.globalIndex();
+      auto tracksThisCollision = tracks.sliceBy(slicerTracksIU, collIdx);
+      mult = module.collisionProcessRun3(ccdb, metadataInfo, collision, tracksThisCollision, bc, products);
+      mults.push_back(mult);
+    }
+  }
+
+  void processRun3WithGlobalCounters(soa::Join<aod::Collisions, aod::EvSels> const& collisions,
+                                     soa::Join<aod::TracksIU, aod::TracksExtra, aod::TrackSelection, aod::TrackSelectionExtension> const& tracks,
+                                     soa::Join<aod::BCs, aod::Timestamps, aod::Run3MatchedToBCSparse> const&,
+                                     aod::Zdcs const&,
+                                     aod::FV0As const&,
+                                     aod::FT0s const&,
+                                     aod::FDDs const&)
+  {
+    mults.clear();
+    for (auto const& collision : collisions) {
+      o2::common::multiplicity::multEntry mult;
+      const auto& bc = collision.bc_as<soa::Join<aod::BCs, aod::Timestamps, aod::Run3MatchedToBCSparse>>();
+      const uint64_t collIdx = collision.globalIndex();
+      auto tracksThisCollision = tracks.sliceBy(slicerTracksIUwithSelections, collIdx);
+      mult = module.collisionProcessRun3(ccdb, metadataInfo, collision, tracksThisCollision, bc, products);
+      mults.push_back(mult);
+    }
+  }
+  void processMFT(soa::Join<aod::Collisions, aod::EvSels>::iterator const& collision,
+                  o2::aod::MFTTracks const& mfttracks,
+                  soa::SmallGroups<aod::BestCollisionsFwd> const& retracks)
+  {
+    if (opts.mEnabledTables[o2::common::multiplicity::kMFTMults]) {
+      // populates MFT information in the mults buffer (in addition to filling table)
+      module.collisionProcessMFT(collision, mfttracks, retracks, mults, products);
+    }
+  }
+  void processMonteCarlo(aod::McCollision const& mcCollision, aod::McParticles const& mcParticles)
+  {
+    if (opts.mEnabledTables[o2::common::multiplicity::kMultMCExtras]) {
+      module.collisionProcessMonteCarlo(mcCollision, mcParticles, pdg, products);
+    }
+  }
+  void processMonteCarlo2Mults(soa::Join<aod::McCollisionLabels, aod::Collisions>::iterator const& collision)
+  {
+    if (opts.mEnabledTables[o2::common::multiplicity::kMult2MCExtras]) {
+      // establish simple interlink for posterior analysis (derived data)
+      products.tableExtraMult2MCExtras(collision.mcCollisionId());
+    }
+  }
+  void processCentralityRun2(aod::Collisions const& collisions, soa::Join<aod::BCs, aod::Run2BCInfos, aod::Timestamps> const& bcs)
+  {
+    // it is important that this function is at the end of the other process functions.
+    // it requires `mults` to be properly set, which will only happen after the other process
+    // functions have been called.
+
+    // internally, the function below will do nothing if no centrality is requested.
+    // it is thus safer to always keep the actual process function for centrality
+    // generation to true, since the requisites for being in this context are
+    // always fulfilled
+    if (collisions.size() != static_cast<int64_t>(mults.size())) {
+      LOGF(fatal, "Size of collisions doesn't match size of multiplicity buffer!");
+    }
+    module.generateCentralitiesRun2(ccdb, metadataInfo, bcs, mults, products);
+  }
+  void processCentralityRun3(aod::Collisions const& collisions, soa::Join<aod::BCs, aod::BcSels, aod::Timestamps> const& bcs, aod::FT0s const&)
+  {
+    // it is important that this function is at the end of the other process functions.
+    // it requires `mults` to be properly set, which will only happen after the other process
+    // functions have been called.
+
+    // internally, the function below will do nothing if no centrality is requested.
+    // it is thus safer to always keep the actual process function for centrality
+    // generation to true, since the requisites for being in this context are
+    // always fulfilled
+    if (collisions.size() != static_cast<int64_t>(mults.size())) {
+      LOGF(fatal, "Size of collisions doesn't match size of multiplicity buffer!");
+    }
+    module.generateCentralitiesRun3(ccdb, metadataInfo, bcs, mults, products);
+  }
+
+  PROCESS_SWITCH(MultCentTable, processRun2, "Process Run 2", false);
+  PROCESS_SWITCH(MultCentTable, processRun3, "Process Run 3", true);
+  PROCESS_SWITCH(MultCentTable, processRun3WithGlobalCounters, "Process Run 3 + global tracking counters", false);
+  PROCESS_SWITCH(MultCentTable, processMFT, "Process MFT info", false);
+  PROCESS_SWITCH(MultCentTable, processMonteCarlo, "Process Monte Carlo information", false);
+  PROCESS_SWITCH(MultCentTable, processMonteCarlo2Mults, "Process Monte Carlo information", false);
+  PROCESS_SWITCH(MultCentTable, processCentralityRun2, "Generate Run 2 centralities", false);
+  PROCESS_SWITCH(MultCentTable, processCentralityRun3, "Generate Run 3 centralities", true);
+};
+
+WorkflowSpec defineDataProcessing(ConfigContext const& cfgc)
+{
+  metadataInfo.initMetadata(cfgc);
+  WorkflowSpec workflow{adaptAnalysisTask<MultCentTable>(cfgc)};
+  return workflow;
+}