[PWGEM,Photon] Adding EMCal ML response plus initCCDB bugfix (#17637)

Author: mhemmer-cern

PWGEM/PhotonMeson/Core/EMCConversionCandidate.h

@@ -0,0 +1,63 @@
+// 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 EMCConversionCandidate.h
+/// \brief Header file that defines EMCConversionCandidate, a struct to be used with the EMCConversion ML model
+/// \author Marvin Hemmer <marvin.hemmer@cern.ch>
+
+#ifndef PWGEM_PHOTONMESON_CORE_EMCCONVERSIONCANDIDATE_H_
+#define PWGEM_PHOTONMESON_CORE_EMCCONVERSIONCANDIDATE_H_
+
+#include <concepts>
+
+namespace o2::analysis::em
+{
+
+// Requires T to expose the specific named getters getInputFeatures() needs,
+// each returning something convertible to float.
+template <typename T>
+concept IsEmcConversionCandidate = requires(T const& c) {
+  { c.minv() } -> std::convertible_to<float>;
+  { c.deltaEta() } -> std::convertible_to<float>;
+  { c.deltaR() } -> std::convertible_to<float>;
+  { c.phiv() } -> std::convertible_to<float>;
+  { c.rConv() } -> std::convertible_to<float>;
+  { c.totE() } -> std::convertible_to<float>;
+  { c.e2() } -> std::convertible_to<float>;
+  { c.e1() } -> std::convertible_to<float>;
+  { c.deltaPhi() } -> std::convertible_to<float>;
+};
+
+struct EMCConversionCandidate {
+  float mMinv;
+  float mDeltaEta;
+  float mDeltaR;
+  float mPhiv;
+  float mRConv;
+  float mTotE;
+  float mE2;
+  float mE1;
+  float mDeltaPhi;
+
+  [[nodiscard]] float minv() const { return mMinv; }
+  [[nodiscard]] float deltaEta() const { return mDeltaEta; }
+  [[nodiscard]] float deltaR() const { return mDeltaR; }
+  [[nodiscard]] float phiv() const { return mPhiv; }
+  [[nodiscard]] float rConv() const { return mRConv; }
+  [[nodiscard]] float totE() const { return mTotE; }
+  [[nodiscard]] float e2() const { return mE2; }
+  [[nodiscard]] float e1() const { return mE1; }
+  [[nodiscard]] float deltaPhi() const { return mDeltaPhi; }
+};
+
+} // namespace o2::analysis::em
+
+#endif // PWGEM_PHOTONMESON_CORE_EMCCONVERSIONCANDIDATE_H_

PWGEM/PhotonMeson/Core/EMCPhotonCut.h

@@ -443,6 +443,10 @@ class EMCPhotonCut
   /// \return true if cluster survives cut else false
   bool IsSelectedEMCalRunning(const EMCPhotonCuts& cut, o2::soa::is_iterator auto const& cluster, IsFullTrackIterator auto& matchedTrackIter, int64_t const nMatchedTracks, o2::framework::HistogramRegistry* fRegistry = nullptr) const
   {
+    if (nMatchedTracks == 0) {
+      // there are not tracks to match with, so its true
+      return true;
+    }
     switch (cut) {
       case EMCPhotonCuts::kTM:
         return checkTrackMatching(cluster, matchedTrackIter, nMatchedTracks, true, [this](float pt) { return GetTrackMatchingEta(pt); }, [this](float pt) { return GetTrackMatchingPhi(pt); }, fRegistry, TrackType::kPrimary);

PWGEM/PhotonMeson/Core/EmMlResponseEMCConversion.h

@@ -0,0 +1,102 @@
+// 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 EmMlResponseEMCConversion.h
+/// \brief Class to compute the ML response for EMC conversion selections
+/// \author Marvin Hemmer <marvin.hemmer@cern.ch>
+
+#ifndef PWGEM_PHOTONMESON_CORE_EMMLRESPONSEEMCCONVERSION_H_
+#define PWGEM_PHOTONMESON_CORE_EMMLRESPONSEEMCCONVERSION_H_
+
+#include "PWGEM/PhotonMeson/Core/EMCConversionCandidate.h"
+
+#include "Tools/ML/MlResponse.h"
+
+#include <cstdint>
+#include <vector>
+
+// Fill the map of available input features
+// the key is the feature's name (std::string)
+// the value is the corresponding value in EnumInputFeatures
+#define FILL_MAP_EMC_CONV(FEATURE) \
+  {                                \
+    #FEATURE, static_cast<uint8_t>(InputFeaturesEMCConversion::FEATURE)}
+
+// Check if the index of mCachedIndices (index associated to a FEATURE)
+// matches the entry in EnumInputFeatures associated to this FEATURE
+// if so, the inputFeatures vector is filled with the FEATURE's value
+// by calling the corresponding GETTER from OBJECT
+// NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
+#define CHECK_AND_FILL_VEC_EMC_CONV(GETTER)                        \
+  case static_cast<uint8_t>(InputFeaturesEMCConversion::GETTER): { \
+    inputFeatures.emplace_back(candidate.GETTER());                \
+    break;                                                         \
+  }
+
+namespace o2::analysis::em::emcconv
+{
+
+// input feature used in the ml model
+enum class InputFeaturesEMCConversion : uint8_t {
+  minv,
+  deltaEta,
+  deltaR,
+  phiv,
+  rConv,
+  totE,
+  e2,
+  e1,
+  deltaPhi
+};
+
+template <typename TypeOutputScore = float>
+class EmMlResponseEMCConversion : public MlResponse<TypeOutputScore>
+{
+ public:
+  EmMlResponseEMCConversion() = default;
+  virtual ~EmMlResponseEMCConversion() = default;
+
+  template <o2::analysis::em::IsEmcConversionCandidate TCandidate>
+  std::vector<float> getInputFeatures(TCandidate const& candidate)
+  {
+    std::vector<float> inputFeatures;
+    for (const auto& idx : MlResponse<TypeOutputScore>::mCachedIndices) {
+      switch (idx) {
+        CHECK_AND_FILL_VEC_EMC_CONV(minv)
+        CHECK_AND_FILL_VEC_EMC_CONV(deltaEta)
+        CHECK_AND_FILL_VEC_EMC_CONV(deltaR)
+        CHECK_AND_FILL_VEC_EMC_CONV(phiv)
+        CHECK_AND_FILL_VEC_EMC_CONV(rConv)
+        CHECK_AND_FILL_VEC_EMC_CONV(totE)
+        CHECK_AND_FILL_VEC_EMC_CONV(e2)
+        CHECK_AND_FILL_VEC_EMC_CONV(e1)
+        CHECK_AND_FILL_VEC_EMC_CONV(deltaPhi)
+      }
+    }
+    return inputFeatures;
+  }
+
+ protected:
+  void setAvailableInputFeatures()
+  {
+    MlResponse<TypeOutputScore>::mAvailableInputFeatures = {
+      FILL_MAP_EMC_CONV(minv), FILL_MAP_EMC_CONV(deltaEta), FILL_MAP_EMC_CONV(deltaR),
+      FILL_MAP_EMC_CONV(phiv), FILL_MAP_EMC_CONV(rConv), FILL_MAP_EMC_CONV(totE),
+      FILL_MAP_EMC_CONV(e2), FILL_MAP_EMC_CONV(e1), FILL_MAP_EMC_CONV(deltaPhi)};
+  }
+};
+
+} // namespace o2::analysis::em::emcconv
+
+#undef FILL_MAP_EMC_CONV
+#undef CHECK_AND_FILL_VEC_EMC_CONV
+
+#endif // PWGEM_PHOTONMESON_CORE_EMMLRESPONSEEMCCONVERSION_H_

PWGEM/PhotonMeson/Core/Pi0EtaToGammaGamma.h

@@ -458,10 +458,8 @@ struct Pi0EtaToGammaGamma {
     if (mRunNumber == collision.runNumber()) {
       return;
     }
+    mRunNumber = collision.runNumber();
 
-    if (mRunNumber == collision.runNumber()) {
-      return;
-    }
     // In case override, don't proceed, please - no CCDB access required
     if (d_bz_input > -990) { // o2-linter: disable=magic-number (override value)
       d_bz = d_bz_input;
@@ -470,7 +468,6 @@ struct Pi0EtaToGammaGamma {
         grpmag.setL3Current(30000.f / (d_bz / 5.0f)); // o2-linter: disable=magic-number (override value)
       }
       o2::base::Propagator::initFieldFromGRP(&grpmag);
-      mRunNumber = collision.runNumber();
       return;
     }
 

PWGEM/PhotonMeson/Core/Pi0EtaToGammaGammaMC.h

@@ -313,10 +313,8 @@ struct Pi0EtaToGammaGammaMC {
     if (mRunNumber == collision.runNumber()) {
       return;
     }
+    mRunNumber = collision.runNumber();
 
-    if (mRunNumber == collision.runNumber()) {
-      return;
-    }
     // In case override, don't proceed, please - no CCDB access required
     if (d_bz_input > -990) { // o2-linter: disable=magic-number (override value)
       d_bz = d_bz_input;
@@ -325,7 +323,6 @@ struct Pi0EtaToGammaGammaMC {
         grpmag.setL3Current(30000.f / (d_bz / 5.0f)); // o2-linter: disable=magic-number (override value)
       }
       o2::base::Propagator::initFieldFromGRP(&grpmag);
-      mRunNumber = collision.runNumber();
       return;
     }
 

PWGEM/PhotonMeson/DataModel/gammaTables.h

@@ -647,10 +647,10 @@ DECLARE_SOA_INDEX_COLUMN(EmEmcCluster, emEmcCluster); //!
 } // namespace trackmatching
 
 DECLARE_SOA_TABLE(EmEmcMTracks, "AOD", "EMEMCMTRACK", //!
-                  trackmatching::EmEmcClusterId, emctm::DeltaPhi, emctm::DeltaEta, emctm::TrackP, emctm::TrackPt);
+                  o2::soa::Index<>, trackmatching::EmEmcClusterId, emctm::DeltaPhi, emctm::DeltaEta, emctm::TrackP, emctm::TrackPt);
 
 DECLARE_SOA_TABLE(EmEmcMSTracks, "AOD", "EMEMCMSTRACK", //!
-                  trackmatching::EmEmcClusterId, emctm::DeltaPhi, emctm::DeltaEta, emctm::TrackP, emctm::TrackPt);
+                  o2::soa::Index<>, trackmatching::EmEmcClusterId, emctm::DeltaPhi, emctm::DeltaEta, emctm::TrackP, emctm::TrackPt);
 
 DECLARE_SOA_TABLE(EMCEMEventIds_000, "AOD", "EMCEMEVENTID", emccluster::EMEventId);              // To be joined with SkimEMCClusters table at analysis level.
 DECLARE_SOA_TABLE_VERSIONED(EMCEMEventIds_001, "AOD", "EMCEMEVENTID", 1, emccluster::PMEventId); // To be joined with SkimEMCClusters table at analysis level.

PWGEM/PhotonMeson/TableProducer/photonconversionbuilder.cxx

@@ -468,6 +468,7 @@ struct PhotonConversionBuilder {
     if (mRunNumber == bc.runNumber()) {
       return;
     }
+    mRunNumber = bc.runNumber();
     // In case override, don't proceed, please - no CCDB access required
     if (d_bz_input > -990) { // o2-linter: disable=magic-number (override value)
       d_bz = d_bz_input;
@@ -476,7 +477,7 @@ struct PhotonConversionBuilder {
         grpmag.setL3Current(30000.f / (d_bz / 5.0f)); // o2-linter: disable=magic-number (override value)
       }
       o2::base::Propagator::initFieldFromGRP(&grpmag);
-      mRunNumber = bc.runNumber();
+
       return;
     }
 
@@ -485,7 +486,6 @@ struct PhotonConversionBuilder {
     // Fetch magnetic field from ccdb for current collision
     d_bz = bc.grpMagField().getNominalL3Field();
     LOG(info) << "Retrieved GRP for timestamp " << run3grp_timestamp << " with magnetic field of " << d_bz << " kZG";
-    mRunNumber = bc.runNumber();
 
     if (useMatCorrType == 2) { // o2-linter: disable=magic-number (material budget correction)
       // setMatLUT only after magfield has been initalized (setMatLUT has implicit and problematic init field call if not)

PWGEM/PhotonMeson/Tasks/MaterialBudgetMC.cxx

@@ -131,7 +131,7 @@ struct MaterialBudgetMC {
         auto* list_pair_subsys_photoncut = dynamic_cast<THashList*>(list_pair_subsys->FindObject(photon_cut_name.data()));
 
         for (const auto& cut3 : cuts3) {
-          std::string pair_cut_name = cut3.getName();
+          std::string const& pair_cut_name = cut3.getName();
           o2::aod::pwgem::photon::histogram::AddHistClass(list_pair_subsys_photoncut, pair_cut_name.data());
           auto* list_pair_subsys_paircut = dynamic_cast<THashList*>(list_pair_subsys_photoncut->FindObject(pair_cut_name.data()));
           o2::aod::pwgem::photon::histogram::DefineHistograms(list_pair_subsys_paircut, "material_budget_study", "Pair");

PWGEM/PhotonMeson/Tasks/SinglePhotonMC.cxx

@@ -17,9 +17,7 @@
 
 #include "PWGEM/Dilepton/Utils/MCUtilities.h"
 #include "PWGEM/PhotonMeson/Core/CutsLibrary.h"
-#include "PWGEM/PhotonMeson/Core/EMCPhotonCut.h"
 #include "PWGEM/PhotonMeson/Core/HistogramsLibrary.h"
-#include "PWGEM/PhotonMeson/Core/PHOSPhotonCut.h"
 #include "PWGEM/PhotonMeson/Core/V0PhotonCut.h"
 #include "PWGEM/PhotonMeson/DataModel/EventTables.h"
 #include "PWGEM/PhotonMeson/DataModel/gammaTables.h"

PWGEM/PhotonMeson/Tasks/TagAndProbe.cxx

@@ -140,7 +140,7 @@ struct TagAndProbe {
       THashList* list_pair_subsys_photoncut = o2::aod::pwgem::photon::histogram::AddHistClass(list_pair, photon_cut_name.data());
 
       for (auto& cut3 : paircuts) {
-        std::string pair_cut_name = cut3.getName();
+        std::string const& pair_cut_name = cut3.getName();
         o2::aod::pwgem::photon::histogram::AddHistClass(list_pair_subsys_photoncut, pair_cut_name.data());
         auto* list_pair_subsys_paircut = dynamic_cast<THashList*>(list_pair_subsys_photoncut->FindObject(pair_cut_name.data()));
         o2::aod::pwgem::photon::histogram::DefineHistograms(list_pair_subsys_paircut, "tag_and_probe", pairname.data());