[PWGCF] DptDpt -- ITS dead maps selection (#9242)

Co-authored-by: Victor <victor@cern.ch>

Author: victor-gonzalez

PWGCF/TableProducer/dptdptfilter.cxx

@@ -106,6 +106,9 @@ const char* eventSelectionSteps[knCollisionSelectionFlags] = {
   "ISVERTEXTOFMATCHED",
   "ISVERTEXTRDMATCHED",
   "OCCUPANCY",
+  "ISGOODITSLAYER3",
+  "ISGOODITSLAYER0123",
+  "ISGOODITSLAYERALL",
   "CENTRALITY",
   "ZVERTEX",
   "SELECTED"};
@@ -363,6 +366,10 @@ struct DptDptFilter {
   Configurable<std::string> cfgCentMultEstimator{"centmultestimator", "V0M", "Centrality/multiplicity estimator detector: V0M,CL0,CL1,FV0A,FT0M,FT0A,FT0C,NTPV,NOCM: none. Default V0M"};
   Configurable<std::string> cfgOccupancyEstimation{"occestimation", "None", "Occupancy estimation: None, Tracks, FT0C. Default None"};
   Configurable<float> cfgMaxOccupancy{"occmax", 1e6f, "Maximum allowed occupancy. Depends on the occupancy estimation"};
+  struct : ConfigurableGroup {
+    std::string prefix = "cfgEventSelection";
+    Configurable<std::string> itsDeadMaps{"itsDeadMaps", "", "Level of inactive chips: nocheck(empty), goodIts3, goodIts0123, goodItsAll. Default empty"};
+  } cfgEventSelection;
   Configurable<std::string> cfgSystem{"syst", "PbPb", "System: pp, PbPb, Pbp, pPb, XeXe, ppRun3, PbPbRun3. Default PbPb"};
   Configurable<std::string> cfgDataType{"datatype", "data", "Data type: data, datanoevsel, MC, FastMC, OnTheFlyMC. Default data"};
   Configurable<std::string> cfgTriggSel{"triggsel", "MB", "Trigger selection: MB,VTXTOFMATCHED,VTXTRDMATCHED,VTXTRDTOFMATCHED,None. Default MB"};
@@ -421,6 +428,8 @@ struct DptDptFilter {
     /* the occupancy selection */
     fOccupancyEstimation = getOccupancyEstimator(cfgOccupancyEstimation);
     fMaxOccupancy = cfgMaxOccupancy;
+    /* the ITS dead map check */
+    fItsDeadMapCheck = getItsDeadMapCheck(cfgEventSelection.itsDeadMaps);
 
     /* the trigger selection */
     fTriggerSelection = getTriggerSelection(cfgTriggSel);

PWGCF/TableProducer/dptdptfilter.h

@@ -135,6 +135,9 @@ enum CollisionSelectionFlags {
   kISVERTEXTOFMATCHEDBIT,   ///< vertex contributor with TOF matched
   kISVERTEXTRDMATCHEDBIT,   ///< vertex contributor with TRD matche
   kOCCUPANCYBIT,            ///< occupancy within limits
+  kISGOODITSLAYER3BIT,      ///< right level of inactive chips for ITS layer 3
+  kISGOODITSLAYER0123BIT,   ///< right level of inactive chips for ITS layers 0,1,2, and 3
+  kISGOODITSLAYERALLBIT,    ///< right level of inactive chips for all seven ITS layers
   kCENTRALITYBIT,           ///< centrality cut passed
   kZVERTEXBIT,              ///< zvtx cut passed
   kSELECTED,                ///< the event has passed all selections
@@ -156,6 +159,15 @@ enum TpcExclusionMethod {
   kDYNAMIC          ///< pT dependent exclusion matching the sector borders a la Alex Dobrin
 };
 
+/// \enum ItsDeadMapsCheckType
+/// \brief Check for the right level of ITS dead chips
+enum ItsDeadMapsCheckType {
+  kNOCHECK = 0,      ///< no check
+  kGOODITSLAYER3,    ///< check the  3 ITS layer
+  kGOODITSLAYER0123, ///< check the 0,1,2,and 3 ITS layers
+  kGOODITSLAYERALL   ///< check the all ITS layers
+};
+
 //============================================================================================
 // The debug output stream
 //============================================================================================
@@ -364,7 +376,9 @@ DataType fDataType = kData;
 CentMultEstimatorType fCentMultEstimator = kV0M;
 TriggerSelectionType fTriggerSelection = kMB;
 OccupancyEstimationType fOccupancyEstimation = kNOOCC; /* the occupancy estimator to use */
-float fMaxOccupancy = 1e6f;                            /* the maximum allowed occupancy */
+ItsDeadMapsCheckType fItsDeadMapCheck = kNOCHECK;      /* the check of the ITS dead maps to use */
+
+float fMaxOccupancy = 1e6f; /* the maximum allowed occupancy */
 
 /* adaptations for the pp nightly checks */
 analysis::CheckRangeCfg traceDCAOutliers;
@@ -524,6 +538,22 @@ inline OccupancyEstimationType getOccupancyEstimator(const std::string& estimato
   }
 }
 
+inline ItsDeadMapsCheckType getItsDeadMapCheck(const std::string& check)
+{
+  if (check.length() == 0 || check == "None") {
+    return kNOCHECK;
+  } else if (check == "goodIts3") {
+    return kGOODITSLAYER3;
+  } else if (check == "goodIts0123") {
+    return kGOODITSLAYER0123;
+  } else if (check == "goodItsAll") {
+    return kGOODITSLAYERALL;
+  } else {
+    LOGF(fatal, "ITS dead map check %s not implemented", check.c_str());
+    return kNOCHECK;
+  }
+}
+
 //////////////////////////////////////////////////////////////////////////////////
 /// Trigger selection
 //////////////////////////////////////////////////////////////////////////////////
@@ -588,6 +618,9 @@ inline bool triggerSelectionReco(CollisionObject const& collision)
         flags.set(kISVERTEXITSTPCBIT, coll.selection_bit(aod::evsel::kIsVertexITSTPC));
         flags.set(kISVERTEXTOFMATCHEDBIT, coll.selection_bit(aod::evsel::kIsVertexTOFmatched));
         flags.set(kISVERTEXTRDMATCHEDBIT, coll.selection_bit(aod::evsel::kIsVertexTRDmatched));
+        flags.set(kISGOODITSLAYER3BIT, coll.selection_bit(aod::evsel::kIsGoodITSLayer3));
+        flags.set(kISGOODITSLAYER0123BIT, coll.selection_bit(aod::evsel::kIsGoodITSLayer0123));
+        flags.set(kISGOODITSLAYERALLBIT, coll.selection_bit(aod::evsel::kIsGoodITSLayersAll));
       };
       switch (fTriggerSelection) {
         case kMB:
@@ -880,7 +913,8 @@ inline bool centralitySelection<aod::McCollision>(aod::McCollision const&, float
 /// Occupancy selection
 //////////////////////////////////////////////////////////////////////////////////
 
-/// \brief get the collision occupancy
+/// \brief select on the collision occupancy
+/// \return true if collison passes the occupancy cut false otherwise
 template <typename CollisionObject>
 inline bool selectOnOccupancy(CollisionObject collision)
 {
@@ -924,9 +958,9 @@ inline bool occupancySelection<aod::CollisionEvSelCent>(aod::CollisionEvSelCent
 
 /// \brief Occupancy selection for reconstructed and detector level collision tables with Run 2 centrality/multiplicity information
 template <>
-inline bool occupancySelection<aod::CollisionEvSelRun2Cent>(aod::CollisionEvSelRun2Cent const& collision)
+inline bool occupancySelection<aod::CollisionEvSelRun2Cent>(aod::CollisionEvSelRun2Cent const&)
 {
-  return selectOnOccupancy(collision);
+  return true;
 }
 
 /// \brief Occupancy selection for reconstructed and detector level collision tables without centrality/multiplicity information
@@ -952,9 +986,9 @@ inline bool occupancySelection<soa::Join<aod::CollisionsEvSelCent, aod::McCollis
 
 /// \brief Occupancy selection for detector level collision tables with Run 2 centrality/multiplicity
 template <>
-inline bool occupancySelection<soa::Join<aod::CollisionsEvSelRun2Cent, aod::McCollisionLabels>::iterator>(soa::Join<aod::CollisionsEvSelRun2Cent, aod::McCollisionLabels>::iterator const& collision)
+inline bool occupancySelection<soa::Join<aod::CollisionsEvSelRun2Cent, aod::McCollisionLabels>::iterator>(soa::Join<aod::CollisionsEvSelRun2Cent, aod::McCollisionLabels>::iterator const&)
 {
-  return selectOnOccupancy(collision);
+  return true;
 }
 
 /// \brief Occupancy selection for generator level collision table
@@ -964,6 +998,98 @@ inline bool occupancySelection<aod::McCollision>(aod::McCollision const&)
   return true;
 }
 
+//////////////////////////////////////////////////////////////////////////////////
+/// ITS dead maps selection
+//////////////////////////////////////////////////////////////////////////////////
+
+/// \brief select on the ITS dead maps
+/// \return true if the collision passes the ITS dead maps check false otherwise
+template <typename CollisionObject>
+inline bool selectOnItsDeadMaps(CollisionObject coll)
+{
+  switch (fItsDeadMapCheck) {
+    case kNOCHECK:
+      return true;
+    case kGOODITSLAYER3:
+      if (coll.selection_bit(aod::evsel::kIsGoodITSLayer3)) {
+        return true;
+      } else {
+        return false;
+      }
+    case kGOODITSLAYER0123:
+      if (coll.selection_bit(aod::evsel::kIsGoodITSLayer0123)) {
+        return true;
+      } else {
+        return false;
+      }
+    case kGOODITSLAYERALL:
+      if (coll.selection_bit(aod::evsel::kIsGoodITSLayersAll)) {
+        return true;
+      } else {
+        return false;
+      }
+    default:
+      return false;
+  }
+}
+
+/// \brief Occupancy selection by default: unknown subscribed collision table
+template <typename CollisionObject>
+inline bool itsDeadMapsSelection(CollisionObject const&)
+{
+  LOGF(fatal, "Occupancy selection not implemented for this kind of collisions");
+  return false;
+}
+
+/// \brief Occupancy selection for reconstructed and detector level collision tables with centrality/multiplicity information
+template <>
+inline bool itsDeadMapsSelection<aod::CollisionEvSelCent>(aod::CollisionEvSelCent const& collision)
+{
+  return selectOnItsDeadMaps(collision);
+}
+
+/// \brief Occupancy selection for reconstructed and detector level collision tables with Run 2 centrality/multiplicity information
+template <>
+inline bool itsDeadMapsSelection<aod::CollisionEvSelRun2Cent>(aod::CollisionEvSelRun2Cent const&)
+{
+  return true;
+}
+
+/// \brief Occupancy selection for reconstructed and detector level collision tables without centrality/multiplicity information
+template <>
+inline bool itsDeadMapsSelection<aod::CollisionEvSel>(aod::CollisionEvSel const& collision)
+{
+  return selectOnItsDeadMaps(collision);
+}
+
+/// \brief Occupancy selection for detector level collision tables without centrality/multiplicity
+template <>
+inline bool itsDeadMapsSelection<soa::Join<aod::CollisionsEvSel, aod::McCollisionLabels>::iterator>(soa::Join<aod::CollisionsEvSel, aod::McCollisionLabels>::iterator const& collision)
+{
+  return selectOnItsDeadMaps(collision);
+}
+
+/// \brief Occupancy selection for detector level collision tables with centrality/multiplicity
+template <>
+inline bool itsDeadMapsSelection<soa::Join<aod::CollisionsEvSelCent, aod::McCollisionLabels>::iterator>(soa::Join<aod::CollisionsEvSelCent, aod::McCollisionLabels>::iterator const& collision)
+{
+  return selectOnItsDeadMaps(collision);
+}
+
+/// \brief Occupancy selection for detector level collision tables with Run 2 centrality/multiplicity
+template <>
+inline bool itsDeadMapsSelection<soa::Join<aod::CollisionsEvSelRun2Cent, aod::McCollisionLabels>::iterator>(soa::Join<aod::CollisionsEvSelRun2Cent, aod::McCollisionLabels>::iterator const&)
+{
+  return true;
+}
+
+/// \brief Occupancy selection for generator level collision table
+template <>
+inline bool itsDeadMapsSelection<aod::McCollision>(aod::McCollision const&)
+{
+  return true;
+}
+
 //////////////////////////////////////////////////////////////////////////////////
 /// Event selection
 //////////////////////////////////////////////////////////////////////////////////
@@ -978,6 +1104,8 @@ inline bool isEventSelected(CollisionObject const& collision, float& centormult)
 
   bool occupancysel = occupancySelection(collision);
 
+  bool itsdeadmapssel = itsDeadMapsSelection(collision);
+
   bool zvtxsel = false;
   /* TODO: vertex quality checks */
   if (zvtxlow < collision.posZ() && collision.posZ() < zvtxup) {
@@ -995,7 +1123,7 @@ inline bool isEventSelected(CollisionObject const& collision, float& centormult)
 
   bool centmultsel = centralitySelection(collision, centormult);
 
-  bool accepted = trigsel && occupancysel && zvtxsel && centmultsel;
+  bool accepted = trigsel && occupancysel && itsdeadmapssel && zvtxsel && centmultsel;
 
   if (accepted) {
     collisionFlags.set(kSELECTED);