#include <SpclMcValidationTool.h>

Inheritance diagram for SpclMcValidationTool:

Collaboration diagram for SpclMcValidationTool:

Public Member Functions
	SpclMcValidationTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
virtual	~SpclMcValidationTool ()
	Destructor:
StatusCode	initialize ()
	Athena Algorithm's Hooks.
StatusCode	execute ()
StatusCode	finalize ()
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 ()
	Inline methods:

Protected Types
typedef ToolHandle< IIOMcAodTool >	McAodTool_t

Protected Member Functions
	SpclMcValidationTool ()
	Default constructor:
virtual StatusCode	initializeTool ()
	Non-const methods:
virtual StatusCode	finalizeTool ()
virtual StatusCode	executeTool ()
	Main method to perform the validation.
virtual StatusCode	executeTool (const McEventCollection refMcEvents, const TruthParticleContainer mcParts)
	Main method to perform the validation:
StatusCode	setupMcAodWriterTool ()
	Request pointers to the IIOMcAodTool to be able to write out TruthParticleContainer for further comparison (off-framework)
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.

Protected Attributes
StringProperty	m_mcEventsName
	Location of the reference McEventCollection.
StringProperty	m_truthParticlesName
	Location of the 'to-be-validated' TruthParticleContainer.
McAodTool_t	m_mcAodWriterTool
	Tool to write the TruthParticleContainer into a dedicated file.
unsigned int	m_nAnalysedEvents
	Counter of analysed events.

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
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 27 of file SpclMcValidationTool.h.

Member Typedef Documentation

◆ McAodTool_t

typedef ToolHandle<IIOMcAodTool> SpclMcValidationTool::McAodTool_t

protected

Definition at line 95 of file SpclMcValidationTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ SpclMcValidationTool() [1/2]

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

Constructor with parameters:

Public methods:

Constructors

Definition at line 31 of file SpclMcValidationTool.cxx.

                                                   : 
  TruthParticleValidationBaseTool( type, name, parent )
{
  //
  // Property declaration
  // 
  declareProperty( "McEvents",       
           m_mcEventsName = "GEN_AOD",
           "Name of the reference McEventCollection" );
 
  declareProperty( "TruthParticles", 
           m_truthParticlesName = "SpclMC",
           "Name of the 'to-be-validated' TruthParticleContainer" );
 
  declareProperty( "McAodWriterTool",
           m_mcAodWriterTool = McAodTool_t( "McAodWriterTool", this ),
           "Tool to write the TruthParticleContainer into a "
           "dedicated file" );
}

◆ ~SpclMcValidationTool()

SpclMcValidationTool::~SpclMcValidationTool ( )

virtual

Destructor:

Destructor.

Definition at line 55 of file SpclMcValidationTool.cxx.

{ 
  ATH_MSG_DEBUG("Calling destructor");
}

◆ SpclMcValidationTool() [2/2]

SpclMcValidationTool::SpclMcValidationTool ( )

protected

Default constructor:

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

◆ execute()

StatusCode TruthParticleValidationBaseTool::execute ( )

virtualinherited

Implements ITruthParticleValidationTool.

Definition at line 78 of file TruthParticleValidationBaseTool.cxx.

{
  ++m_nAnalysedEvents;
  return executeTool();
}

◆ executeTool() [1/2]

StatusCode SpclMcValidationTool::executeTool ( )

protectedvirtual

Main method to perform the validation.

Just a wrapper around the more API-detailed method.

Implements TruthParticleValidationBaseTool.

Definition at line 82 of file SpclMcValidationTool.cxx.

{
  // retrieve McEventCollection
  const McEventCollection * mcEvents = nullptr;
  if ( evtStore()->retrieve( mcEvents, m_mcEventsName ).isFailure() ||
       nullptr == mcEvents ) {
    ATH_MSG_ERROR("Could not retrieve McEventCollection at ["
          << m_mcEventsName << "] !!");
    return StatusCode::FAILURE;
  } else {
    ATH_MSG_VERBOSE("Successfully retrieved McEventCollection at ["
            << m_mcEventsName << "]");
  }
 
  // retrieve TruthParticleContainer
  const TruthParticleContainer * mcParts = nullptr;
  if ( evtStore()->retrieve( mcParts, m_truthParticlesName ).isFailure() ||
       nullptr == mcParts ) {
    ATH_MSG_ERROR("Could not retrieve TruthParticleContainer at ["
          << m_truthParticlesName << "] !!");
    return StatusCode::FAILURE;
  } else {
    ATH_MSG_VERBOSE("Successfully TruthParticleContainer at ["
            << m_truthParticlesName << "]");
  }
 
  return executeTool( mcEvents, mcParts );
}

◆ executeTool() [2/2]

StatusCode SpclMcValidationTool::executeTool	(	const McEventCollection *	refMcEvents,
		const TruthParticleContainer *	mcParts )

protectedvirtual

Main method to perform the validation:

check that each vertex is identical to the original one

Definition at line 112 of file SpclMcValidationTool.cxx.

{
  if ( nullptr == mcEvents ) {
    ATH_MSG_ERROR("NULL pointer to reference McEventCollection !!");
    return StatusCode::FAILURE;
  }
 
  if ( nullptr == mcParts ) {
    ATH_MSG_ERROR("NULL pointer to the 'to-be-validated' "\
          "TruthParticleContainer !!");
    return StatusCode::FAILURE;
  }
 
  if ( mcEvents->empty() ) {
    ATH_MSG_WARNING("Empty McEventCollection !");
    return mcParts->empty() ? StatusCode::SUCCESS : StatusCode::FAILURE;
  }
 
  const HepMC::GenEvent * genEvt = (*mcEvents)[0];
  if ( nullptr == genEvt ) {
    ATH_MSG_ERROR("NULL pointer to reference GenEvent !!");
    return StatusCode::FAILURE;
  }
 
  int particles_size=genEvt->particles_size();
  if ( static_cast<int>( mcParts->size() ) != particles_size ) {
    ATH_MSG_ERROR("TruthParticleContainer and McEventCollection don't have "\
          "the same number of particles !!" << endmsg
          << "\tTruthParticleContainer: " << mcParts->size() << endmsg
          << "\tHepMC::GenEvent:        " << particles_size);
    return StatusCode::FAILURE;
  }
 
  if ( !m_mcAodWriterTool->execute().isSuccess() ) {
    ATH_MSG_WARNING("Could NOT write out the TruthParticleContainer through the IIOMcAodTool !!");
  }
 
  const TruthParticleContainer::const_iterator itrEnd  = mcParts->end();
  for ( TruthParticleContainer::const_iterator itrPart = mcParts->begin();
    itrPart != itrEnd;
    ++itrPart ) {
    const TruthParticle * mc = *itrPart;
    auto hepMc = mc->genParticle();
 
    if ( hepMc->momentum() != HepMC::FourVector(mc->hlv().x(),mc->hlv().y(),mc->hlv().z(),mc->hlv().t()) ) {
      ATH_MSG_ERROR("TruthParticle and GenParticle-link don't have same 4-mom !!");
      return StatusCode::FAILURE;
    }
 
    auto genPart = HepMC::barcode_to_particle(genEvt,HepMC::barcode(hepMc));
 
    if ( hepMc->momentum() != genPart->momentum() ) {
      ATH_MSG_ERROR("GenParticle-link and GenParticle from McEvtColl "\
            "don't have same 4-mom !!");
      return StatusCode::FAILURE;
    }
 
    
  }
  return StatusCode::SUCCESS;
}

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

virtualinherited

Implements ITruthParticleValidationTool.

Definition at line 64 of file TruthParticleValidationBaseTool.cxx.

{
  ATH_MSG_INFO("Finalizing " << name() << "...");
  ATH_MSG_INFO("Analysed [" << m_nAnalysedEvents << "] events.");
 
  // Give the concrete (derived) tool a chance to finalize itself
  if ( finalizeTool().isFailure() ) {
    ATH_MSG_ERROR("Could not finalize concrete tool !");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ finalizeTool()

StatusCode SpclMcValidationTool::finalizeTool ( )

protectedvirtual

Reimplemented from TruthParticleValidationBaseTool.

Definition at line 76 of file SpclMcValidationTool.cxx.

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

◆ initialize()

StatusCode TruthParticleValidationBaseTool::initialize ( )

virtualinherited

Athena Algorithm's Hooks.

Implements ITruthParticleValidationTool.

Definition at line 49 of file TruthParticleValidationBaseTool.cxx.

{
  ATH_MSG_INFO("Initializing " << name() << "...");
 
  // Give the concrete (derived) tool a chance to initialize itself
  if ( initializeTool().isFailure() ) {
    ATH_MSG_ERROR("Could not initialize concrete tool !");
    return StatusCode::FAILURE;
  }
 
  // initializing the event counter
  m_nAnalysedEvents = 0;
  return StatusCode::SUCCESS;
}

◆ initializeTool()

StatusCode SpclMcValidationTool::initializeTool ( )

protectedvirtual

Non-const methods:

Reimplemented from TruthParticleValidationBaseTool.

Definition at line 64 of file SpclMcValidationTool.cxx.

{
  ATH_MSG_INFO("Initializing " << name() << "...");
  // retrieve and configure McAod writer tool
  if ( setupMcAodWriterTool().isFailure() ) {
    ATH_MSG_ERROR("Could not configure the McAod writer tools !!");
    return StatusCode::FAILURE;
  }
 
  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 & ITruthParticleValidationTool::interfaceID ( )

inlinestaticinherited

Inline methods:

Definition at line 65 of file ITruthParticleValidationTool.h.

{ 
   return IID_ITruthParticleValidationTool; 
}

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

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

◆ setupMcAodWriterTool()

StatusCode SpclMcValidationTool::setupMcAodWriterTool ( )

protected

Request pointers to the IIOMcAodTool to be able to write out TruthParticleContainer for further comparison (off-framework)

Definition at line 175 of file SpclMcValidationTool.cxx.

{
  if ( !m_mcAodWriterTool.retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Creation of algTool [" 
          << m_mcAodWriterTool.type() << "/"
          //<< m_mcAodWriterTool.name() 
          << "] FAILED !");
    return StatusCode::FAILURE;
  }
 
  // now we configure the tools
  StringProperty prop( "TruthParticles", m_truthParticlesName.value() );
  if ( m_mcAodWriterTool->setProperty( prop ).isFailure() ) {
    ATH_MSG_ERROR("Could not set property [" << prop.name() << "] for tool ["
          << m_mcAodWriterTool.type() << "/"
          //<< m_mcAodWriterTool.name() 
          << "] !!");
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

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

McAodTool_t SpclMcValidationTool::m_mcAodWriterTool

protected

Tool to write the TruthParticleContainer into a dedicated file.

Definition at line 99 of file SpclMcValidationTool.h.

◆ m_mcEventsName

StringProperty SpclMcValidationTool::m_mcEventsName

protected

Location of the reference McEventCollection.

Definition at line 89 of file SpclMcValidationTool.h.

◆ m_nAnalysedEvents

unsigned int TruthParticleValidationBaseTool::m_nAnalysedEvents

protectedinherited

Counter of analysed events.

Definition at line 75 of file TruthParticleValidationBaseTool.h.

◆ m_truthParticlesName

StringProperty SpclMcValidationTool::m_truthParticlesName

protected

Location of the 'to-be-validated' TruthParticleContainer.

Definition at line 93 of file SpclMcValidationTool.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 Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ McAodTool_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ SpclMcValidationTool() [1/2]

◆ ~SpclMcValidationTool()

◆ SpclMcValidationTool() [2/2]

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ executeTool() [1/2]

◆ executeTool() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ finalizeTool()

◆ initialize()

◆ initializeTool()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setupMcAodWriterTool()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_mcAodWriterTool

◆ m_mcEventsName

◆ m_nAnalysedEvents

◆ m_truthParticlesName

◆ m_varHandleArraysDeclared

◆ m_vhka