IHIEventSelectionToolRun3.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef HIEVENTUTILS_IHIEVENTSELECTIONTOOLRUN3_H__
#define HIEVENTUTILS_IHIEVENTSELECTIONTOOLRUN3_H__
 
#include "AsgTools/IAsgTool.h"
#include "xAODEventInfo/EventInfo.h"
#include "xAODForward/ZdcModuleContainer.h"
#include "xAODHIEvent/HIEventShapeContainer.h"
#include "xAODTracking/TrackParticleContainer.h"
#include "xAODTracking/VertexContainer.h"
 
namespace HI {
enum class IonDataType : uint8_t {
  PbPb2015 = 0,
  PbPb2018,
  PbPb2023,
  PbPb2024_Shadowing,
  PbPb2024_NoShadowing,
  OO2025,
  NeNe2025,
  PbPb2025,
  PbPb2026
};
 
std::string toString(IonDataType);
 
enum class PileupVariation : uint8_t { Nominal = 0, Tight, Loose };
 
std::string toString(PileupVariation);
 
constexpr unsigned int bit(int n) {
  return 1 << n;
}
 
// never change bits assignment, feel free to add
enum class SelectionMask : unsigned int {
  NoEventError = bit(0),
  PUFCalVsNTrackLoose = bit(1),
  PUFCalVsNTrackNominal = bit(2),
  PUFCalVsNTrackTight = bit(3),
  PUFCalVsNTrackAny =
      PUFCalVsNTrackLoose | PUFCalVsNTrackNominal | PUFCalVsNTrackTight,
  PUFCalVsZDCLoose = bit(4),
  PUFCalVsZDCNominal = bit(5),
  PUFCalVsZDCTight = bit(6),
  PUFCalVsZDCAny = PUFCalVsZDCLoose | PUFCalVsZDCNominal | PUFCalVsZDCTight,
  PUOOSingleVertexNominal = bit(7),
  PUZDCPresampler = bit(8),
 
  // default cuts for PB
  PBDefault =
      NoEventError | PUFCalVsNTrackLoose | PUFCalVsZDCLoose,// | PUZDCPresampler, this needs to be added back once we can read PreSampleAmp
  // default cuts for OO
  OODefault = NoEventError | PUOOSingleVertexNominal | PUFCalVsNTrackLoose |
              PUFCalVsZDCLoose
 
};
 
std::string toString(SelectionMask);
 
class IHIEventSelectionToolRun3 : public virtual asg::IAsgTool {
 
  ASG_TOOL_INTERFACE(HI::IHIEventSelectionToolRun3)
 
 public:
  virtual ~IHIEventSelectionToolRun3() = default;

  virtual bool noDetectorError(const xAOD::EventInfo* eventInfo) const = 0;

  virtual bool puZDCvsFCal(HI::IonDataType when,
                           const xAOD::HIEventShapeContainer* es,
                           const xAOD::ZdcModuleContainer* zdcModules,
                           HI::PileupVariation variation) const = 0;
 
  virtual float fcalEt(HI::IonDataType when,
                       const xAOD::HIEventShapeContainer* es) const = 0;
 
  virtual float zdcE(HI::IonDataType when,
                     const xAOD::ZdcModuleContainer* zdcModules) const = 0;

  virtual bool puZDCvsFCal(
      IonDataType dataType, float fcalEt, float zdcE,
      PileupVariation variation = PileupVariation::Nominal) const = 0;

  virtual bool puFCalVsNtracks(
      IonDataType dataType, const xAOD::HIEventShapeContainer* es,
      const xAOD::TrackParticleContainer* tracks,
      const xAOD::VertexContainer* vertices,
      PileupVariation variation = PileupVariation::Nominal) const = 0;
 
  virtual int nTrk(IonDataType dataType,
                   const xAOD::TrackParticleContainer* tracks,
                   const xAOD::VertexContainer* vertices)  const = 0;
 
  virtual bool puFCalVsNtracks(
      IonDataType dataType, float fcalEt, int ntrk,
      PileupVariation variation = PileupVariation::Nominal) const = 0;

  virtual bool puZDCPresampler(HI::IonDataType when,
                               const xAOD::ZdcModuleContainer* zdcModules,
                               HI::PileupVariation variation) const = 0;
  virtual bool puZDCPresampler(
      IonDataType dataType, float presamplerA, float presamplerC,
      PileupVariation variation = PileupVariation::Nominal) const = 0;

  virtual bool puOOVertexCuts(IonDataType dataType,
                              const xAOD::VertexContainer* vertices) const = 0;

  virtual IonDataType toDataType(const xAOD::EventInfo* eventInfo) const = 0;

  virtual unsigned int defaultMaskForPeriod(IonDataType period) const = 0;
};
 
}  // namespace HI
 
#endif