TruthParticleCnvTool Class Reference

#include <TruthParticleCnvTool.h>

Inheritance diagram for TruthParticleCnvTool:

Collaboration diagram for TruthParticleCnvTool:

Public Member Functions
	TruthParticleCnvTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters: More...
virtual	~TruthParticleCnvTool ()
	Destructor: More...
virtual StatusCode	initialize () override
	Athena Algorithm's Hooks. More...
virtual StatusCode	execute () const override
virtual StatusCode	execute (const EventContext &ctx) const override
StatusCode	convert (const McEventCollection *mcEvts, const unsigned int genEvtIndex, TruthParticleContainer *mcParts, const ITruthParticleVisitor *visitor) const override
	Converts a McEventCollection into an TruthParticleContainer (ie: converts it into an AOD compliant collection). More...
void	setDataType (const int type)
	Inline methods: More...
void	setVxCandidateName (const std::string &name)
StatusCode	convert (const McEventCollection *mcCollection, TruthParticleContainer *container) const
	Convert the first element of a McEventCollection into a TruthParticleContainer. 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
StatusCode	convertMcEventCollection (const McEventCollection *mcCollection, TruthParticleContainer *container) const
	Convert a McEventCollection into an TruthParticleContainer. More...
StatusCode	convertMcEventCollection (const McEventCollection *mcCollection, TruthParticleContainer *container) const
	Convert a McEventCollection into an TruthParticleContainer. More...
StatusCode	convertMcEventCollection (const McEventCollection *mcCollection, TruthParticleContainer *container) const
	Convert a McEventCollection into an TruthParticleContainer. More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Inline methods: More...

Protected Types
typedef ToolHandle< ITruthIsolationTool >	IsolTool_t

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

Protected Attributes
BooleanProperty	m_doEtIsolation
	Switch to compute or not the Et-isolations for TruthParticle (and their underlying HepMC::GenParticle). More...
IsolTool_t	m_isolationTool
	Pointer to the ITruthIsolationTool to be able to retrieve the previously computed transverse energy isolations. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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...

Private Attributes
ParticleDataType::DataType	m_dataType
	Type of data we are dealing with (Full/Fast/Truth/...) More...
int	m_dataType_int
std::string	m_vxCandidatesName
SG::ReadHandleKey< McEventCollection >	m_mcEventsReadHandleKey {this,"McEvents","GEN_AOD","ReadHandleKey for the input McEventCollection, from which the TruthParticles will be made from"}
	ReadHandleKey for the McEventCollection the TruthParticles will be made from. More...
SG::WriteHandleKey< TruthParticleContainer >	m_mcPartsOutputWriteHandleKey {this,"TruthParticlesOutput","SpclMC","WriteHandleKey for the output truth particles (built from the McEventCollection)"}
	Output TruthParticle WriteHandleKey (built from the McEventCollection) More...
const HepPDT::ParticleDataTable *	m_pdt
	Particle Property service. More...
PileUpClassification::PileuType_t	m_selectSignalType
	Type of truth particle we want to create. More...
int	m_selectSignalTypeProp
	Type of truth particle we want to create (property to be set by jobO) More...
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

AlgTool that converts, on the fly, on demand, each GenParticle to a TruthParticle and builds the TruthParticleContainer. So the GEN_AOD and TruthParticleContainer are identical in contents, only the interfaces are different: the TruthParticle class has the same interface as other AOD particles. Hence the analysis tools can operate on all the AOD particles (ie: including Mc Truth). When the AOD is created, the TruthParticleContainer is empty. When the user requests the TruthParticleContainer in his/her analysis code, a custom converter is triggered where by the GEN_AOD is convertered into the TruthParticleContainer using the TruthParticleCnvTool.

In pile-up events, the many GenEvent are grouped into 5 TruthParticleContainer according to the classification of : https://twiki.cern.ch/twiki/bin/viewauth/Atlas/PileupDigitization#Arrangement_of_Truth_Information

Definition at line 59 of file TruthParticleCnvTool.h.

Member Typedef Documentation

IsolTool_t

typedef ToolHandle<ITruthIsolationTool> TruthParticleCnvTool::IsolTool_t

protected

Definition at line 150 of file TruthParticleCnvTool.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TruthParticleCnvTool()

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

Constructor with parameters:

Public methods:

Constructors

Definition at line 48 of file TruthParticleCnvTool.cxx.

                                                   : 
  AthAlgTool( type, name, parent ),
  m_dataType         ( ParticleDataType::True ),
  m_vxCandidatesName ( ),
  m_pdt              ( nullptr ),
  m_selectSignalTypeProp ( 0 )
{
  //
  // Property declaration
  // 
  
  declareProperty( "DataType", 
           m_dataType_int = 4,
           "Type of data we are dealing with (Full/Fast/Truth...)" );
 
  declareProperty( "TruthIsolationTool",
           m_isolationTool = IsolTool_t( "TruthIsolationTool" ),
           "Pointer to the TruthIsolationTool to be able to compute "
           "transverse energy isolations for various isolation cones cuts. "
           "See McParticleEvent/TruthParticleParameters.h for cone cuts." );
 
 
  declareProperty( "DoEtIsolations",
           m_doEtIsolation = false,
           "Switch to compute or not the Et-isolations for TruthParticle "
           "(and their underlying @c HepMC::GenParticle).\n"
           "Default is to not compute these Et-isolations (and save CPU)." );
 
  setDataType( m_dataType_int );
 
  declareProperty( "SelectSignalType",
           m_selectSignalTypeProp,
           "Switch to select different type of signal\n"
           " hard scatter               0\n"
           " hard scatter plus minbias  1\n" 
           " only minbias              -1\n" 
           "Default is hard scatter only." );
 
  declareInterface<ITruthParticleCnvTool>(this);
}

~TruthParticleCnvTool()

TruthParticleCnvTool::~TruthParticleCnvTool ( )

virtual

Destructor:

Destructor.

Definition at line 93 of file TruthParticleCnvTool.cxx.

{ 
  ATH_MSG_DEBUG("Calling destructor");
}

Member Function Documentation

convert() [1/2]

StatusCode ITruthParticleCnvTool::convert ( const McEventCollection *  mcCollection, TruthParticleContainer *  container  ) const

inlineinherited

Convert the first element of a McEventCollection into a TruthParticleContainer.

Definition at line 112 of file ITruthParticleCnvTool.h.

{
  const unsigned int genEvtIndex = 0;
  const ITruthParticleVisitor* dummyVisitor = 0;
  return this->convert( mcCollection, genEvtIndex, container, dummyVisitor );
}

convert() [2/2]

StatusCode TruthParticleCnvTool::convert ( const McEventCollection *  mcEvts, const unsigned int  genEvtIndex, TruthParticleContainer *  mcParts, const ITruthParticleVisitor *  visitor  ) const

overridevirtual

Converts a McEventCollection into an TruthParticleContainer (ie: converts it into an AOD compliant collection).

Const methods:

@in mcEvts the McEventCollection holding the HepMC::GenEvent we want to convert into a TruthParticleContainer @in genEvtIndex the index to the HepMC::GenEvent to be converted @out mcParts a valid pointer to a TruthParticleContainer which will be filled with adaptors to HepMC::GenParticles.

Get GenEvent from McEventCollection

Create a map to enhance access between GenParticles and TruthParticles

Implements ITruthParticleCnvTool.

Definition at line 224 of file TruthParticleCnvTool.cxx.

{
  ATH_MSG_DEBUG("Converting McEventCollection to TruthParticleContainer");
 
  if ( nullptr == m_pdt ) {
    ATH_MSG_ERROR("Could not convert McEventCollection into "\
          "TruthParticleContainer if NO ParticleDataTable is "\
          "available !!");
    return StatusCode::FAILURE;
  }
  
  if ( nullptr == mcCollection ) {
    ATH_MSG_WARNING("Null pointer to McEventCollection !");
    return StatusCode::RECOVERABLE;
  }
 
  if ( mcCollection->size() <= genEventIndex ) {
    ATH_MSG_WARNING("McEventCollection size: " << mcCollection->size() 
            << endmsg
            << "Requested element nbr : " << genEventIndex << " !!");
    return StatusCode::RECOVERABLE;
  }
 
  IProxyDict* sg = SG::CurrentEventStore::store();
 
  ATH_MSG_DEBUG("Retrieve the GenEvent from given McEventCollection");
  const HepMC::GenEvent * evt = (*mcCollection)[genEventIndex];
  container->setGenEvent( mcCollection, genEventIndex, sg );
 
  // reserve enough space for the container so we don't have to relocate it
  container->reserve( container->size() + evt->particles_size() );
 
  TruthParticleContainer::Map_t bcToMcPart = container->m_particles;
 
  
#ifdef HEPMC3
  // Process particles in barcode order.
  auto bcmapatt = evt->attribute<HepMC::GenEventBarcodes>("barcodes");
  if (!bcmapatt) ATH_MSG_ERROR("TruthParticleCnvTool.cxx: Event does not contain barcodes attribute"); 
  std::map<int, HepMC3::ConstGenParticlePtr> bcmap = bcmapatt->barcode_to_particle_map();
  for (const auto &[bc,hepMcPart]: bcmap) {
#else
  for (auto hepMcPart: *evt) {
    int bc = HepMC::barcode(hepMcPart);
#endif
 
    TruthParticle * mcPart = new TruthParticle( hepMcPart, container );
    container->push_back( mcPart );
    
    if ( visitor ) {
      visitor->visit( mcPart );
    }
 
    mcPart->setCharge( MC::charge( int(mcPart->pdgId())) );
    mcPart->setGenEventIndex( genEventIndex);
 
    if ( hepMcPart != mcPart->genParticle() ) {
      ATH_MSG_ERROR("TruthParticle is not wrapping the GenParticle : " 
            << hepMcPart << " !!");
    }
    HepMcParticleLink mcLink( bc, genEventIndex, HepMcParticleLink::IS_POSITION, HepMcParticleLink::IS_BARCODE, sg ); // FIXME barcode-based
    bcToMcPart[ mcLink.compress() ] = mcPart;
 
  }//> end loop over particles
 
  // at this point the whole GenEvent has been proxied.
  // so we can setup its VectorMap
  container->setParticles( bcToMcPart );
 
  // connect the TruthParticleContainer to the container of TruthEtIsolations
  // if it exists and if we are asked for
  if ( m_doEtIsolation.value() ) {
    const std::string& etIsolName 
      = m_isolationTool->etIsolationsName( container->genEventName() );
    if ( etIsolName.empty() ) {
      ATH_MSG_WARNING("Could not retrieve the name of the "
              "TruthEtIsolations container (requested: [" 
              << container->genEventName() << "])");
      return StatusCode::RECOVERABLE;
    }
 
    const TruthEtIsolationsContainer* etIsols = nullptr;
    if ( !evtStore()->retrieve( etIsols, etIsolName ).isSuccess() ) {
      ATH_MSG_WARNING("Could not retrieve the TruthEtIsolations container at ["
              << etIsolName << "] !!");
      return StatusCode::RECOVERABLE;
    }
 
    // index of HepMC::GenEvent within the McEventCollection is the same
    // than the one of the TruthEtIsolations within the TruthEtIsolationsCont.
    container->setEtIsolations( etIsols, genEventIndex );
  }
 
  return StatusCode::SUCCESS;
}

convertMcEventCollection()

StatusCode ITruthParticleCnvTool::convertMcEventCollection ( const McEventCollection *  mcCollection, TruthParticleContainer *  container  ) const

inlineinherited

Convert a McEventCollection into an TruthParticleContainer.

deprecated Note that the pointer to the TruthParticleContainer MUST be valid.

Definition at line 121 of file ITruthParticleCnvTool.h.

{
  const unsigned int genEvtIndex = 0;
  const ITruthParticleVisitor* dummyVisitor = 0;
  return this->convert( mcCollection, genEvtIndex, container, dummyVisitor );
}

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

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.

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

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

{ return m_evtStore; }

execute() [1/2]

StatusCode TruthParticleCnvTool::execute ( ) const

overridevirtual

Implements ITruthParticleCnvTool.

Definition at line 146 of file TruthParticleCnvTool.cxx.

{
  return execute (Gaudi::Hive::currentContext());
}

execute() [2/2]

StatusCode TruthParticleCnvTool::execute ( const EventContext &  ctx ) const

overridevirtual

Implements ITruthParticleCnvTool.

Definition at line 152 of file TruthParticleCnvTool.cxx.

{  
  ATH_MSG_DEBUG("Executing " << name() << "...");
 
  //Setup WriteHandle, and record new TruthParticleContainer
  SG::WriteHandle<TruthParticleContainer> mcPartsOutputWriteHandle(m_mcPartsOutputWriteHandleKey, ctx);
  ATH_CHECK(mcPartsOutputWriteHandle.record(std::make_unique<TruthParticleContainer>()));  
  
  if (!mcPartsOutputWriteHandle.isValid()){
    ATH_MSG_ERROR("Invalid WriteHandle for TruthParticleContainer with key: " << m_mcPartsOutputWriteHandleKey.key());
    return StatusCode::FAILURE;
  }
 
  //Setup ReadHandle for input McEventCollection
  SG::ReadHandle<McEventCollection> mcEventsReadHandle(m_mcEventsReadHandleKey, ctx);
 
  if (!mcEventsReadHandle.isValid()){
     ATH_MSG_WARNING("Invalid ReadHandle for McEventCollection with key ["
             << m_mcEventsReadHandleKey.key() << "] !!"
             << endmsg
             << "TruthParticleContainer [" << m_mcPartsOutputWriteHandleKey.key()
             << "] will be EMPTY !!");
     return StatusCode::RECOVERABLE;
  }
  
  ATH_MSG_DEBUG(" Found McEventCollection of size = "<< mcEventsReadHandle->size() );
  // do the actual convertion (it is merely an interface adaptation now...)
  //  selection for particles from minbias copied from the JetsFromTruthTool
 
  std::size_t genEventIndex = 0;
  const ITruthParticleVisitor* dummyVisitor = nullptr;
  bool all_good = true;
 
  McEventCollection::const_iterator fEvt = mcEventsReadHandle->begin();
  McEventCollection::const_iterator lEvt = mcEventsReadHandle->end();
  PileUpClassification::findEventIterators(m_selectSignalType, fEvt,lEvt);
 
  ATH_MSG_DEBUG(" Found McEventCollection iterators : "<< (fEvt-mcEventsReadHandle->begin()) << " to "<< (lEvt-mcEventsReadHandle->begin()) );
 
  for(McEventCollection::const_iterator it=fEvt ; it != lEvt; ++it){
    const HepMC::GenEvent* evt = *it;
    // there are holes in a McEventCollection when pile-up is enabled
    // so deal with it
    if (nullptr == evt) {
      continue;
    }
    genEventIndex = (it - mcEventsReadHandle->begin());
    ATH_MSG_DEBUG(" adding event id="<< HepMC::signal_process_id(evt)<<"  genEventIndex="<< genEventIndex );
 
    if( HepMC::signal_process_id(evt) == 0 ) continue;
    if (!this->convert( mcEventsReadHandle.ptr(), genEventIndex, mcPartsOutputWriteHandle.ptr(), dummyVisitor ).isSuccess()) {
      ATH_MSG_DEBUG("Failed to convert an event...");
      all_good = false;
    }
  }
 
  // VERY IMPORTANT ! Reset the index to the first GenEvent included
  // in this TruthParticleContainer. This will be used when read back from disk.
  mcPartsOutputWriteHandle->setGenEvent( mcEventsReadHandle.ptr(), (fEvt - mcEventsReadHandle->begin() ) );
 
  
  return all_good 
    ? StatusCode::SUCCESS
    : StatusCode::RECOVERABLE;
}

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

initialize()

StatusCode TruthParticleCnvTool::initialize ( )

overridevirtual

Athena Algorithm's Hooks.

Definition at line 100 of file TruthParticleCnvTool.cxx.

{
  ATH_MSG_INFO("Initializing " << name() << "...");
 
  // Get the Particle Properties Service
  ServiceHandle<IPartPropSvc> partPropSvc("PartPropSvc", name());
  if ( !partPropSvc.retrieve().isSuccess() ) {
    ATH_MSG_ERROR(" Could not initialize Particle Properties Service");
    return StatusCode::FAILURE;
  }      
 
  m_pdt = partPropSvc->PDT();
  if ( nullptr == m_pdt ) {
    ATH_MSG_ERROR("Could not retrieve HepPDT::ParticleDataTable from "\
          "ParticleProperties Service !!");
    return StatusCode::FAILURE;
  }
 
  // retrieve the TruthIsolation tool only if asked for.
  if ( m_doEtIsolation.value() ) {
    ATH_CHECK(m_isolationTool.retrieve());
  }
  else {
    m_isolationTool.disable();
  }
 
  //initialize DataHandleKeys
  ATH_CHECK(m_mcPartsOutputWriteHandleKey.initialize());
  ATH_CHECK(m_mcEventsReadHandleKey.initialize());
 
  // for compatibility with earlier version we accept <0 values :
  if(m_selectSignalTypeProp<0) m_selectSignalType = PileUpClassification::ALLMINBIAS;
  else m_selectSignalType = (PileUpClassification::PileuType_t) m_selectSignalTypeProp;
  
 
  ATH_MSG_INFO
    (" DoEtIsolations:       [" << std::boolalpha 
     << m_doEtIsolation.value() << "]" << endmsg
     << " McEvents:             [" << m_mcEventsReadHandleKey.key() << "]" << endmsg
     << " TruthParticlesOutput: [" << m_mcPartsOutputWriteHandleKey.key() << "]"
     << endmsg
     << " SelectSignalType:     [" << m_selectSignalType << "]");
 
  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 & ITruthParticleCnvTool::interfaceID ( )

inlinestaticinherited

Inline methods:

Definition at line 106 of file ITruthParticleCnvTool.h.

{ 
   return IID_ITruthParticleCnvTool; 
}

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

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

setDataType()

void TruthParticleCnvTool::setDataType ( const int  type )

inline

Inline methods:

Definition at line 162 of file TruthParticleCnvTool.h.

{ 
  m_dataType = ParticleDataType::DataType(type); 
}

setVxCandidateName()

void TruthParticleCnvTool::setVxCandidateName ( const std::string &  name )

inline

Definition at line 167 of file TruthParticleCnvTool.h.

{ 
  m_vxCandidatesName = name; 
}

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_dataType

ParticleDataType::DataType TruthParticleCnvTool::m_dataType

private

Type of data we are dealing with (Full/Fast/Truth/...)

Definition at line 111 of file TruthParticleCnvTool.h.

m_dataType_int

int TruthParticleCnvTool::m_dataType_int

private

Definition at line 112 of file TruthParticleCnvTool.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_doEtIsolation

BooleanProperty TruthParticleCnvTool::m_doEtIsolation

protected

Switch to compute or not the Et-isolations for TruthParticle (and their underlying HepMC::GenParticle).

Default is to not compute these Et-isolations (and save CPU)

Definition at line 148 of file TruthParticleCnvTool.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_isolationTool

IsolTool_t TruthParticleCnvTool::m_isolationTool

protected

Pointer to the ITruthIsolationTool to be able to retrieve the previously computed transverse energy isolations.

Definition at line 155 of file TruthParticleCnvTool.h.

m_mcEventsReadHandleKey

SG::ReadHandleKey<McEventCollection> TruthParticleCnvTool::m_mcEventsReadHandleKey {this,"McEvents","GEN_AOD","ReadHandleKey for the input McEventCollection, from which the TruthParticles will be made from"}

private

ReadHandleKey for the McEventCollection the TruthParticles will be made from.

Definition at line 118 of file TruthParticleCnvTool.h.

m_mcPartsOutputWriteHandleKey

SG::WriteHandleKey<TruthParticleContainer> TruthParticleCnvTool::m_mcPartsOutputWriteHandleKey {this,"TruthParticlesOutput","SpclMC","WriteHandleKey for the output truth particles (built from the McEventCollection)"}

private

Output TruthParticle WriteHandleKey (built from the McEventCollection)

Definition at line 122 of file TruthParticleCnvTool.h.

m_pdt

const HepPDT::ParticleDataTable* TruthParticleCnvTool::m_pdt

private

Particle Property service.

Definition at line 126 of file TruthParticleCnvTool.h.

m_selectSignalType

PileUpClassification::PileuType_t TruthParticleCnvTool::m_selectSignalType

private

Type of truth particle we want to create.

Definition at line 130 of file TruthParticleCnvTool.h.

m_selectSignalTypeProp

int TruthParticleCnvTool::m_selectSignalTypeProp

private

Type of truth particle we want to create (property to be set by jobO)

Definition at line 134 of file TruthParticleCnvTool.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.

m_vxCandidatesName

std::string TruthParticleCnvTool::m_vxCandidatesName

private

Definition at line 114 of file TruthParticleCnvTool.h.

---

The documentation for this class was generated from the following files:

• TruthParticleCnvTool.h
• TruthParticleCnvTool.cxx