[PWGJE,EMCAL-670] Add BC selection to EMCal QA task

PWGJE/Core/utilsBcSelEMC.h

@@ -0,0 +1,185 @@
+// 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 utilsBcSelEMC.h
+/// \brief BC selection utilities for EMCal QA
+/// \author Marvin Hemmer <marvin.hemmer@cern.ch>, Goethe-University
+
+#ifndef PWGJE_CORE_UTILSBCSELEMC_H_
+#define PWGJE_CORE_UTILSBCSELEMC_H_
+
+#include <memory> // std::shared_ptr
+#include <string> // std::string
+
+#include "Framework/Configurable.h"
+#include "Framework/HistogramRegistry.h"
+#include "Framework/HistogramSpec.h"
+#include "Framework/OutputObjHeader.h"
+
+#include "Common/CCDB/EventSelectionParams.h"
+
+namespace o2::emc_evsel
+{
+// event rejection types
+enum EventRejection {
+  None = 0,
+  Trigger,
+  TvxTrigger,
+  TimeFrameBorderCut,
+  ItsRofBorderCut,
+  IsGoodZvtxFT0vsPV,
+  NoSameBunchPileup,
+  NoCollInTimeRangeNarrow,
+  NoCollInTimeRangeStandard,
+  NoCollInRofStandard,
+  NEventRejection
+};
+
+o2::framework::AxisSpec axisEvents = {EventRejection::NEventRejection, -0.5f, +EventRejection::NEventRejection - 0.5f, ""};
+
+/// \brief Function to put labels on monitoring histogram
+/// \param hRejection monitoring histogram
+template <typename Histo>
+void setEventRejectionLabels(Histo& hRejection)
+{
+  // Puts labels on the bc monitoring histogram.
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::None + 1, "All");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::Trigger + 1, "Sel8");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::TvxTrigger + 1, "TVX Trigger");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::TimeFrameBorderCut + 1, "TF border");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::ItsRofBorderCut + 1, "ITS ROF border");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::IsGoodZvtxFT0vsPV + 1, "PV #it{z} consistency FT0 timing");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::NoSameBunchPileup + 1, "No same-bunch pile-up");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::NoCollInTimeRangeNarrow + 1, "No coll timerange narrow");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::NoCollInTimeRangeStandard + 1, "No coll timerange strict");
+  hRejection->GetXaxis()->SetBinLabel(EventRejection::NoCollInRofStandard + 1, "No coll in ROF std");
+}
+
+struct EMCEventSelection : o2::framework::ConfigurableGroup {
+  std::string prefix = "emcBcSel"; // JSON group name
+  // event selection parameters (in chronological order of application)
+  o2::framework::Configurable<bool> useSel8Trigger{"useSel8Trigger", true, "Apply the sel8 event selection"};
+  o2::framework::Configurable<int> triggerClass{"triggerClass", -1, "Trigger class different from sel8 (e.g. kINT7 for Run2) used only if useSel8Trigger is false"};
+  o2::framework::Configurable<bool> useTvxTrigger{"useTvxTrigger", true, "Apply TVX trigger sel"};
+  o2::framework::Configurable<bool> useTimeFrameBorderCut{"useTimeFrameBorderCut", true, "Apply TF border cut"};
+  o2::framework::Configurable<bool> useItsRofBorderCut{"useItsRofBorderCut", true, "Apply ITS ROF border cut"};
+  o2::framework::Configurable<bool> useIsGoodZvtxFT0vsPV{"useIsGoodZvtxFT0vsPV", false, "Check consistency between PVz from central barrel with that from FT0 timing"};
+  o2::framework::Configurable<bool> useNoSameBunchPileup{"useNoSameBunchPileup", false, "Exclude collisions in bunches with more than 1 reco. PV"};
+  o2::framework::Configurable<bool> useNoCollInTimeRangeNarrow{"useNoCollInTimeRangeNarrow", false, "Reject collisions in time range narrow"};
+  o2::framework::Configurable<bool> useNoCollInTimeRangeStandard{"useNoCollInTimeRangeStandard", false, "Reject collisions in time range strict"};
+  o2::framework::Configurable<bool> useNoCollInRofStandard{"useNoCollInRofStandard", false, "Reject collisions in ROF standard"};
+
+  // histogram names
+  static constexpr char NameHistBCs[] = "hBCs";
+
+  std::shared_ptr<TH1> hBCs;
+
+  int currentRun{-1};
+
+  /// \brief Adds bc monitoring histograms in the histogram registry.
+  /// \param registry reference to the histogram registry
+  void addHistograms(o2::framework::HistogramRegistry& registry)
+  {
+    hBCs = registry.add<TH1>(NameHistBCs, "EMC event counter;;# of accepted collisions", {o2::framework::HistType::kTH1D, {axisEvents}});
+    setEventRejectionLabels(hBCs);
+  }
+
+  /// \brief Applies event selection.
+  /// \tparam useEvSel use information from the EvSel table
+  /// \param bc bc to test against the selection criteria
+  /// \return bitmask with the event selection criteria not satisfied by the bc
+  template <bool useEvSel, typename Bc>
+  uint16_t getEMCCollisionRejectionMask(const Bc& bc)
+  {
+    uint16_t rejectionMask{0}; // 16 bits, in case new ev. selections will be added
+
+    if constexpr (useEvSel) {
+      /// trigger condition
+      bool sel8 = bc.selection_bit(o2::aod::evsel::kIsBBT0A) && bc.selection_bit(o2::aod::evsel::kIsBBT0C);
+      if ((useSel8Trigger && sel8) || (!useSel8Trigger && triggerClass > -1 && !bc.alias_bit(triggerClass))) {
+        SETBIT(rejectionMask, EventRejection::Trigger);
+      }
+      /// TVX trigger selection
+      if (useTvxTrigger && !bc.selection_bit(o2::aod::evsel::kIsTriggerTVX)) {
+        SETBIT(rejectionMask, EventRejection::TvxTrigger);
+      }
+      /// time frame border cut
+      if (useTimeFrameBorderCut && !bc.selection_bit(o2::aod::evsel::kNoTimeFrameBorder)) {
+        SETBIT(rejectionMask, EventRejection::TimeFrameBorderCut);
+      }
+      /// ITS rof border cut
+      if (useItsRofBorderCut && !bc.selection_bit(o2::aod::evsel::kNoITSROFrameBorder)) {
+        SETBIT(rejectionMask, EventRejection::ItsRofBorderCut);
+      }
+      /// PVz consistency tracking - FT0 timing
+      if (useIsGoodZvtxFT0vsPV && !bc.selection_bit(o2::aod::evsel::kIsGoodZvtxFT0vsPV)) {
+        SETBIT(rejectionMask, EventRejection::IsGoodZvtxFT0vsPV);
+      }
+      /// remove collisions in bunches with more than 1 reco bc
+      /// POTENTIALLY BAD FOR BEAUTY ANALYSES
+      if (useNoSameBunchPileup && !bc.selection_bit(o2::aod::evsel::kNoSameBunchPileup)) {
+        SETBIT(rejectionMask, EventRejection::NoSameBunchPileup);
+      }
+      /// No collisions in time range narrow
+      if (useNoCollInTimeRangeNarrow && !bc.selection_bit(o2::aod::evsel::kNoCollInTimeRangeNarrow)) {
+        SETBIT(rejectionMask, EventRejection::NoCollInTimeRangeNarrow);
+      }
+      /// No collisions in time range strict
+      if (useNoCollInTimeRangeStandard && !bc.selection_bit(o2::aod::evsel::kNoCollInTimeRangeStandard)) {
+        SETBIT(rejectionMask, EventRejection::NoCollInTimeRangeStandard);
+      }
+      /// No collisions in ROF standard
+      if (useNoCollInRofStandard && !bc.selection_bit(o2::aod::evsel::kNoCollInRofStandard)) {
+        SETBIT(rejectionMask, EventRejection::NoCollInRofStandard);
+      }
+    }
+    return rejectionMask;
+  }
+
+  /// \brief Fills histograms for monitoring event selections satisfied by the bc.
+  /// \param rejectionMask bitmask storing the info about which ev. selections are not satisfied by the bc
+  void fillHistograms(const uint16_t rejectionMask)
+  {
+    hBCs->Fill(EventRejection::None);
+    for (std::size_t reason = 1; reason < EventRejection::NEventRejection; reason++) {
+      if (TESTBIT(rejectionMask, reason)) {
+        return;
+      }
+      hBCs->Fill(reason);
+    }
+  }
+};
+
+struct EMCEventSelectionMc {
+  // event selection parameters (in chronological order of application)
+  bool useSel8Trigger{false};       // Apply the Sel8 selection
+  bool useTvxTrigger{false};        // Apply the TVX trigger
+  bool useTimeFrameBorderCut{true}; // Apply TF border cut
+  bool useItsRofBorderCut{false};   // Apply the ITS RO frame border cut
+
+  void configureFromDevice(const o2::framework::DeviceSpec& device)
+  {
+    for (const auto& option : device.options) {
+      if (option.name.compare("emcEvSel.useSel8Trigger") == 0) {
+        useSel8Trigger = option.defaultValue.get<bool>();
+      } else if (option.name.compare("emcEvSel.useTvxTrigger") == 0) {
+        useTvxTrigger = option.defaultValue.get<bool>();
+      } else if (option.name.compare("emcEvSel.useTimeFrameBorderCut") == 0) {
+        useTimeFrameBorderCut = option.defaultValue.get<bool>();
+      } else if (option.name.compare("emcEvSel.useItsRofBorderCut") == 0) {
+        useItsRofBorderCut = option.defaultValue.get<bool>();
+      }
+    }
+  }
+};
+} // namespace o2::emc_evsel
+
+#endif // PWGJE_CORE_UTILSBCSELEMC_H_

PWGJE/Tasks/emcEventSelectionQA.cxx

@@ -22,16 +22,20 @@
 #include "Framework/HistogramRegistry.h"
 
 #include "Common/DataModel/EventSelection.h"
+#include "PWGJE/Core/utilsBcSelEMC.h"
 
 using namespace o2;
 using namespace o2::framework;
 using namespace o2::framework::expressions;
+using namespace o2::emc_evsel;
 
 using BCEvSels = o2::soa::Join<o2::aod::BCs, o2::aod::BcSels>;
 using CollEventSels = o2::soa::Join<o2::aod::Collisions, o2::aod::EvSels>;
 using FilteredCells = o2::soa::Filtered<aod::Calos>;
 
 struct EmcEventSelectionQA {
+
+  EMCEventSelection emcEvSel; // event selection and monitoring
   o2::framework::HistogramRegistry mHistManager{"EMCALEventSelectionQAHistograms"};
 
   // Require EMCAL cells (CALO type 1)
@@ -81,6 +85,8 @@ struct EmcEventSelectionQA {
     mHistManager.add("hBCCollisionCounter_TVX", "Number of BCs with a certain number of rec. colls", O2HistType::kTH2F, {bcAxis, matchingAxis});
     mHistManager.add("hBCEMCalReadoutAndEmcalCellContent", "Bunch crossings with EMCAL trigger from CTP and non-0 EMCAL cell content", O2HistType::kTH1F, {bcAxis});
     mHistManager.add("hBCNotEMCalReadoutButEmcalCellContent", "Bunch crossings without EMCAL trigger from CTP but with non-0 EMCAL cell content", O2HistType::kTH1F, {bcAxis});
+    mHistManager.add("hBCNotAcceptedButEMCalReadout", "Bunch crossings with EMCAL trigger from CTP but not accpeted due to BC selection", O2HistType::kTH1F, {bcAxis});
+    mHistManager.add("hBCNotAcceptedButEmcalCellContent", "Bunch crossings with non-0 EMCAL cell content but not accpeted due to BC selection", O2HistType::kTH1F, {bcAxis});
     mHistManager.add("hAmplitudevsCellTimeNoReadout", "Amplitude vs cell time for bunch crossings without EMCAL trigger from CTP but with non-0 EMCAL cell content", O2HistType::kTH2D, {timeAxisLarge, amplitudeAxisLarge});
 
     initCollisionHistogram(mHistManager.get<TH1>(HIST("hCollisionMatching")).get());
@@ -96,6 +102,8 @@ struct EmcEventSelectionQA {
     initCollisionHistogram(mHistManager.get<TH1>(HIST("hCollisionMatchingDJ1")).get());
     initCollisionHistogram(mHistManager.get<TH1>(HIST("hCollisionMatchingEJ2")).get());
     initCollisionHistogram(mHistManager.get<TH1>(HIST("hCollisionMatchingDJ2")).get());
+
+    emcEvSel.addHistograms(mHistManager); // collision monitoring
   }
 
   PresliceUnsorted<CollEventSels> perFoundBC = aod::evsel::foundBCId;
@@ -120,6 +128,11 @@ struct EmcEventSelectionQA {
       bool isEMCALreadout = false;
       auto bcID = bc.globalBC() % 3564;
 
+      // get bitmask with bc selection info
+      const auto rejectionMask = emcEvSel.getEMCCollisionRejectionMask<true, BCEvSels::iterator>(bc);
+      // monitor the satisfied event selections
+      emcEvSel.fillHistograms(rejectionMask);
+
       if (bc.runNumber() > mRun3MinNumber) {
         // in case of run3 not all BCs contain EMCAL data, require trigger selection also for min. bias
         // in addition select also L0/L1 triggers as triggers with EMCAL in reaodut
@@ -134,6 +147,25 @@ struct EmcEventSelectionQA {
         }
       }
 
+      // lookup number of cells for global BC of this BC
+      // avoid iteration over cell table for speed reason
+      auto found = cellGlobalBCs.find(bc.globalBC());
+
+      if (rejectionMask != 0) {
+        // at least one event selection not satisfied --> reject the candidate
+        continue;
+      } else {
+        if (isEMCALreadout) {
+          mHistManager.fill(HIST("hBCNotAcceptedButEMCalReadout"), bcID);
+        }
+        if (found != cellGlobalBCs.end()) {
+          // require at least 1 cell for global BC
+          if (found->second > 0) {
+            mHistManager.fill(HIST("hBCNotAcceptedButEmcalCellContent"), bcID);
+          }
+        }
+      }
+
       // Monitoring BCs with EMCAL trigger / readout / FIT trigger
       if (isEMCALreadout) {
         mHistManager.fill(HIST("hBCEmcalReadout"), bcID);
@@ -175,7 +207,6 @@ struct EmcEventSelectionQA {
 
       // lookup number of cells for global BC of this BC
       // avoid iteration over cell table for speed reason
-      auto found = cellGlobalBCs.find(bc.globalBC());
       if (found != cellGlobalBCs.end()) {
         // require at least 1 cell for global BC
         if (found->second > 0) {