#include <HIEventSelectionToolRun3.h>

Inheritance diagram for HI::HIEventSelectionToolRun3:

Collaboration diagram for HI::HIEventSelectionToolRun3:

Public Member Functions
	HIEventSelectionToolRun3 (const std::string &name)
virtual	~HIEventSelectionToolRun3 ()=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual bool	noDetectorError (const xAOD::EventInfo *eventInfo) const override
	Checks basic event flags.
virtual bool	puZDCvsFCal (HI::IonDataType period, const xAOD::HIEventShapeContainer es, const xAOD::ZdcModuleContainer zdcModules, HI::PileupVariation variation) const override
	true if this is pileup event It computes necessary quantities and invokes method defined next to perform actual selection
virtual float	fcalEt (HI::IonDataType period, const xAOD::HIEventShapeContainer *es) const override
virtual float	zdcE (HI::IonDataType period, const xAOD::ZdcModuleContainer *zdcModules) const override
virtual bool	puZDCvsFCal (IonDataType dataType, float fcalEt, float zdcE, PileupVariation variation=PileupVariation::Nominal) const override
	true if this is pileup event
virtual bool	puFCalVsNtracks (IonDataType dataType, const xAOD::HIEventShapeContainer es, const xAOD::TrackParticleContainer tracks, const xAOD::VertexContainer *vertices, PileupVariation variation=PileupVariation::Nominal) const override
	true if this is pileup event The fool performs track selection
virtual int	nTrk (HI::IonDataType dataType, const xAOD::TrackParticleContainer tracks, const xAOD::VertexContainer vertices) const override
virtual bool	puFCalVsNtracks (IonDataType dataType, float fcalEt, int ntrk, PileupVariation variation=PileupVariation::Nominal) const override
virtual bool	puZDCPresampler (HI::IonDataType period, const xAOD::ZdcModuleContainer *zdcModules, HI::PileupVariation variation) const override
	true if this is not pileup event
virtual bool	puZDCPresampler (IonDataType dataType, float presamplerA, float presamplerC, PileupVariation variation=PileupVariation::Nominal) const override
virtual bool	puOOVertexCuts (IonDataType dataType, const xAOD::VertexContainer *vertices) const override
	true if this is pileup event
virtual IonDataType	toDataType (const xAOD::EventInfo *eventInfo) const override
	translates info in EV into HI data type
virtual unsigned int	defaultMaskForPeriod (IonDataType period) const override
	provides default set of cuts for given period
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
float	zdcCutValue (IonDataType, float fcalEt, PileupVariation) const
float	ntrkCutValue (IonDataType, float fcalEt, PileupVariation) const
IonDataType	runNumberToDataType (uint32_t run) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< InDet::IInDetTrackSelectionTool >	m_trackSelectionTool
std::unique_ptr< TH1D >	m_ZDCEt_UpperCut_5p5Sigma_OO
std::unique_ptr< TH1D >	m_ZDCEt_UpperCut_4p0Sigma_NeNe
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 16 of file HIEventSelectionToolRun3.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ HIEventSelectionToolRun3()

HI::HIEventSelectionToolRun3::HIEventSelectionToolRun3 ( const std::string & name )

Definition at line 103 of file HIEventSelectionToolRun3.cxx.

104 : AsgTool(name) {}

asg::AsgTool::AsgTool

AsgTool(const std::string &name)

Constructor specifying the tool instance's name.

Definition AsgTool.cxx:58

◆ ~HIEventSelectionToolRun3()

virtual HI::HIEventSelectionToolRun3::~HIEventSelectionToolRun3 ( )

virtualdefault

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ defaultMaskForPeriod()

unsigned int HI::HIEventSelectionToolRun3::defaultMaskForPeriod ( IonDataType period ) const

overridevirtual

provides default set of cuts for given period

Implements HI::IHIEventSelectionToolRun3.

Definition at line 421 of file HIEventSelectionToolRun3.cxx.

                                {
  if (period == HI::IonDataType::OO2025 or
      period == HI::IonDataType::NeNe2025) {
    return static_cast<unsigned int>(HI::SelectionMask::OODefault);
  }
  // this will likely evolve
  return static_cast<unsigned int>(HI::SelectionMask::PBDefault);
}

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ fcalEt()

float HI::HIEventSelectionToolRun3::fcalEt	(	HI::IonDataType	period,
		const xAOD::HIEventShapeContainer *	es ) const

overridevirtual

Implements HI::IHIEventSelectionToolRun3.

Definition at line 146 of file HIEventSelectionToolRun3.cxx.

                                                              {
  float et = 0;
  for (auto slice : *es) {
    const static std::set fcalLayers({21, 22, 23});
    if (fcalLayers.contains(slice->layer()))
      et += slice->et();
  }
  return et * 1e-6;  // we operate in TeV
}

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

◆ getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode HI::HIEventSelectionToolRun3::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 106 of file HIEventSelectionToolRun3.cxx.

                                                  {
  ATH_MSG_INFO("Initializing HIEventSelectionToolRun3");
  // add printout of overall selection that is configured
  if (!m_trackSelectionTool.empty())
    ATH_CHECK(m_trackSelectionTool.retrieve());
 
  //----------------------------------------------------------------------
  // https://atlas-heavy-ions.docs.cern.ch/analyzes/2025/
  // also See Figure 2.6 of
  // https://cds.cern.ch/record/2930965/files/ATL-COM-PHYS-2025-347.pdf
  m_ZDCEt_UpperCut_5p5Sigma_OO = loadHist("PUFCalVsZDCNominalOO2025.json");
 
  //----------------------------------------------------------------------
 
  //----------------------------------------------------------------------
  // https://atlas-heavy-ions.docs.cern.ch/analyzes/2025/
  // also See Figure 2.6 of
  // https://cds.cern.ch/record/2930965/files/ATL-COM-PHYS-2025-347.pdf
  m_ZDCEt_UpperCut_4p0Sigma_NeNe = loadHist("PUFCalVsZDCNominalNeNe2025.json");
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ noDetectorError()

bool HI::HIEventSelectionToolRun3::noDetectorError ( const xAOD::EventInfo * eventInfo ) const

overridevirtual

Checks basic event flags.

Parameters

eventInfo

Returns: true if no error

Implements HI::IHIEventSelectionToolRun3.

Definition at line 128 of file HIEventSelectionToolRun3.cxx.

                                          {
  if (!eventInfo)
    return false;
 
  // Standard ATLAS error checks
  if (eventInfo->errorState(xAOD::EventInfo::LAr) == xAOD::EventInfo::Error)
    return false;
  if (eventInfo->errorState(xAOD::EventInfo::Tile) == xAOD::EventInfo::Error)
    return false;
  if (eventInfo->errorState(xAOD::EventInfo::SCT) == xAOD::EventInfo::Error)
    return false;
  if (eventInfo->errorState(xAOD::EventInfo::Pixel) == xAOD::EventInfo::Error)
    return false;
 
  return true;
}

◆ nTrk()

int HI::HIEventSelectionToolRun3::nTrk	(	HI::IonDataType	dataType,
		const xAOD::TrackParticleContainer *	tracks,
		const xAOD::VertexContainer *	vertices ) const

overridevirtual

Implements HI::IHIEventSelectionToolRun3.

Definition at line 181 of file HIEventSelectionToolRun3.cxx.

                                                            {
  const xAOD::Vertex* pv = 0;
  for (const xAOD::Vertex* vx : *vertices) {
    if (vx->vertexType() == xAOD::VxType::PriVtx) {
      pv = vx;
      break;
    }
  }
 
  int count = 0;
  for (const xAOD::TrackParticle* trk : *tracks) {
    if (m_trackSelectionTool->accept(*trk, pv)) {
      count++;
    }
  }
  return count;
}

◆ ntrkCutValue()

float HI::HIEventSelectionToolRun3::ntrkCutValue	(	HI::IonDataType	,
		float	fcalEt,
		HI::PileupVariation	) const

private

Definition at line 387 of file HIEventSelectionToolRun3.cxx.

                                                                          {
  return 0;
}

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

◆ puFCalVsNtracks() [1/2]

bool HI::HIEventSelectionToolRun3::puFCalVsNtracks	(	IonDataType	dataType,
		const xAOD::HIEventShapeContainer *	es,
		const xAOD::TrackParticleContainer *	tracks,
		const xAOD::VertexContainer *	vertices,
		PileupVariation	variation = PileupVariation::Nominal ) const

overridevirtual

true if this is pileup event The fool performs track selection

Implements HI::IHIEventSelectionToolRun3.

Definition at line 201 of file HIEventSelectionToolRun3.cxx.

                                                                          {
  return puFCalVsNtracks(period, fcalEt(period, es), nTrk(period, tracks, vertices), variation);
}

◆ puFCalVsNtracks() [2/2]

bool HI::HIEventSelectionToolRun3::puFCalVsNtracks	(	HI::IonDataType	period,
		float	fcalEt,
		int	ntrk,
		HI::PileupVariation	variation = PileupVariation::Nominal ) const

overridevirtual

Implements HI::IHIEventSelectionToolRun3.

Definition at line 208 of file HIEventSelectionToolRun3.cxx.

                                                                            {
  ATH_MSG_DEBUG("cutting puFCalVsNtracks: fcalEt " << fcalEt << " ntracks "
                                                   << ntrk);
  // for reference, thes numbers are taken from:
  // https://atlas-heavy-ions.docs.cern.ch/analyzes/2025/#fcal-sumet-ntrk-correlation-cut
  // and more is here:
  // https://cds.cern.ch/record/2930965/files/ATL-COM-PHYS-2025-347.pdf
  if (period == HI::IonDataType::OO2025) {
    if (ntrk < (-80 + fcalEt * 600))
      return false;
    if (ntrk < (-30 + fcalEt * 400))
      return false;
    if (ntrk > (100 + fcalEt * 1700))
      return false;
    return true;
  } else if (period == HI::IonDataType::NeNe2025) {
    if (ntrk < (-70 + fcalEt * 600))
      return false;
    if (ntrk < (-20 + fcalEt * 350))
      return false;
    if (ntrk > (100 + fcalEt * 1700))
      return false;
    return true;
  }
  return false;  // for unimplemented periods
}

◆ puOOVertexCuts()

bool HI::HIEventSelectionToolRun3::puOOVertexCuts	(	IonDataType	dataType,
		const xAOD::VertexContainer *	vertices ) const

overridevirtual

true if this is pileup event

Implements HI::IHIEventSelectionToolRun3.

Definition at line 281 of file HIEventSelectionToolRun3.cxx.

                                                              {
 
  // This is probably redundant as the vx->vertexType() should not be
  // xAOD::VxType::PriVtx for the dummy vertex
  if (vertices->size() <= 1) {
    ATH_MSG_DEBUG("Only dummy vertex present, returning false");
    return false;
  }
 
  unsigned int nPrimary = 0;
  unsigned int nSplit = 0;
  unsigned int nOther = 0;
  // count primary vertices with sigma_z^2 < threshold
  // documentation: https://atlas-heavy-ions.docs.cern.ch/analyzes/2025/
  for (const xAOD::Vertex* vx : *vertices) {
    if (vx->vertexType() == xAOD::VxType::PriVtx) {
      // check Primary vertices to see if there are some of good quality
      AmgSymMatrix(3) vtx_err = vx->covariancePosition();
      const double sigmaZSq = vtx_err(2, 2);
      if (sigmaZSq >= 0.02)  // cut in mm^2
        ++nSplit;
      else
        ++nPrimary;
    }
    // vertices that are not PV, note that dummy vertex probably will get
    // assigned here
    else
      ++nOther;
  }
  ATH_MSG_DEBUG("n primary " << nPrimary << ",   nSplit " << nSplit
                             << ",  nOther " << nOther);
 
  // If all vertices were classified as split, then we consider one of them to
  // be a real vertex
  if (nSplit > 0 && nPrimary == 0) {
    ATH_MSG_DEBUG("Returning true as all vertices classified as split");
    return true;
  }
 
  return nPrimary == 1;
}

◆ puZDCPresampler() [1/2]

bool HI::HIEventSelectionToolRun3::puZDCPresampler	(	HI::IonDataType	when,
		const xAOD::ZdcModuleContainer *	zdcModules,
		HI::PileupVariation	variation ) const

overridevirtual

true if this is not pileup event

Implements HI::IHIEventSelectionToolRun3.

Definition at line 237 of file HIEventSelectionToolRun3.cxx.

                                       {
  float PreSamplerAmp_A = 0;
  float PreSamplerAmp_C = 0;
  static const SG::ConstAccessor<float> accPreSampleAmp("PreSampleAmp");
  for (const auto module : *zdcModules) {
    if (module->zdcType() != 0)
      continue;
    if (module->zdcSide() > 0)
      PreSamplerAmp_C += accPreSampleAmp(*module);
    if (module->zdcSide() < 0)
      PreSamplerAmp_A += accPreSampleAmp(*module);
  }
  return puZDCPresampler(period, PreSamplerAmp_A, PreSamplerAmp_C, variation);
}

◆ puZDCPresampler() [2/2]

bool HI::HIEventSelectionToolRun3::puZDCPresampler	(	HI::IonDataType	period,
		float	presamplerA,
		float	presamplerC,
		HI::PileupVariation	variation = PileupVariation::Nominal ) const

overridevirtual

Implements HI::IHIEventSelectionToolRun3.

Definition at line 254 of file HIEventSelectionToolRun3.cxx.

                                       {
  // not sure if fcalEt will be involved i.e. apply this cut only above certain
  // fcalEt
 
  if (period == HI::IonDataType::PbPb2023) {
    // from ATL-COM-PHYS-2025-033 + priv. communication F.Pauwels
    const float peakPositionA = -56;
    const float peakPositionC = -156;
    const float peakWidthA = 51.8;
    const float peakWidthC = 51.8;
    float sigma = 7;
    if (variation == HI::PileupVariation::Tight) {
      sigma = 8;
    }
    if (variation == HI::PileupVariation::Loose) {
      sigma = 6;
    }
    if (presamplerA > (peakPositionA + sigma * peakWidthA) and
        presamplerC > (peakPositionC + sigma * peakWidthC)) {
      return true;  // it is pileup
    }
  }
  return false;
}

◆ puZDCvsFCal() [1/2]

bool HI::HIEventSelectionToolRun3::puZDCvsFCal	(	HI::IonDataType	when,
		const xAOD::HIEventShapeContainer *	es,
		const xAOD::ZdcModuleContainer *	zdcModules,
		HI::PileupVariation	variation ) const

overridevirtual

true if this is pileup event It computes necessary quantities and invokes method defined next to perform actual selection

Implements HI::IHIEventSelectionToolRun3.

Definition at line 167 of file HIEventSelectionToolRun3.cxx.

                                       {
  return puZDCvsFCal(period, fcalEt(period, es), zdcE(period, zdcModules), variation);
}

◆ puZDCvsFCal() [2/2]

bool HI::HIEventSelectionToolRun3::puZDCvsFCal	(	IonDataType	dataType,
		float	fcalEt,
		float	zdcE,
		PileupVariation	variation = PileupVariation::Nominal ) const

overridevirtual

true if this is pileup event

Implements HI::IHIEventSelectionToolRun3.

Definition at line 174 of file HIEventSelectionToolRun3.cxx.

                                       {
  const float cut = zdcCutValue(period, fcalEt, variation);
  return zdcE < cut;
}

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ runNumberToDataType()

HI::IonDataType HI::HIEventSelectionToolRun3::runNumberToDataType ( uint32_t run ) const

private

Definition at line 397 of file HIEventSelectionToolRun3.cxx.

                        {
  if (run < 365498)
    throw std::runtime_error(std::to_string(run) +
                             " not handled by selection tool");
  if (run <= 367384)
    return HI::IonDataType::PbPb2018;
  if (run <= 463427)
    return HI::IonDataType::PbPb2023;
  if (run <= 489691)
    return HI::IonDataType::PbPb2024_Shadowing;
  if (run <= 490223)
    return HI::IonDataType::PbPb2024_NoShadowing;
  if (run <= 501969)
    return HI::IonDataType::OO2025;
  if (run <= 502008)
    return HI::IonDataType::NeNe2025;
  if (run <= 512049)
    return HI::IonDataType::PbPb2025;
  // fill it up with 2026
  throw std::runtime_error(std::to_string(run) +
                           " not handled by selection tool");
}

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ toDataType()

HI::IonDataType HI::HIEventSelectionToolRun3::toDataType ( const xAOD::EventInfo * eventInfo ) const

overridevirtual

translates info in EV into HI data type

Implements HI::IHIEventSelectionToolRun3.

Definition at line 392 of file HIEventSelectionToolRun3.cxx.

                                          {
  return runNumberToDataType(eventInfo->runNumber());
}

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

◆ zdcCutValue()

float HI::HIEventSelectionToolRun3::zdcCutValue	(	HI::IonDataType	period,
		float	fcalEt,
		HI::PileupVariation	variation ) const

private

Definition at line 324 of file HIEventSelectionToolRun3.cxx.

                                                                           {
  if (fcalEt > 100.0)
    throw std::runtime_error(
        std::to_string(fcalEt) +
        " the energy that is given to zdcCutValue is well above 100 TeV?, "
        "likely you call it not converting energy to TeV");
 
  if (period == HI::IonDataType::PbPb2023) {
 
    auto cutFunction = [](float et) {
      const static double a = 334.29, b = -20.39,
                          c = -2.38;  // from ATL-COM-PHYS-2025-033
      return a + b * et + c * et * et;
    };
 
    float cut = cutFunction(fcalEt);
    if (fcalEt <= 1.0)  // below 1 TeV use flat
      cut = cutFunction(1.0);
    if (fcalEt >= 4.0)  // below 1 TeV use flat
      cut = cutFunction(4.0);
 
    if (variation == HI::PileupVariation::Tight) {
      cut *= 1.02;
    }
    if (variation == HI::PileupVariation::Loose) {
      cut *= 0.98;
    }
    return cut;
  }
 
  // https://atlas-heavy-ions.docs.cern.ch/analyzes/2025/
  // also See Figure 2.6 of
  // https://cds.cern.ch/record/2930965/files/ATL-COM-PHYS-2025-347.pdf
  if (period == HI::IonDataType::OO2025) {
    //*1e3 below to convert fcalEt from TeV to GeV
    int refbin = m_ZDCEt_UpperCut_5p5Sigma_OO->FindFixBin(fcalEt * 1e3);
    if (refbin < 1)
      refbin = 1;
 
    //*1e3 below to convert Zdc value in histogram from TeV to GeV
    return m_ZDCEt_UpperCut_5p5Sigma_OO->GetBinContent(refbin) * 1e3;
  }
 
  // https://atlas-heavy-ions.docs.cern.ch/analyzes/2025/
  // also See Figure 2.6 of
  // https://cds.cern.ch/record/2930965/files/ATL-COM-PHYS-2025-347.pdf
  if (period == HI::IonDataType::NeNe2025) {
    //*1e3 below to convert fcalEt from TeV to GeV
    int refbin = m_ZDCEt_UpperCut_4p0Sigma_NeNe->FindFixBin(fcalEt * 1e3);
    if (refbin < 1)
      refbin = 1;
 
    //*1e3 below to convert Zdc value in histogram from TeV to GeV
    return m_ZDCEt_UpperCut_4p0Sigma_NeNe->GetBinContent(refbin) * 1e3;
  }
 
  throw std::runtime_error(std::string("period of id ") + HI::toString(period) +
                           " is not handled (yet)");
 
  return 0;
}

◆ zdcE()

float HI::HIEventSelectionToolRun3::zdcE	(	HI::IonDataType	period,
		const xAOD::ZdcModuleContainer *	zdcModules ) const

overridevirtual

Implements HI::IHIEventSelectionToolRun3.

Definition at line 157 of file HIEventSelectionToolRun3.cxx.

                                                                   {
  float e = 0;
  static const SG::ConstAccessor<float> calibEnergyAccessor("CalibEnergy");
  for (auto module : *zdcModules) {
    e += calibEnergyAccessor(*module);
  }
  return e * 1e-3;  // we operate in GeV
}

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_trackSelectionTool

ToolHandle<InDet::IInDetTrackSelectionTool> HI::HIEventSelectionToolRun3::m_trackSelectionTool

private

Initial value:

{

this, "TrackSelectionTool", "", ""}

Definition at line 74 of file HIEventSelectionToolRun3.h.

74 {

75 this, "TrackSelectionTool", "", ""};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_ZDCEt_UpperCut_4p0Sigma_NeNe

std::unique_ptr<TH1D> HI::HIEventSelectionToolRun3::m_ZDCEt_UpperCut_4p0Sigma_NeNe

private

Definition at line 78 of file HIEventSelectionToolRun3.h.

◆ m_ZDCEt_UpperCut_5p5Sigma_OO

std::unique_ptr<TH1D> HI::HIEventSelectionToolRun3::m_ZDCEt_UpperCut_5p5Sigma_OO

private

Definition at line 77 of file HIEventSelectionToolRun3.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ HIEventSelectionToolRun3()

◆ ~HIEventSelectionToolRun3()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ defaultMaskForPeriod()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ fcalEt()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ noDetectorError()

◆ nTrk()

◆ ntrkCutValue()

◆ outputHandles()

◆ print()

◆ puFCalVsNtracks() [1/2]

◆ puFCalVsNtracks() [2/2]

◆ puOOVertexCuts()

◆ puZDCPresampler() [1/2]

◆ puZDCPresampler() [2/2]

◆ puZDCvsFCal() [1/2]

◆ puZDCvsFCal() [2/2]

◆ renounce()

◆ renounceArray()

◆ runNumberToDataType()

◆ sysInitialize()

◆ sysStart()

◆ toDataType()

◆ updateVHKA()

◆ zdcCutValue()

◆ zdcE()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_trackSelectionTool

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_ZDCEt_UpperCut_4p0Sigma_NeNe

◆ m_ZDCEt_UpperCut_5p5Sigma_OO