#include <ClusterFilterTool.h>

Inheritance diagram for ClusterFilterTool:

Collaboration diagram for ClusterFilterTool:

Public Member Functions
	ClusterFilterTool (const std::string &, const std::string &, const IInterface *)
virtual	~ClusterFilterTool ()
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
bool	rejectCluster (const xAOD::CaloCluster &cluster) const final
	Method to check if a given cluster has to be rejected or not based on primary vertices requirements.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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
template<class T>
const T *	getContainer (const std::string &containerName) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_caloEntryMapName
ToolHandle< CP::ITrackVertexAssociationTool >	m_loosetrackvertexassoTool
std::string	m_trackParticleCollectionName
std::string	m_vertexCollectionName
double	m_coneSize
double	m_ptFractionPV0
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 21 of file ClusterFilterTool.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

◆ ClusterFilterTool()

ClusterFilterTool::ClusterFilterTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 12 of file ClusterFilterTool.cxx.

  : AthAlgTool(t,n,p),
  m_caloEntryMapName("ParticleToCaloExtensionMap"),
  m_loosetrackvertexassoTool("LooseTrackVertexAssociationTool")
{
  declareInterface<IClusterFilterTool>(this);
  declareProperty("LooseTrackVertexAssoTool",         m_loosetrackvertexassoTool                              );
  declareProperty("ParticleCaloEntryMapName",         m_caloEntryMapName                                      );
  declareProperty("TrackParticleContainerName",       m_trackParticleCollectionName = "InDetTrackParticles"   );
  declareProperty("VertexCollection",                 m_vertexCollectionName        = "PrimaryVertices"       );
  declareProperty("ConeSize",                         m_coneSize                    = 0.2                     );
  declareProperty("PtFractionAtPV0",                  m_ptFractionPV0               = 0.1                     );
}

◆ ~ClusterFilterTool()

ClusterFilterTool::~ClusterFilterTool ( )

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());
  }

◆ 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

◆ finalize()

StatusCode ClusterFilterTool::finalize ( )

virtual

Definition at line 34 of file ClusterFilterTool.cxx.

                                       {
  ATH_MSG_INFO ("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}

◆ getContainer()

template<class T>

const T * ClusterFilterTool::getContainer ( const std::string & containerName ) const

inlineprivate

Definition at line 57 of file ClusterFilterTool.h.

                                                                                    {
  const T * ptr = evtStore()->retrieve< const T >( containerName );
  if (!ptr) {
    ATH_MSG_WARNING("Container '"<<containerName<<"' could not be retrieved");
  }
  return ptr;
}

◆ initialize()

StatusCode ClusterFilterTool::initialize ( )

virtual

Definition at line 28 of file ClusterFilterTool.cxx.

                                         {
  ATH_MSG_INFO ("Initializing " << name() << "...");
  ATH_CHECK(m_loosetrackvertexassoTool.retrieve());
  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.

◆ interfaceID()

const InterfaceID & IClusterFilterTool::interfaceID ( )

inlinestaticinherited

Definition at line 31 of file IClusterFilterTool.h.

                                                          {
  return IID_IClusterFilterTool; 
}

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ 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.

◆ rejectCluster()

bool ClusterFilterTool::rejectCluster ( const xAOD::CaloCluster & cluster ) const

finalvirtual

Method to check if a given cluster has to be rejected or not based on primary vertices requirements.

Parameters

CaloCluster reference to the cluster

Returns: true if the cluster has been rejected

Implements IClusterFilterTool.

Definition at line 39 of file ClusterFilterTool.cxx.

                                                                          {
      
  // loop on all the tracks
  const auto *const allTracks   = getContainer<xAOD::TrackParticleContainer>(m_trackParticleCollectionName);
  if (not allTracks) {
    ATH_MSG_DEBUG ("No rejection applied... returning");
    return false;
  }
  
  const auto *const allVertices = getContainer<xAOD::VertexContainer>(m_vertexCollectionName);
  if (not allVertices) {
    ATH_MSG_DEBUG ("No rejection applied... returning");
    return false;
  }  
  
  bool matchedPV0 = false;
  bool matchedPVX  = false;
      
  for (const auto *const track : *allTracks) {
    // check compatibility with PVX where X>0
    // retrieve the caloExtensionContainer to get the track position at the calo entrance
    IParticleToCaloExtensionMap * caloExtensionMap = nullptr;
    if(evtStore()->retrieve(caloExtensionMap,m_caloEntryMapName).isFailure())
      ATH_MSG_WARNING( "Unable to retrieve " << m_caloEntryMapName << " will leak the ParticleCaloExtension" );
    const Trk::TrackParameters* pars = caloExtensionMap->readCaloEntry(track);
    if (not pars) {
      ATH_MSG_DEBUG( "Extrapolated parameters non existing --> No rejection applied... returning" );
      continue;
    }
    
    float eta = pars->position().eta();     
    float phi = pars->position().phi();
    
    float dPhi = P4Helpers::deltaPhi( cluster.phi(), phi);
    float dEta = cluster.eta()-eta;
    float dr2  = dPhi*dPhi+ dEta*dEta;
        
    // check if the track is matching the cluster
    if (dr2<m_coneSize*m_coneSize) {      
      if (allVertices && !allVertices->empty()) {
    if (m_loosetrackvertexassoTool->isCompatible(*track, *(allVertices->at(0)))) {
      ATH_MSG_DEBUG ("PV0 is matched");
      matchedPV0 = true;
    } else matchedPVX = true;
      } else {
    ATH_MSG_WARNING ("Vertex container " << m_vertexCollectionName << " is empty! Can't perform TVA! --> No rejection applied... returning");
    return false;
      }
    }
  }
      
  return not matchedPV0 and matchedPVX;
  
}

◆ 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();
  }

◆ 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.

◆ 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);
      }
    }
  }

Member Data Documentation

◆ m_caloEntryMapName

std::string ClusterFilterTool::m_caloEntryMapName

private

Definition at line 41 of file ClusterFilterTool.h.

◆ m_coneSize

double ClusterFilterTool::m_coneSize

private

Definition at line 49 of file ClusterFilterTool.h.

◆ 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_loosetrackvertexassoTool

ToolHandle<CP::ITrackVertexAssociationTool> ClusterFilterTool::m_loosetrackvertexassoTool

private

Definition at line 43 of file ClusterFilterTool.h.

◆ m_ptFractionPV0

double ClusterFilterTool::m_ptFractionPV0

private

Definition at line 52 of file ClusterFilterTool.h.

◆ m_trackParticleCollectionName

std::string ClusterFilterTool::m_trackParticleCollectionName

private

Definition at line 45 of file ClusterFilterTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexCollectionName

std::string ClusterFilterTool::m_vertexCollectionName

private

Definition at line 46 of file ClusterFilterTool.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ClusterFilterTool()

◆ ~ClusterFilterTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ getContainer()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ rejectCluster()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_caloEntryMapName

◆ m_coneSize

◆ m_detStore

◆ m_evtStore

◆ m_loosetrackvertexassoTool

◆ m_ptFractionPV0

◆ m_trackParticleCollectionName

◆ m_varHandleArraysDeclared

◆ m_vertexCollectionName

◆ m_vhka