modular concept to define certain categories of truth particles, this one labels primary, secondary and truncated tracks. More...

#include <PrimaryTruthClassifier.h>

Inheritance diagram for Trk::PrimaryTruthClassifier:

Collaboration diagram for Trk::PrimaryTruthClassifier:

Public Member Functions
	PrimaryTruthClassifier (const std::string &type, const std::string &name, const IInterface *parent)
	~PrimaryTruthClassifier ()
virtual StatusCode	initialize ()
	initialize
virtual StatusCode	finalize ()
virtual void	initClassification (const McEventCollection &, const std::vector< HepMC::ConstGenParticlePtr > *) const
	explain
virtual unsigned int	classify (HepMC::ConstGenParticlePtr) const
virtual std::string	nameOfClassifier () const
virtual std::string	classificationAsString (unsigned int) const
virtual unsigned int	numberOfClassifiers () const
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 ()
	Interface ID, declared here, and defined below.

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

Private Attributes
float	m_maxRStartPrimary
	Max R of start vertex to be considered primary.
float	m_maxZStartPrimary
	Max Z of start vertex to be considered primary.
float	m_minREndPrimary
	If track has end vertex, this is min R of end vertex to be considered primary.
float	m_minZEndPrimary
	If track has end vertex, this is min Z of end vertex to be considered primary.
float	m_maxRStartSecondary
float	m_maxZStartSecondary
float	m_minREndSecondary
float	m_minZEndSecondary
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

modular concept to define certain categories of truth particles, this one labels primary, secondary and truncated tracks.

Author: Sebastian.Fleischmann -at- cern.ch, Wolfgang.Liebig -at- cern.ch

Definition at line 32 of file PrimaryTruthClassifier.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

◆ PrimaryTruthClassifier()

Trk::PrimaryTruthClassifier::PrimaryTruthClassifier	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 17 of file PrimaryTruthClassifier.cxx.

  : AthAlgTool                    (type,name,parent),
    m_maxRStartPrimary         (  25.0*CLHEP::mm),
    m_maxZStartPrimary         ( 200.0*CLHEP::mm),
    m_minREndPrimary           ( 400.0*CLHEP::mm),
    m_minZEndPrimary           (2300.0*CLHEP::mm),
    m_maxRStartSecondary       ( 360.0*CLHEP::mm),
    m_maxZStartSecondary       (2000.0*CLHEP::mm),
    m_minREndSecondary         (1000.0*CLHEP::mm),
    m_minZEndSecondary         (3200.0*CLHEP::mm)
{
  declareInterface<ITrackTruthClassifier>(this);
 
  declareProperty("maxRStartPrimary",   m_maxRStartPrimary);
  declareProperty("maxZStartPrimary",   m_maxZStartPrimary);
  declareProperty("minREndPrimary",      m_minREndPrimary);
  declareProperty("minZEndPrimary",      m_minZEndPrimary);
  declareProperty("maxRStartSecondary", m_maxRStartSecondary);
  declareProperty("maxZStartSecondary", m_maxZStartSecondary);
  declareProperty("minREndSecondary",    m_minREndSecondary);
  declareProperty("minZEndSecondary",    m_minZEndSecondary);
 
}

◆ ~PrimaryTruthClassifier()

Trk::PrimaryTruthClassifier::~PrimaryTruthClassifier ( )

inline

Definition at line 38 of file PrimaryTruthClassifier.h.

38{}

Member Function Documentation

◆ classificationAsString()

std::string Trk::PrimaryTruthClassifier::classificationAsString ( unsigned int i ) const

inlinevirtual

Implements Trk::ITrackTruthClassifier.

Definition at line 76 of file PrimaryTruthClassifier.h.

                                                                                         {
    Trk::TruthClassification::PrimaryClassifierStrings PC;
    return PC.names[i];
  }

◆ classify()

unsigned int Trk::PrimaryTruthClassifier::classify ( HepMC::ConstGenParticlePtr genParticle ) const

virtual

Implements Trk::ITrackTruthClassifier.

Definition at line 64 of file PrimaryTruthClassifier.cxx.

                                                                                           {
 
 
  /* note on using HepMC::FourVector/3Vector against HepGeom::Point3D<double>: The versions from HepMC2 do not know
     operator+, operator- etc. */
 
    
  //classify as primary, secondary or truncated
  bool  primary=false;
  bool  secondary=false;
  bool  truncated=false;
 
  if (genParticle->production_vertex()) {
    HepMC::FourVector      startVertex = genParticle->production_vertex()->position();
 
    // primary vertex inside innermost layer?
    if ( fabs(startVertex.perp()) < m_maxRStartPrimary 
         && fabs(startVertex.z()) < m_maxZStartPrimary)
      {
        if (genParticle->end_vertex() == nullptr) {  
          primary=true;
        } else {
          HepMC::FourVector endVertex = genParticle->end_vertex()->position();
          if (  endVertex.perp()         > m_minREndPrimary 
                || fabs(startVertex.z()) > m_minZEndPrimary)
            primary=true; else truncated = true;
        }
      }
    else if ( startVertex.perp()    <  m_maxRStartSecondary && 
              fabs(startVertex.z()) <  m_maxZStartSecondary)
      {
        if (genParticle->end_vertex() == nullptr) {  
          secondary=true;
        } else {
          HepMC::FourVector endVertex = genParticle->end_vertex()->position();
          if (endVertex.perp()            > m_minREndSecondary
              || fabs(endVertex.z())      > m_minZEndSecondary) {
            secondary=true;
          }
        }
      }
  } //end classification
 
  if (truncated) return Trk::TruthClassification::Truncated;
  if (secondary) return Trk::TruthClassification::Secondary;
  if (primary) return Trk::TruthClassification::Primary;
  ATH_MSG_DEBUG ( "Could not classify this particle: " << genParticle );
  return Trk::TruthClassification::OutsideClassification;
 
}

◆ 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 Trk::PrimaryTruthClassifier::finalize ( )

virtual

Definition at line 49 of file PrimaryTruthClassifier.cxx.

                                               {
  ATH_MSG_INFO ("starting finalize() in " << name() );
  return StatusCode::SUCCESS;
}

◆ initClassification()

void Trk::PrimaryTruthClassifier::initClassification	(	const McEventCollection &	,
		const std::vector< HepMC::ConstGenParticlePtr > *	) const

virtual

explain

Implements Trk::ITrackTruthClassifier.

Definition at line 54 of file PrimaryTruthClassifier.cxx.

                                                     {
 
  // nothing to prepare as local data at start of collection analysis
  }

◆ initialize()

StatusCode Trk::PrimaryTruthClassifier::initialize ( )

virtual

initialize

Definition at line 44 of file PrimaryTruthClassifier.cxx.

                                                 {
    ATH_MSG_INFO ("initialise successful in "<<name() );
    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 & Trk::ITrackTruthClassifier::interfaceID ( )

inlinestaticinherited

Interface ID, declared here, and defined below.

Definition at line 48 of file ITrackTruthClassifier.h.

                                                                {
    return IID_ITrackTruthClassifier;
}

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

◆ nameOfClassifier()

std::string Trk::PrimaryTruthClassifier::nameOfClassifier ( ) const

inlinevirtual

Implements Trk::ITrackTruthClassifier.

Definition at line 72 of file PrimaryTruthClassifier.h.

                                                                     {
    return "reconstructableForInDet";
  }

◆ numberOfClassifiers()

unsigned int Trk::PrimaryTruthClassifier::numberOfClassifiers ( ) const

inlinevirtual

Implements Trk::ITrackTruthClassifier.

Definition at line 68 of file PrimaryTruthClassifier.h.

                                                                           {
    return Trk::TruthClassification::NumberOfPrimaryClassifiers;
  }

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

◆ 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_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_maxRStartPrimary

float Trk::PrimaryTruthClassifier::m_maxRStartPrimary

private

Max R of start vertex to be considered primary.

Definition at line 55 of file PrimaryTruthClassifier.h.

◆ m_maxRStartSecondary

float Trk::PrimaryTruthClassifier::m_maxRStartSecondary

private

Definition at line 61 of file PrimaryTruthClassifier.h.

◆ m_maxZStartPrimary

float Trk::PrimaryTruthClassifier::m_maxZStartPrimary

private

Max Z of start vertex to be considered primary.

Definition at line 56 of file PrimaryTruthClassifier.h.

◆ m_maxZStartSecondary

float Trk::PrimaryTruthClassifier::m_maxZStartSecondary

private

Definition at line 62 of file PrimaryTruthClassifier.h.

◆ m_minREndPrimary

float Trk::PrimaryTruthClassifier::m_minREndPrimary

private

If track has end vertex, this is min R of end vertex to be considered primary.

Definition at line 58 of file PrimaryTruthClassifier.h.

◆ m_minREndSecondary

float Trk::PrimaryTruthClassifier::m_minREndSecondary

private

Definition at line 63 of file PrimaryTruthClassifier.h.

◆ m_minZEndPrimary

float Trk::PrimaryTruthClassifier::m_minZEndPrimary

private

If track has end vertex, this is min Z of end vertex to be considered primary.

Definition at line 60 of file PrimaryTruthClassifier.h.

◆ m_minZEndSecondary

float Trk::PrimaryTruthClassifier::m_minZEndSecondary

private

Definition at line 64 of file PrimaryTruthClassifier.h.

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

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

◆ PrimaryTruthClassifier()

◆ ~PrimaryTruthClassifier()

Member Function Documentation

◆ classificationAsString()

◆ classify()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initClassification()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ nameOfClassifier()

◆ numberOfClassifiers()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_maxRStartPrimary

◆ m_maxRStartSecondary

◆ m_maxZStartPrimary

◆ m_maxZStartSecondary

◆ m_minREndPrimary

◆ m_minREndSecondary

◆ m_minZEndPrimary

◆ m_minZEndSecondary

◆ m_varHandleArraysDeclared

◆ m_vhka