ATLAS Offline Software
Public Types | Public Member Functions | List of all members
CP::IPhotonVertexSelectionTool Class Referenceabstract

#include <IPhotonVertexSelectionTool.h>

Inheritance diagram for CP::IPhotonVertexSelectionTool:
Collaboration diagram for CP::IPhotonVertexSelectionTool:

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

virtual StatusCode decorateInputs (const xAOD::EgammaContainer &egammas, FailType *failType=nullptr) const =0
 Given a list of photons, decorate vertex container with MVA variables. More...
 
virtual StatusCode getVertex (const xAOD::EgammaContainer &egammas, const xAOD::Vertex *&vertex, bool ignoreConv=false) const =0
 Given a list of photons, return the most likely vertex based on MVA likelihood. More...
 
virtual 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 =0
 Given a list of photons, return the MLPs of all vertices in the event sorted in descending order. More...
 
virtual int getCase () const =0
 Return the last case treated: 0=conv track associated to vertex, 1=at least one conv track with Si hits, 2=no tracks with Si hits or conversions ignored. More...
 
virtual const xAOD::VertexgetPrimaryVertexFromConv (const xAOD::PhotonContainer *photons) const =0
 Get possible vertex directly associated with photon conversions. More...
 
virtual void print () const =0
 Print the state of the tool. More...
 

Detailed Description

Definition at line 26 of file IPhotonVertexSelectionTool.h.

Member Enumeration Documentation

◆ FailType

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.

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

◆ yyVtxType

Enumerator
Unknown 
ConvTrack 
SiConvTrack 
NoSiTracks 

Definition at line 44 of file IPhotonVertexSelectionTool.h.

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

Member Function Documentation

◆ decorateInputs()

virtual StatusCode CP::IPhotonVertexSelectionTool::decorateInputs ( const xAOD::EgammaContainer egammas,
FailType failType = nullptr 
) const
pure virtual

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

Implemented in CP::PhotonVertexSelectionTool.

◆ getCase()

virtual int CP::IPhotonVertexSelectionTool::getCase ( ) const
pure virtual

Return the last case treated: 0=conv track associated to vertex, 1=at least one conv track with Si hits, 2=no tracks with Si hits or conversions ignored.

Implemented in CP::PhotonVertexSelectionTool.

◆ getPrimaryVertexFromConv()

virtual const xAOD::Vertex* CP::IPhotonVertexSelectionTool::getPrimaryVertexFromConv ( const xAOD::PhotonContainer photons) const
pure virtual

Get possible vertex directly associated with photon conversions.

Implemented in CP::PhotonVertexSelectionTool.

◆ getVertex() [1/2]

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

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

Implemented in CP::PhotonVertexSelectionTool.

◆ getVertex() [2/2]

virtual StatusCode CP::IPhotonVertexSelectionTool::getVertex ( const xAOD::EgammaContainer egammas,
const xAOD::Vertex *&  vertex,
bool  ignoreConv = false 
) const
pure virtual

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

Implemented in CP::PhotonVertexSelectionTool.

◆ print()

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

The documentation for this class was generated from the following file:
CP::IPhotonVertexSelectionTool::Unkown
@ Unkown
Definition: IPhotonVertexSelectionTool.h:34
CP::IPhotonVertexSelectionTool::FailPointing
@ FailPointing
Definition: IPhotonVertexSelectionTool.h:38
CP::IPhotonVertexSelectionTool::NoSiTracks
@ NoSiTracks
Definition: IPhotonVertexSelectionTool.h:48
CP::IPhotonVertexSelectionTool::Unknown
@ Unknown
Definition: IPhotonVertexSelectionTool.h:45
CP::IPhotonVertexSelectionTool::NoEventInfo
@ NoEventInfo
Definition: IPhotonVertexSelectionTool.h:37
CP::IPhotonVertexSelectionTool::SiConvTrack
@ SiConvTrack
Definition: IPhotonVertexSelectionTool.h:47
CP::IPhotonVertexSelectionTool::NoGdCandidate
@ NoGdCandidate
Definition: IPhotonVertexSelectionTool.h:40
CP::IPhotonVertexSelectionTool::NoVxCont
@ NoVxCont
Definition: IPhotonVertexSelectionTool.h:36
CP::IPhotonVertexSelectionTool::MatchedTrack
@ MatchedTrack
Definition: IPhotonVertexSelectionTool.h:41
CP::IPhotonVertexSelectionTool::ConvTrack
@ ConvTrack
Definition: IPhotonVertexSelectionTool.h:46
CP::IPhotonVertexSelectionTool::NoFail
@ NoFail
Definition: IPhotonVertexSelectionTool.h:35
CP::IPhotonVertexSelectionTool::FailEgamVect
@ FailEgamVect
Definition: IPhotonVertexSelectionTool.h:39