Implementation for the photon vertex selection tool. More...

#include <PhotonVertexSelectionTool.h>

Inheritance diagram for CP::PhotonVertexSelectionTool:

Collaboration diagram for CP::PhotonVertexSelectionTool:

Public Types
enum	FailType { Unkown = -99, NoFail = 0, NoVxCont = 1, NoEventInfo = 2, FailPointing = 3, FailEgamVect = 4, NoGdCandidate = 5, MatchedTrack = 6 }
	Declare the interface that the class provides. More...

enum	yyVtxType { Unknown = -1, ConvTrack = 0, SiConvTrack = 1, NoSiTracks = 2 }

Public Member Functions
	PhotonVertexSelectionTool (const std::string &name)

virtual	~PhotonVertexSelectionTool ()

virtual void	print () const =0
	Print the state of the tool. More...

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Function(s) implementing the asg::IAsgTool interface
virtual StatusCode	initialize ()
	Function initialising the tool. More...

Function(s) implementing the IPhotonVertexSelectionTool interface
StatusCode	decorateInputs (const xAOD::EgammaContainer &egammas, FailType *failType=nullptr) const
	Given a list of photons, decorate vertex container with MVA variables. More...

StatusCode	getVertex (const xAOD::EgammaContainer &egammas, const xAOD::Vertex *&vertex, bool ignoreConv=false) const
	Given a list of photons, return the most likely vertex based on MVA likelihood. More...

std::vector< std::pair< const xAOD::Vertex *, float > >	getVertex (const xAOD::EgammaContainer &egammas, bool ignoreConv=false, bool noDecorate=false, yyVtxType vtxCase=nullptr, FailType failType=nullptr) const
	Given a list of photons, return the MLPs of all vertices in the event. More...

int	getCase () const
	Return the last case treated: More...

const xAOD::Vertex *	getPrimaryVertexFromConv (const xAOD::PhotonContainer *photons) const
	Get possible vertex directly associated with photon conversions. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
TLorentzVector	getEgammaVector (const xAOD::EgammaContainer *egammas, FailType &failType) const
	Get combined 4-vector of photon container. More...

StatusCode	getVertexImp (const xAOD::EgammaContainer &egammas, const xAOD::Vertex &vertex, bool ignoreConv, bool noDecorate, std::vector< std::pair< const xAOD::Vertex , float > > &, yyVtxType &, FailType &) const
	Given a list of photons, return the MLPs of all vertices in the event. More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Static Private Member Functions
static bool	sortMLP (const std::pair< const xAOD::Vertex , float > &a, const std::pair< const xAOD::Vertex , float > &b)
	Sort MLP results. More...

Private Attributes
std::string	m_configFileCase1
	Create a proper constructor for Athena. More...

std::string	m_configFileCase2

float	m_convPtCut

std::string	m_vertexContainerName

std::string	m_derivationPrefix

SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EventInfoContName", "EventInfo", "event info key"}

SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexContainer {this, "VertexContainer", "PrimaryVertices", "Vertex container name"}

std::unique_ptr< TMVA::Reader >	m_mva1
	MVA readers. More...

std::unique_ptr< TMVA::Reader >	m_mva2

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Implementation for the photon vertex selection tool.

Takes a list of photons (for example, to two leading photons) and the most likely primary vertex, based on an MVA.

Author: Christopher Meyer chris.nosp@m..mey.nosp@m.er@ce.nosp@m.rn.c.nosp@m.h; Bruno Lenzi bruno.nosp@m..len.nosp@m.zi@ce.nosp@m.rn.c.nosp@m.h

Definition at line 34 of file PhotonVertexSelectionTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ FailType

enum CP::IPhotonVertexSelectionTool::FailType

inherited

Declare the interface that the class provides.

enum indicating where the tool has failed

Enumerator
Unkown
NoFail
NoVxCont
NoEventInfo
FailPointing
FailEgamVect
NoGdCandidate
MatchedTrack

Definition at line 33 of file IPhotonVertexSelectionTool.h.

                   {
       Unkown        = -99,  // Init value
       NoFail        =   0,  // Ok to run the MVA algorithm
       NoVxCont      =   1,  // No vertex container
       NoEventInfo   =   2,  // No EventInfo
       FailPointing  =   3,  // Calo pointing failed
       FailEgamVect  =   4,  // No diphoton event
       NoGdCandidate =   5,  // Pointing succeded but too distant from any other vertex
       MatchedTrack  =   6,  // Conversion photon has a track attached to a primary/pileup vertex
     };

◆ yyVtxType

enum CP::IPhotonVertexSelectionTool::yyVtxType

inherited

Enumerator
Unknown
ConvTrack
SiConvTrack
NoSiTracks

Definition at line 44 of file IPhotonVertexSelectionTool.h.

                   {
       Unknown       =  -1,  // Init value
       ConvTrack     =   0,  // conv track associated to vertex,
       SiConvTrack   =   1,  // at least one conv track with Si hits, 
       NoSiTracks    =   2,  // no tracks with Si hits or conversions ignored
     };

Constructor & Destructor Documentation

◆ PhotonVertexSelectionTool()

CP::PhotonVertexSelectionTool::PhotonVertexSelectionTool ( const std::string & name )

Definition at line 54 of file PhotonVertexSelectionTool.cxx.

   : asg::AsgTool(name)
   {
     declareProperty("ConfigFileCase1",
         m_configFileCase1 = "PhotonVertexSelection/v1/DiphotonVertex_case1.weights.xml");
     declareProperty("ConfigFileCase2",
         m_configFileCase2 = "PhotonVertexSelection/v1/DiphotonVertex_case2.weights.xml");
     declareProperty("conversionPtCut", m_convPtCut = 2e3);
     declareProperty("derivationPrefix", m_derivationPrefix = "");
   }

◆ ~PhotonVertexSelectionTool()

CP::PhotonVertexSelectionTool::~PhotonVertexSelectionTool ( )

virtualdefault

Member Function Documentation

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	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());
  
   }

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ decorateInputs()

StatusCode CP::PhotonVertexSelectionTool::decorateInputs	(	const xAOD::EgammaContainer &	egammas,
		FailType *	failType = `nullptr`
	)		const

virtual

Given a list of photons, decorate vertex container with MVA variables.

Implements CP::IPhotonVertexSelectionTool.

Definition at line 99 of file PhotonVertexSelectionTool.cxx.

                                                                                                                   {
     auto fail = FailType::NoFail;
  
     static const SG::AuxElement::Decorator<float> sumPt2(m_derivationPrefix + "sumPt2");
     static const SG::AuxElement::Decorator<float> sumPt(m_derivationPrefix + "sumPt");
     static const SG::AuxElement::Decorator<float> deltaPhi(m_derivationPrefix + "deltaPhi");
     static const SG::AuxElement::Decorator<float> deltaZ(m_derivationPrefix + "deltaZ");
  
     // Get the EventInfo
     SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfo);
  
     // Find the common z-position from beam / photon pointing information
     std::pair<float, float> zCommon = xAOD::PVHelpers::getZCommonAndError(&*eventInfo, &egammas, m_convPtCut);
     // Vector sum of photons
     TLorentzVector vegamma = getEgammaVector(&egammas, fail);
  
     // Retrieve PV collection from TEvent
     SG::ReadHandle<xAOD::VertexContainer> vertices(m_vertexContainer);
  
     for (const xAOD::Vertex* vertex: *vertices) {
  
       // Skip dummy vertices
       if (vertex->vertexType() != xAOD::VxType::VertexType::PriVtx and
         vertex->vertexType() != xAOD::VxType::VertexType::PileUp) continue;
  
       // Set input variables for MVA
  
       if (not sumPt.isAvailable(*vertex)) {
         sumPt(*vertex) = xAOD::PVHelpers::getVertexSumPt(vertex, 1, false);
       }
  
       if (not sumPt2.isAvailable(*vertex)) {
         sumPt2(*vertex) = xAOD::PVHelpers::getVertexSumPt(vertex, 2);
       }
  
       // Get momentum vector of vertex
       TLorentzVector vmom = xAOD::PVHelpers::getVertexMomentum(vertex, true, m_derivationPrefix);
  
       deltaPhi(*vertex) = (fail != FailType::FailEgamVect) ? std::abs(vmom.DeltaPhi(vegamma)) : -999.;
       deltaZ(*vertex) = std::abs((zCommon.first - vertex->z())/zCommon.second);
  
     } // loop over vertices
  
     ATH_MSG_DEBUG("DecorateInputs exit code "<< fail);
     if(failType!=nullptr)
       *failType = fail;
     return StatusCode::SUCCESS;
   }

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

◆ evtStore() [1/2]

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

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ 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

◆ getCase()

int CP::PhotonVertexSelectionTool::getCase ( ) const

inlinevirtual

Return the last case treated:

Implements CP::IPhotonVertexSelectionTool.

Definition at line 94 of file PhotonVertexSelectionTool.h.

94 { return -1; }

◆ getEgammaVector()

TLorentzVector CP::PhotonVertexSelectionTool::getEgammaVector	(	const xAOD::EgammaContainer *	egammas,
		FailType &	failType
	)		const

private

Get combined 4-vector of photon container.

Definition at line 360 of file PhotonVertexSelectionTool.cxx.

   {
     TLorentzVector v, v1;
     const xAOD::CaloCluster *cluster = nullptr;
     for (const xAOD::Egamma* egamma: *egammas) {
       if (egamma == nullptr) {
         ATH_MSG_DEBUG("No egamma object to get four vector");
         failType = FailType::FailEgamVect;
         continue;
       }
       cluster = egamma->caloCluster();
       if (cluster == nullptr) {
         ATH_MSG_WARNING("No cluster associated to egamma, not adding to 4-vector.");
         continue;
       }
  
       v1.SetPtEtaPhiM(egamma->e()/cosh(cluster->etaBE(2)),
                       cluster->etaBE(2),
                       cluster->phiBE(2),
                       0.0);
       v += v1;
     }
     return v;
   }

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

◆ getPrimaryVertexFromConv()

const xAOD::Vertex * CP::PhotonVertexSelectionTool::getPrimaryVertexFromConv ( const xAOD::PhotonContainer * photons ) const

virtual

Get possible vertex directly associated with photon conversions.

Implements CP::IPhotonVertexSelectionTool.

Definition at line 306 of file PhotonVertexSelectionTool.cxx.

   {
     if (photons == nullptr) {
       ATH_MSG_WARNING("Passed nullptr photon container, returning nullptr vertex from getPrimaryVertexFromConv");
       return nullptr;
     }
  
     std::vector<const xAOD::Vertex*> vertices;
     const xAOD::Vertex *conversionVertex = nullptr, *primary = nullptr;
     const xAOD::TrackParticle *tp = nullptr;
     size_t NumberOfTracks = 0;
  
     // Retrieve PV collection from TEvent
     SG::ReadHandle<xAOD::VertexContainer> all_vertices(m_vertexContainer);
  
  
     for (const auto *photon: *photons) {
       conversionVertex = photon->vertex();
       if (conversionVertex == nullptr) continue;
  
       NumberOfTracks = conversionVertex->nTrackParticles();
       for (size_t i = 0; i < NumberOfTracks; ++i) {
         // Get trackParticle in GSF collection
         const auto *gsfTp = conversionVertex->trackParticle(i);
         if (gsfTp == nullptr) continue;
         if (!xAOD::PVHelpers::passConvSelection(*conversionVertex, i, m_convPtCut)) continue;
  
         // Get trackParticle in InDet collection
         tp = xAOD::EgammaHelpers::getOriginalTrackParticleFromGSF(gsfTp);
         if (tp == nullptr) continue;
  
         primary = getVertexFromTrack(tp, &*all_vertices);
         if (primary == nullptr) continue;
  
         if (primary->vertexType() == xAOD::VxType::VertexType::PriVtx ||
             primary->vertexType() == xAOD::VxType::VertexType::PileUp) {
           if (std::find(vertices.begin(), vertices.end(), primary) == vertices.end()) {
             vertices.push_back(primary);
             continue;
           }
         }
       }
     }
  
     if (!vertices.empty()) {
       if (vertices.size() > 1)
         ATH_MSG_WARNING("Photons associated to different vertices! Returning lead photon association.");
       return vertices[0];
     }
  
     return nullptr;
   }

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ getVertex() [1/2]

std::vector< std::pair< const xAOD::Vertex *, float > > CP::PhotonVertexSelectionTool::getVertex	(	const xAOD::EgammaContainer &	egammas,
		bool	ignoreConv = `false`,
		bool	noDecorate = `false`,
		yyVtxType *	vtxCase = `nullptr`,
		FailType *	failType = `nullptr`
	)		const

virtual

Given a list of photons, return the MLPs of all vertices in the event.

Implements CP::IPhotonVertexSelectionTool.

Definition at line 150 of file PhotonVertexSelectionTool.cxx.

   {
     const xAOD::Vertex *vertex = nullptr;
     std::vector<std::pair<const xAOD::Vertex*, float> > vertexMLP;
     yyVtxType vtxCase = yyVtxType::Unknown;
     FailType failType = FailType::NoFail;
     if (getVertexImp( egammas, vertex, ignoreConv, noDecorate, vertexMLP, vtxCase, failType ).isSuccess()) {
       std::sort(vertexMLP.begin(), vertexMLP.end(), sortMLP);
     }
     if(vtxCasePtr!=nullptr)
       *vtxCasePtr = vtxCase;
     if(failTypePtr!=nullptr)
       *failTypePtr = failType;
  
     return vertexMLP;
   }

◆ getVertex() [2/2]

StatusCode CP::PhotonVertexSelectionTool::getVertex	(	const xAOD::EgammaContainer &	egammas,
		const xAOD::Vertex *&	vertex,
		bool	ignoreConv = `false`
	)		const

virtual

Given a list of photons, return the most likely vertex based on MVA likelihood.

Implements CP::IPhotonVertexSelectionTool.

Definition at line 168 of file PhotonVertexSelectionTool.cxx.

   {
     std::vector<std::pair<const xAOD::Vertex*, float> > vertexMLP;
     yyVtxType vtxcase = yyVtxType::Unknown;
     FailType failType = FailType::NoFail;
     return getVertexImp( egammas, prime_vertex, ignoreConv, false, vertexMLP, vtxcase, failType );
   }

◆ getVertexImp()

StatusCode CP::PhotonVertexSelectionTool::getVertexImp	(	const xAOD::EgammaContainer &	egammas,
		const xAOD::Vertex *&	vertex,
		bool	ignoreConv,
		bool	noDecorate,
		std::vector< std::pair< const xAOD::Vertex *, float > > &	vertexMLP,
		yyVtxType &	vtxCase,
		FailType &	fail
	)		const

private

Given a list of photons, return the MLPs of all vertices in the event.

Definition at line 178 of file PhotonVertexSelectionTool.cxx.

   {
     vtxCase = yyVtxType::Unknown;
     const xAOD::PhotonContainer *photons = dynamic_cast<const xAOD::PhotonContainer*>(&egammas);
  
     // Retrieve PV collection from TEvent
     SG::ReadHandle<xAOD::VertexContainer> vertices(m_vertexContainer);
  
  
     if (!noDecorate && !decorateInputs(egammas).isSuccess()){
       return StatusCode::FAILURE;
     }
  
  
     // Check if a conversion photon has a track attached to a primary/pileup vertex
     if (!ignoreConv && photons) {
       prime_vertex = getPrimaryVertexFromConv(photons);
       if (prime_vertex != nullptr) {
         vtxCase = yyVtxType::ConvTrack;
         fail = FailType::MatchedTrack;
         vertexMLP.emplace_back(prime_vertex, 0.);
         return StatusCode::SUCCESS;
       }
     }
  
     if (fail != FailType::NoFail){
       ATH_MSG_VERBOSE("Returning hardest vertex. Fail detected (type="<< fail <<")");
       vertexMLP.clear();
       vertexMLP.emplace_back(xAOD::PVHelpers::getHardestVertex(&*vertices), 10.);
       return StatusCode::SUCCESS;
     }
  
  
     // Get the EventInfo
     SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfo);
  
     // If there are any silicon conversions passing selection, use MVA1
     TMVA::Reader *reader = m_mva2.get();
     vtxCase = yyVtxType::NoSiTracks;
     if (!ignoreConv && photons) {
       for (const auto *photon: *photons) {
         if (!photon)
         {
           ATH_MSG_WARNING("Null pointer to photon");
           return StatusCode::FAILURE;
         }
         if (xAOD::PVHelpers::passConvSelection(photon,
                                                m_convPtCut))
         {
           reader = m_mva1.get();
           vtxCase = yyVtxType::SiConvTrack;
         }
       }
     }
     ATH_MSG_DEBUG("Vtx Case: " << vtxCase);
  
     // Vector sum of photons
     TLorentzVector vegamma = getEgammaVector(&egammas, fail);
  
     SG::AuxElement::ConstAccessor<float> sumPtA(m_derivationPrefix + "sumPt");
     SG::AuxElement::ConstAccessor<float> sumPt2A(m_derivationPrefix + "sumPt2");
     SG::AuxElement::ConstAccessor<float> deltaPhiA(m_derivationPrefix + "deltaPhi");
     SG::AuxElement::ConstAccessor<float> deltaZA(m_derivationPrefix + "deltaZ");
  
     // Loop over vertices and find best candidate
     float mlp = 0.0, mlp_max = -99999.0;
     for (const xAOD::Vertex* vertex: *vertices) {
  
       // Skip dummy vertices
       if (vertex->vertexType() != xAOD::VxType::VertexType::PriVtx and
           vertex->vertexType() != xAOD::VxType::VertexType::PileUp) continue;
  
       // Variables used as input into TMVA::Reader
       float sumPt2, sumPt, deltaPhi, deltaZ;
  
       sumPt     = log10((sumPtA)(*vertex));
       sumPt2    = log10((sumPt2A)(*vertex));
       deltaPhi  = (deltaPhiA)(*vertex);
       deltaZ    = (deltaZA)(*vertex);
       ATH_MSG_VERBOSE("log(sumPt): " << sumPt <<
                       " log(sumPt2): " << sumPt2 <<
                       " deltaPhi: " << deltaPhi <<
                       " deltaZ: " << deltaZ);
  
       // Skip vertices above 10 sigma from pointing or 15 sigma from conversion (HPV)
       if ((reader == m_mva2.get() && deltaZ > 10) ||
           (reader == m_mva1.get() && deltaZ > 15)) {
         mlp = -9999.0;
       } else {
         // Get likelihood probability from MVA
         std::vector<float> mvaInput = {deltaZ,deltaPhi,sumPt,sumPt2};
         TString mvaMethod("MLP method");
         mlp = reader->EvaluateMVA(mvaInput,mvaMethod);
       }
       ATH_MSG_VERBOSE("MVA output: "  << (reader == m_mva1.get() ? "MVA1 ": "MVA2 ")<< mlp);
  
       vertexMLP.emplace_back(vertex, mlp);
  
       // Keep track of maximal likelihood vertex
       if (mlp > mlp_max) {
         mlp_max = mlp;
         prime_vertex = vertex;
       }
  
     } // loop over vertices
  
     if (mlp_max <= -9999.0) {
       ATH_MSG_DEBUG("No good vertex candidates from pointing, returning hardest vertex.");
       prime_vertex = xAOD::PVHelpers::getHardestVertex(&*vertices);
       fail = FailType::NoGdCandidate;
       vertexMLP.clear();
       vertexMLP.emplace_back(xAOD::PVHelpers::getHardestVertex(&*vertices), 20.);
     }
  
     ATH_MSG_VERBOSE("getVertex case "<< (int)vtxCase << " exit code "<< (int)fail);
     return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode CP::PhotonVertexSelectionTool::initialize ( )

virtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

Definition at line 70 of file PhotonVertexSelectionTool.cxx.

   {
     ATH_MSG_INFO("Initializing PhotonVertexSelectionTool...");
  
     // Get full path of configuration files for MVA
     m_configFileCase1  = PathResolverFindCalibFile( m_configFileCase1 );
     m_configFileCase2  = PathResolverFindCalibFile( m_configFileCase2 );
  
     // Setup MVAs
     std::vector<std::string> var_names = { "deltaZ := TMath::Min(abs(PrimaryVerticesAuxDyn.z-zCommon)/zCommonError,20)",
                                            "deltaPhi := abs(deltaPhi(PrimaryVerticesAuxDyn.phi,egamma_phi))"           ,
                                            "logSumpt := log10(PrimaryVerticesAuxDyn.sumPt)"                            ,
                                            "logSumpt2 := log10(PrimaryVerticesAuxDyn.sumPt2)" };
  
     auto *mva1 = new TMVA::Reader(var_names, "!Silent:Color");
     mva1->BookMVA    ("MLP method"                                                                , m_configFileCase1 );
     m_mva1 = std::unique_ptr<TMVA::Reader>( mva1 );
  
     auto mva2 = std::make_unique<TMVA::Reader>(var_names, "!Silent:Color");
     mva2->BookMVA    ("MLP method"                                                                , m_configFileCase2);
     m_mva2 = std::unique_ptr<TMVA::Reader>( std::move(mva2) );
  
     ATH_CHECK( m_eventInfo.initialize() );
     ATH_CHECK( m_vertexContainer.initialize() );
  
     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() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

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

◆ 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() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

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

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

◆ sortMLP()

bool CP::PhotonVertexSelectionTool::sortMLP	(	const std::pair< const xAOD::Vertex *, float > &	a,
		const std::pair< const xAOD::Vertex *, float > &	b
	)

staticprivate

Sort MLP results.

Definition at line 301 of file PhotonVertexSelectionTool.cxx.

303 { return a.second > b.second; }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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

std::string CP::PhotonVertexSelectionTool::m_configFileCase1

private

Create a proper constructor for Athena.

Configuration variables

Definition at line 42 of file PhotonVertexSelectionTool.h.

◆ m_configFileCase2

std::string CP::PhotonVertexSelectionTool::m_configFileCase2

private

Definition at line 43 of file PhotonVertexSelectionTool.h.

◆ m_convPtCut

float CP::PhotonVertexSelectionTool::m_convPtCut

private

Definition at line 44 of file PhotonVertexSelectionTool.h.

◆ m_derivationPrefix

std::string CP::PhotonVertexSelectionTool::m_derivationPrefix

private

Definition at line 46 of file PhotonVertexSelectionTool.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_eventInfo

SG::ReadHandleKey<xAOD::EventInfo> CP::PhotonVertexSelectionTool::m_eventInfo {this, "EventInfoContName", "EventInfo", "event info key"}

private

Definition at line 48 of file PhotonVertexSelectionTool.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_mva1

std::unique_ptr<TMVA::Reader> CP::PhotonVertexSelectionTool::m_mva1

private

MVA readers.

Definition at line 53 of file PhotonVertexSelectionTool.h.

◆ m_mva2

std::unique_ptr<TMVA::Reader> CP::PhotonVertexSelectionTool::m_mva2

private

Definition at line 54 of file PhotonVertexSelectionTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer

SG::ReadHandleKey<xAOD::VertexContainer> CP::PhotonVertexSelectionTool::m_vertexContainer {this, "VertexContainer", "PrimaryVertices", "Vertex container name"}

private

Definition at line 49 of file PhotonVertexSelectionTool.h.

◆ m_vertexContainerName

std::string CP::PhotonVertexSelectionTool::m_vertexContainerName

private

Definition at line 45 of file PhotonVertexSelectionTool.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 Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ FailType

◆ yyVtxType

Constructor & Destructor Documentation

◆ PhotonVertexSelectionTool()

◆ ~PhotonVertexSelectionTool()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ decorateInputs()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getCase()

◆ getEgammaVector()

◆ getKey()

◆ getName()

◆ getPrimaryVertexFromConv()

◆ getProperty()

◆ getVertex() [1/2]

◆ getVertex() [2/2]

◆ getVertexImp()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ sortMLP()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_configFileCase1

◆ m_configFileCase2

◆ m_convPtCut

◆ m_derivationPrefix

◆ m_detStore

◆ m_eventInfo

◆ m_evtStore

◆ m_mva1

◆ m_mva2

◆ m_varHandleArraysDeclared

◆ m_vertexContainer

◆ m_vertexContainerName

◆ m_vhka