#include <McAodValidationAlg.h>

Inheritance diagram for McAodValidationAlg:

Collaboration diagram for McAodValidationAlg:

Public Member Functions
	McAodValidationAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters:
virtual	~McAodValidationAlg ()
	Destructor:
virtual StatusCode	initialize () override
	Athena Algorithm's Hooks.
virtual StatusCode	execute () override
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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

Protected Types
typedef ToolHandleArray< ITruthParticleValidationTool >	IValidationTools_t

Protected Member Functions
	McAodValidationAlg ()
	Default constructor:
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
IValidationTools_t	m_valTools
	Validation tools to be ran on the events.
StringProperty	m_truthParticlesName
	Location of the TruthParticleContainer to read.
unsigned int	m_seed
	Random generator seed.

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
DataObjIDColl	m_extendedExtraObjects
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 24 of file McAodValidationAlg.h.

Member Typedef Documentation

◆ IValidationTools_t

typedef ToolHandleArray<ITruthParticleValidationTool> McAodValidationAlg::IValidationTools_t

protected

Definition at line 57 of file McAodValidationAlg.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ McAodValidationAlg() [1/2]

McAodValidationAlg::McAodValidationAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Constructor with parameters:

Public methods:

Constructors

Definition at line 41 of file McAodValidationAlg.cxx.

                                                                   : 
  AthAlgorithm( name, pSvcLocator ),
  m_valTools   ( this )
{
  //
  // Property declaration
  // 
  //declareProperty( "Property", m_nProperty );
 
  declareProperty( "ValidationTools", 
           m_valTools,
           "List of validation tools to be ran on the events" );
  // defaults
  m_valTools.push_back( "GenAodValidationTool/GenAodValidation" );
  m_valTools.push_back( "SpclMcValidationTool/SpclMcValidation" );
 
  declareProperty( "TruthParticles", 
           m_truthParticlesName = "SpclMC",
           "Name of the TruthParticleContainer to be read" );
  
  declareProperty( "Seed", 
           m_seed = 12345678,
           "Seed for the STL random generator" );
}

◆ ~McAodValidationAlg()

McAodValidationAlg::~McAodValidationAlg ( )

virtual

Destructor:

Destructor.

Definition at line 69 of file McAodValidationAlg.cxx.

70{}

◆ McAodValidationAlg() [2/2]

McAodValidationAlg::McAodValidationAlg ( )

protected

Default constructor:

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode McAodValidationAlg::execute ( )

overridevirtual

Definition at line 122 of file McAodValidationAlg.cxx.

{  
  ATH_MSG_DEBUG ("Executing " << name() << "...");
  //we don't care this is not crypto-strength random number generator
  //coverity[dont_call]
  const double random =  std::rand() * 1.;
  ATH_MSG_DEBUG ("Random= " << random);
  
  const TruthParticleContainer * mcParts = 0;
  if ( evtStore()->retrieve( mcParts, m_truthParticlesName ).isFailure() ||
       0 == mcParts ) {
    ATH_MSG_ERROR
      ("Could not retrieve the TruthParticleContainer at ["
       << m_truthParticlesName << "] !!");
    return StatusCode::FAILURE;
  }
  
  // test the symLink feature
  {
    const DataVector<INavigable4Momentum> * inav4mom = 0;
    if ( evtStore()->retrieve( inav4mom, m_truthParticlesName ).isFailure() ||
     0 == inav4mom ) {
      ATH_MSG_ERROR
    ("Could not retrieve the (auto-symlinked) DV<INav4Mom> at ["
     << m_truthParticlesName << "] !!");
    } else {
      ATH_MSG_DEBUG 
    ("Successfully exercised the auto-symlink feature "\
     "with [DV<INavigable4MomentumCollection>]");
    }
  }
 
  // test the symLink feature
  {
    const DataVector<IParticle> * ipc = 0;
    if ( evtStore()->retrieve( ipc, m_truthParticlesName ).isFailure() ||
     0 == ipc ) {
      ATH_MSG_ERROR
    ("Could not retrieve the (auto-symlinked) DV<IP> at ["
     << m_truthParticlesName << "] !!");
    } else {
      ATH_MSG_DEBUG 
    ("Successfully exercised the auto-symlink feature with [DV<IParticle>]");
    }
  }
 
  // test the symLink feature
  {
    const IParticleContainer * ipc = 0;
    if ( evtStore()->retrieve( ipc, m_truthParticlesName ).isFailure() ||
     0 == ipc ) {
      ATH_MSG_ERROR
    ("Could not retrieve the (auto-symlinked) IPC at ["
     << m_truthParticlesName << "] !!");
    } else {
      ATH_MSG_DEBUG 
    ("Successfully exercised the auto-symlink feature "\
     "with [IParticleContainer]");
    }
  }
 
  double eneSum = 0.;
  for ( TruthParticleContainer::const_iterator itr = mcParts->begin();
        itr != mcParts->end();
        ++itr ) {
    const TruthParticle * mc = *itr;
    eneSum += mc->e();
  }
  ATH_MSG_DEBUG ("Sum Ene= " << (eneSum * (1./CLHEP::GeV)));
 
  bool validationIsOK = true;
  ATH_MSG_DEBUG ("Checking the event with the validation AlgTools...");
 
  for ( IValidationTools_t::iterator 
      iTool = m_valTools.begin(),
      iEnd  = m_valTools.end();
    iTool != iEnd;
    ++iTool ) {
    ATH_MSG_DEBUG ("\tvalidation with [" << iTool->typeAndName() << "]...");
    if ( !(*iTool)->execute().isSuccess() ) {
      ATH_MSG_WARNING 
    ("Event FAILED validation criteria of ["
     << iTool->typeAndName() << "] !!");
      validationIsOK = false;
    }
  }
 
  if ( !validationIsOK ) {
    ATH_MSG_ERROR ("Event did not pass the validation !!");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode McAodValidationAlg::finalize ( )

overridevirtual

Definition at line 96 of file McAodValidationAlg.cxx.

{
  ATH_MSG_INFO ("Finalizing " << name() << "...");
 
  ATH_MSG_INFO
    ("==> Finalizing validation AlgTools (" << m_valTools.size() << ")...");
 
  for ( IValidationTools_t::iterator 
      iTool = m_valTools.begin(),
      iEnd  = m_valTools.end();
    iTool != iEnd;
    ++iTool ) {
    ATH_MSG_INFO ("-> finalizing [" << iTool->typeAndName() << "]:");
    if ( (*iTool)->finalize().isFailure() ) {
      ATH_MSG_WARNING 
    ("Could not finalize validation tool [" 
     << iTool->typeAndName() << "] !!");
    }
  }
 
  ATH_MSG_INFO 
    ("==> Finalizing validation AlgTools (" << m_valTools.size() 
     << ")... [DONE]");
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode McAodValidationAlg::initialize ( )

overridevirtual

Athena Algorithm's Hooks.

Definition at line 74 of file McAodValidationAlg.cxx.

{
  ATH_MSG_INFO ("Initializing " << name() << "...");
 
  // initializing pseudo-random generator with the seed
  ATH_MSG_INFO
    ("Initializing pseudo-random generator..." 
     << endmsg
     << "\tseed= " << m_seed);
  std::srand( m_seed );
  
  // retrieve the list of validation tools
  if ( !m_valTools.retrieve().isSuccess() ) {
    ATH_MSG_ERROR
      ("Could not retrieve McAod validation tools !!" << endmsg
       << " [" << m_valTools << "]");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_seed

unsigned int McAodValidationAlg::m_seed

protected

Random generator seed.

Definition at line 70 of file McAodValidationAlg.h.

◆ m_truthParticlesName

StringProperty McAodValidationAlg::m_truthParticlesName

protected

Location of the TruthParticleContainer to read.

Definition at line 65 of file McAodValidationAlg.h.

◆ m_valTools

IValidationTools_t McAodValidationAlg::m_valTools

protected

Validation tools to be ran on the events.

Definition at line 60 of file McAodValidationAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IValidationTools_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ McAodValidationAlg() [1/2]

◆ ~McAodValidationAlg()

◆ McAodValidationAlg() [2/2]

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_seed

◆ m_truthParticlesName

◆ m_valTools

◆ m_varHandleArraysDeclared

◆ m_vhka