PileupFilterTool Class Reference

#include <PileupFilterTool.h>

Inheritance diagram for PileupFilterTool:

Collaboration diagram for PileupFilterTool:

Public Member Functions
	PileupFilterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
virtual	~PileupFilterTool ()
	Destructor:
StatusCode	buildMcAod (const McEventCollection *in, McEventCollection *out)
	This method will check the validity of the input McEventCollection and build a filtered one from the strategy implemented by this concrete tool.
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< IMcVtxFilterTool >	McVtxFilterTool_t
typedef ToolHandle< ITruthIsolationTool >	IsolTool_t

Protected Member Functions
	PileupFilterTool ()
	Default constructor:
StatusCode	selectSpclMcBarcodes ()
	Retrieve the GenParticles from the GenEvent object (located into the McEventCollection container), filter them and store their barcode into the list of barcodes of particles to keep.
StatusCode	shapeGenEvent (McEventCollection *outEvt)
	Build the out McEventCollection by removing all the GenParticles whose barcode is not in the list of barcodes to keep.
StatusCode	reconnectParticles (const McEventCollection *inEvt, McEventCollection *out)
	Reconnect the particles of the filtered McEventCollection.
StatusCode	rebuildLinks (const HepMC::GenEvent *mcEvent, HepMC::GenEvent *outEvt, const HepMC::GenParticlePtr &mcPart)
	Rebuild the links between particles which were connected, eg by a long FSR chain.
StatusCode	initializeTool ()
	to get tesIO
virtual StatusCode	finalizeTool ()
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
std::set< HepMC::ConstGenParticlePtr >	m_particles
	List of particles which have been labelled as "special".
DoubleProperty	m_rIsol
	deltaR isolation energy cut for electrons, muons, taus and photons
DoubleProperty	m_ptGamMin
	Minimum threshold for transverse momentum of photons.
DoubleProperty	m_ptMin
	Minimum threshold for transverse momentum for all particles.
DoubleProperty	m_etaRange
	Eta acceptance cut applied on all stable particles.
DoubleProperty	m_rRange
	Radius acceptance cut on all stable particles.
BooleanProperty	m_includeSimul
	Switch to include or not particles from detector simulation (Geant4).
BooleanProperty	m_includePartonShowers
	Switch to include or not parton showers.
TruthHelper::GenAccessIO *	m_tesIO
	Pointer to a StoreGateSvc helper (Mc particle retrieval with predicates).
BooleanProperty	m_removeDecayToSelf
	Switch to remove particles which decay into themselves (t->tg) but only for generated particles, not the ones from the Geant4 interactions.
McVtxFilterTool_t	m_mcVtxFilterTool
	Pointer to the McVtxFilterTool to be able to select additional vertices on some decay pattern criterion.
IsolTool_t	m_isolationTool
	Pointer to the TruthIsolationTool to be able to compute transverse energy isolations for various isolation cones cuts.
BooleanProperty	m_doEtIsolation
	Switch to compute or not the Et-isolations for TruthParticle (and their underlying HepMC::GenParticle).
SG::ReadHandleKey< McEventCollection >	m_mcEventsReadHandleKey {this,"McEvents","TruthEvent","ReadHandleKey for input McEventCollection one wants to filter"}
	ReadHandleKey for the input McEventCollection one wants to filter.
SG::WriteHandleKey< McEventCollection >	m_mcEventsOutputWriteHandleKey {this,"McEventsOutput","GEN_AOD","WriteHandleKey for the output McEventCollection which has been filtered"}
	Location of the output McEventCollection which has been filtered.

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 28 of file PileupFilterTool.h.

Member Typedef Documentation

IsolTool_t

typedef ToolHandle<ITruthIsolationTool> TruthParticleFilterBaseTool::IsolTool_t

protectedinherited

Definition at line 80 of file TruthParticleFilterBaseTool.h.

McVtxFilterTool_t

typedef ToolHandle<IMcVtxFilterTool> TruthParticleFilterBaseTool::McVtxFilterTool_t

protectedinherited

Definition at line 74 of file TruthParticleFilterBaseTool.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

PileupFilterTool() [1/2]

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

Constructor with parameters:

Definition at line 41 of file PileupFilterTool.cxx.

                                               : 
  TruthParticleFilterBaseTool( type, name, parent ),
  m_particles (   ),
  m_tesIO    ( nullptr )
{
 
  declareProperty( "rIsolation",
           m_rIsol = 0.45,
           "DeltaR isolation energy cut for electrons, muons, "
           "taus and photons" );
 
  declareProperty( "ptGammaMin",
           m_ptGamMin = 0.5*GeV,
           "Minimum threshold for transverse momentum of photons" );
 
  declareProperty( "ptMin",             
           m_ptMin = 0.5*GeV,
           "Minimum threshold for transverse momentum for all particles.\n"
           "Warning: this cut is applied *before* Pt photon cut !" );
 
  declareProperty( "etaRange",          
           m_etaRange = 5.0,
           "Eta acceptance cut applied on all stable particles" );
 
  declareProperty( "rRange",          
           m_rRange = 500.0,
           "radius acceptance - in milimeters - cut applied on all stable "
           "particles" );
 
  // switches
 
  declareProperty( "IncludeSimul",         
           m_includeSimul = true,
           "Switch to include or not particles from detector simulation "
           "(Geant 4)" );
 
  declareProperty( "IncludePartonShowers", 
           m_includePartonShowers = true,
           "Switch to include or not parton showers" );
 
  declareProperty( "RemoveDecayToSelf",    
           m_removeDecayToSelf = true,
           "Switch to remove particles which decay into themselves (t->tg) "
           "*but* only for generated particles, not the ones from the "
           "Geant4 interactions" );
 
}

~PileupFilterTool()

PileupFilterTool::~PileupFilterTool ( )

virtual

Destructor:

Definition at line 93 of file PileupFilterTool.cxx.

{ 
  ATH_MSG_DEBUG("Calling destructor");
  delete m_tesIO;
}

PileupFilterTool() [2/2]

PileupFilterTool::PileupFilterTool ( )

protected

Default constructor:

Member Function Documentation

buildMcAod()

StatusCode PileupFilterTool::buildMcAod ( const McEventCollection * in, McEventCollection * out )

virtual

This method will check the validity of the input McEventCollection and build a filtered one from the strategy implemented by this concrete tool.

Implements ITruthParticleFilterTool.

Definition at line 103 of file PileupFilterTool.cxx.

{
  if ( nullptr == in || nullptr == out ) {
    ATH_MSG_ERROR("Invalid pointer to McEventCollection !" << endmsg
          << "  in: " << in << endmsg
          << " out: " << out);
    return StatusCode::FAILURE;
  }
 
  // we just copy the input McEventCollection and put it into the output one
  out->operator=( *in );
 
  // select the barcodes of the "special" particles from the input GenEvent
  if ( selectSpclMcBarcodes().isFailure() ) {
    ATH_MSG_ERROR("Could not select the \"special\" barcodes !!");
    return StatusCode::FAILURE;
  }
 
  // remove the not "special" particles from the filtered McEventCollection
  if ( shapeGenEvent(out).isFailure() ) {
    ATH_MSG_ERROR("Could not remove the not \"special\" particles from the "\
          "filtered McEventCollection !!");
    return StatusCode::FAILURE;
  }
 
  // reconnect the particles
  if ( reconnectParticles(in, out).isFailure() ) {
    ATH_MSG_ERROR("Could not reconnect the particles in the filtered "\
          "McEventCollection !!");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode TruthParticleFilterBaseTool::execute ( )

virtualinherited

Implements ITruthParticleFilterTool.

Definition at line 120 of file TruthParticleFilterBaseTool.cxx.

{  
  ATH_MSG_DEBUG("Executing " << name() << "...");
 
  //Setup Handle to read input container
  SG::ReadHandle<McEventCollection> mcEventsReadHandle(m_mcEventsReadHandleKey);
 
  if (!mcEventsReadHandle.isValid()){
    ATH_MSG_ERROR("Invalid ReadHandle to McEventColleciton with key: " << m_mcEventsReadHandleKey.key());
    return StatusCode::FAILURE;
  }
 
  //Setup WriteHandle, and then record new McEventCollection.
  SG::WriteHandle<McEventCollection> mcEventsOutputWriteHandle(m_mcEventsOutputWriteHandleKey);
  ATH_CHECK(mcEventsOutputWriteHandle.record(std::make_unique<McEventCollection>()));  
  
  if (!mcEventsOutputWriteHandle.isValid()){
    ATH_MSG_ERROR("Invalid WriteHamdle for McEventCollection with key ["
                  <<m_mcEventsOutputWriteHandleKey.key()  << "] !!");
    return StatusCode::FAILURE;
  }
  
  // Compute isolation for gamma/lepton.
  if ( m_doEtIsolation.value() ) {
    ATH_MSG_VERBOSE("Computing Et isolations...");
    if ( m_isolationTool->buildEtIsolations(m_mcEventsReadHandleKey.key()).isFailure() ) {
      ATH_MSG_ERROR("Could not compute Et isolations !!");
      return StatusCode::FAILURE;
    }
  } //> end do Et-isolation
 
    if ( this->buildMcAod( mcEventsReadHandle.ptr(), mcEventsOutputWriteHandle.ptr() ).isFailure() ) {
    ATH_MSG_ERROR("Could not buildMcAod(in,out) !!");
    return StatusCode::FAILURE;
  }
 
  // We have slimmed the mcEventsOutputWriteHandle.
  // To not bias the map of isolation energies for this GenEvent, we alias
  // it to its original one
  if ( m_doEtIsolation.value() &&
       !m_isolationTool->registerAlias( m_mcEventsOutputWriteHandleKey.key(), 
                                        m_mcEventsReadHandleKey.key() 
                                        ).isSuccess() ) {
    ATH_MSG_WARNING("Could not create an alias in the map of "\
            "isolation energies !");
  }
 
  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 TruthParticleFilterBaseTool::finalize ( )

virtualinherited

Implements ITruthParticleFilterTool.

Definition at line 105 of file TruthParticleFilterBaseTool.cxx.

{
  ATH_MSG_INFO("Finalizing " << name() << "...");
 
  m_mcVtxFilterTool->stats();
 
  // 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 TruthParticleFilterBaseTool::finalizeTool ( )

inlineprotectedvirtualinherited

Definition at line 124 of file TruthParticleFilterBaseTool.h.

{
  return StatusCode::SUCCESS;
}

initialize()

StatusCode TruthParticleFilterBaseTool::initialize ( )

virtualinherited

Athena Algorithm's Hooks.

Retrieves a private AlgTool to filter a McEventCollection

Retrieves the isolation tool (public, to be used also in TruthParticleCnvTool)

Implements ITruthParticleFilterTool.

Definition at line 65 of file TruthParticleFilterBaseTool.cxx.

{
  ATH_MSG_INFO("Initializing " << name() << "...");

  if ( !m_mcVtxFilterTool.retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Creation of algTool IMcVtxFilterTool FAILED !");
    return StatusCode::FAILURE;
  }

  if( m_doEtIsolation.value()) {
    ATH_CHECK(m_isolationTool.retrieve());
  }
  else {
    m_isolationTool.disable();
  }
 
  //initialize DataHandleKeys
  ATH_CHECK(m_mcEventsReadHandleKey.initialize());
  ATH_CHECK(m_mcEventsOutputWriteHandleKey.initialize());
  
  ATH_MSG_INFO
    (" DoEtIsolations: [" << std::boolalpha << m_doEtIsolation.value()
     << "]" << endmsg
     << " McEvents:       [" << m_mcEventsReadHandleKey.key() << "]" << endmsg
     << " McEventsOutput: [" << m_mcEventsOutputWriteHandleKey.key() << "]");
  
  // Give the concrete (derived) tool a chance to initialize itself
  if ( initializeTool().isFailure() ) {
    ATH_MSG_ERROR("Could not initialize concrete tool !");
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("Options of the McVtxFilterTool:");
  m_mcVtxFilterTool->displayOptions();
 
  return StatusCode::SUCCESS;
}

initializeTool()

StatusCode PileupFilterTool::initializeTool ( )

protectedvirtual

to get tesIO

Reimplemented from TruthParticleFilterBaseTool.

Definition at line 617 of file PileupFilterTool.cxx.

{
  ATH_MSG_DEBUG("Calling initializeTool");
  // accessor for particles
  delete m_tesIO;
  m_tesIO = new TruthHelper::GenAccessIO();
  if( nullptr == m_tesIO ) {
    ATH_MSG_ERROR("Unable to retrieve GenAccessIO pointer");
    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 & ITruthParticleFilterTool::interfaceID ( )

inlinestaticinherited

Inline methods:

Definition at line 70 of file ITruthParticleFilterTool.h.

{ 
   return IID_ITruthParticleFilterTool; 
}

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.

rebuildLinks()

StatusCode PileupFilterTool::rebuildLinks ( const HepMC::GenEvent * mcEvent, HepMC::GenEvent * outEvt, const HepMC::GenParticlePtr & mcPart )

protected

Rebuild the links between particles which were connected, eg by a long FSR chain.

Definition at line 422 of file PileupFilterTool.cxx.

{
  if ( !mcPart ) {
    ATH_MSG_WARNING("Null GenParticle: can not rebuildLinks");
    return StatusCode::FAILURE;
  }
 
  if ( mcPart->end_vertex() ) {
    ATH_MSG_VERBOSE("GenParticle has already a decay vertex : nothing to do");
    return StatusCode::SUCCESS;
  }
 
  if ( !mcEvt ) {
    ATH_MSG_WARNING("Null input HepMC::GenEvent : can not rebuildLinks");
    return StatusCode::FAILURE;
  }
 
  if ( !outEvt ) {
    ATH_MSG_WARNING("Null output HepMC::GenEvent: can not rebuildLinks");
    return StatusCode::FAILURE;
  }
 
  // Cache some useful infos
  const int pdgId = mcPart->pdg_id();
  const int bc    = HepMC::barcode(mcPart);
#ifdef HEPMC3
  HepMC::ConstGenParticlePtr  inPart = HepMC::barcode_to_particle(mcEvt,bc);
  HepMC::ConstGenVertexPtr    dcyVtx = inPart->end_vertex();
#else
//AV: Const correctness is broken in HepMC2
  HepMC::GenParticlePtr  inPart = HepMC::barcode_to_particle(mcEvt,bc);
  HepMC::GenVertexPtr    dcyVtx = inPart->end_vertex();
#endif
 
  if ( !dcyVtx ) {
    ATH_MSG_VERBOSE("No decay vertex for the particle #" << bc << " : " << "No link to rebuild...");
    return StatusCode::SUCCESS;
  }
 
  std::list<int> bcChildPart;
  std::list<int> bcChildVert;
 
  //
  // Loop over all descendants of the GenParticle
  // Store the barcode of the GenParticles entering into each GenVertex
  //
#ifdef HEPMC3
  auto descendants=HepMC::descendant_vertices(dcyVtx);
  for ( const auto& itrVtx: descendants) {
    bool foundPdgId = false;
    for ( const auto& itrPart: itrVtx->particles_in()) {
      // because the vertices are traversed in POST ORDER !!
      bcChildPart.push_front( HepMC::barcode(itrPart));
      if ( itrPart->pdg_id() == pdgId ) {
        foundPdgId = true;
      }
    }//> loop over in-going particles of this vertex
    if ( foundPdgId ) {
      bcChildVert.push_front( HepMC::barcode(itrVtx));
    }
  }//> loop over descendants of decay vertex
#else
  const HepMC::GenVertex::vertex_iterator endVtx = dcyVtx->vertices_end(HepMC::descendants);
  for ( HepMC::GenVertex::vertex_iterator itrVtx = dcyVtx->vertices_begin( HepMC::descendants );
    itrVtx != endVtx;
    ++itrVtx ) {
    bool foundPdgId = false;
    HepMC::GenVertex::particles_in_const_iterator endPart = (*itrVtx)->particles_in_const_end();
    for ( HepMC::GenVertex::particles_in_const_iterator itrPart = (*itrVtx)->particles_in_const_begin();
      itrPart != endPart;
      ++itrPart ) {
 
 
 
      // because the vertices are traversed in POST ORDER !!
      bcChildPart.push_front( (*itrPart)->barcode() );
 
      if ( (*itrPart)->pdg_id() == pdgId ) {
    foundPdgId = true;
      }
    }//> loop over in-going particles of this vertex
 
    if ( foundPdgId ) {
      bcChildVert.push_front( (*itrVtx)->barcode() );
    }
 
  }//> loop over descendants of decay vertex
#endif
 
  //
  // Now we loop over the previously stored barcodes and
  // we connect our GenParticle to the first found barcode
  // 
#ifdef HEPMC3
  std::list<int>::const_iterator bcVtxEnd = bcChildVert.end();
  for ( std::list<int>::const_iterator itrBcVtx = bcChildVert.begin(); itrBcVtx != bcVtxEnd; ++itrBcVtx ) {
    HepMC::GenVertexPtr childVtx = HepMC::barcode_to_vertex(outEvt,*itrBcVtx);
    if ( childVtx ) {
      if ( !childVtx->particles_in().empty() ) {
    for ( const auto& itrPart:  childVtx->particles_in()) {
      if ( itrPart->pdg_id() == pdgId ) {
        HepMC::GenVertexPtr  prodVtx = itrPart->production_vertex();
        if ( prodVtx ) {
          if ( !prodVtx->particles_in().empty() ) {
        // Humm... This is not what we'd have expected
        // so we skip it
        if ( msgLvl(MSG::VERBOSE) ) {
          msg(MSG::VERBOSE)<< "found a particle = "<< itrPart << ", "<< "but its production vertex has incoming particles !" << endmsg;
          continue;
        }
        // create a GenVertex which will be the decay vertex of our
        // GenParticle and the production vertex of the GenParticle
        // we just found
        HepMC::GenVertexPtr linkVtx = HepMC::newGenVertexPtr();
        outEvt->add_vertex( linkVtx );
        linkVtx->add_particle_in( mcPart );
        linkVtx->add_particle_out( itrPart );
        
        msg(MSG::ERROR)<< "=====================================================" << endmsg << "Created a GenVertex - link !" << std::endl;
        std::stringstream vtxLink("");
        HepMC::Print::line(vtxLink,std::move(linkVtx));
        msg(MSG::ERROR)<< vtxLink.str()<< endmsg<< "====================================================="<< endmsg;
          }
        }
      }
    }//> loop over incoming particles
      } else { 
    // no incoming particle : so we just add this particle
    // a bit odd though : FIXME ?
    childVtx->add_particle_in(mcPart);
    msg(MSG::WARNING) << "Odd situation:" << std::endl;
    std::stringstream vtxDump( "" );
    HepMC::Print::line(vtxDump,std::move(childVtx));
    msg(MSG::WARNING) << vtxDump.str() << endmsg;
    return StatusCode::SUCCESS;
      }//> end if incoming particles
    }//> found a child-vertex
  }
#else
  std::list<int>::const_iterator bcVtxEnd = bcChildVert.end();
  for ( std::list<int>::const_iterator itrBcVtx = bcChildVert.begin();
    itrBcVtx != bcVtxEnd;
    ++itrBcVtx ) {
    HepMC::GenVertex * childVtx = outEvt->barcode_to_vertex(*itrBcVtx);
    if ( childVtx ) {
      if ( childVtx->particles_in_size() > 0 ) {
    HepMC::GenVertex::particles_in_const_iterator endPart = childVtx->particles_in_const_end();
    for ( HepMC::GenVertex::particles_in_const_iterator itrPart = childVtx->particles_in_const_begin();
          itrPart != endPart;
          ++itrPart ) {
      if ( (*itrPart)->pdg_id() == pdgId ) {
        HepMC::GenVertex * prodVtx = (*itrPart)->production_vertex();
        if ( prodVtx ) {
          if ( prodVtx->particles_in_size() > 0 ) {
        // Humm... This is not what we'd have expected
        // so we skip it
        if ( msgLvl(MSG::VERBOSE) ) {
          msg(MSG::VERBOSE)<< "found a particle [bc,pdgId]= "<< (*itrPart)->barcode() << ", "<< "but its production vertex has incoming particles !" << endmsg;
          continue;
        }
        // create a GenVertex which will be the decay vertex of our
        // GenParticle and the production vertex of the GenParticle
        // we just found
        HepMC::GenVertexPtr linkVtx = HepMC::newGenVertexPtr();
        outEvt->add_vertex( linkVtx );
        linkVtx->add_particle_in( mcPart );
        linkVtx->add_particle_out( *itrPart );
        
        msg(MSG::ERROR)<< "====================================================="<< endmsg<< "Created a GenVertex - link !"<< std::endl;
        std::stringstream vtxLink("");
        linkVtx->print(vtxLink);
        msg(MSG::ERROR)<< vtxLink.str()<< endmsg<< "=====================================================" << endmsg;
          }
        }
      }
    }//> loop over incoming particles
      } else { 
    // no incoming particle : so we just add this particle
    // a bit odd though : FIXME ?
    childVtx->add_particle_in(mcPart);
    msg(MSG::WARNING) << "Odd situation:" << std::endl;
    std::stringstream vtxDump( "" );
    childVtx->print(vtxDump);
    msg(MSG::WARNING) << vtxDump.str() << endmsg;
    return StatusCode::SUCCESS;
      }//> end if incoming particles
    }//> found a child-vertex
  }//> loop over child-vertex-barcodes
#endif
 
  return StatusCode::FAILURE;
}

reconnectParticles()

StatusCode PileupFilterTool::reconnectParticles ( const McEventCollection * inEvt, McEventCollection * out )

protected

Reconnect the particles of the filtered McEventCollection.

We need the original McEventCollection to know if 2 particles were connected

Definition at line 377 of file PileupFilterTool.cxx.

{
  if ( nullptr == in || nullptr == out ) {
    ATH_MSG_ERROR("Invalid pointer to McEventCollection !!" << endmsg << "  in: " << in << endmsg << " out: " << out);
    return StatusCode::FAILURE;
  }
 
  for ( unsigned int iEvt = 0; iEvt != in->size(); ++iEvt) {
    const HepMC::GenEvent * evt    = (*in)[iEvt];
    HepMC::GenEvent       * outEvt = (*out)[iEvt];
    
    // Reconnect the particles
    ATH_MSG_VERBOSE("Reconnecting particles...");
    for ( const auto& itrPart: *outEvt) {
      if ( itrPart->end_vertex() ) {
    continue;
      }
      if ( rebuildLinks( evt, outEvt, itrPart ).isFailure() ) {
    ATH_MSG_WARNING("Could not rebuild links for this particle [pdgId,particle]= "<< itrPart->pdg_id() << ", " << itrPart);
      } else if ( msgLvl(MSG::VERBOSE) ) {
    msg(MSG::VERBOSE)<< "==========================================================="<< endmsg<< "Production vertex for particle " << itrPart << " : ";
    if ( itrPart->production_vertex() ) {
      std::stringstream prodVtx("");
      HepMC::Print::line(prodVtx,itrPart->production_vertex());
      msg(MSG::VERBOSE) << std::endl<< prodVtx.str()<< endmsg;
    } else {
      msg(MSG::VERBOSE) << "[No production vertex]" << endmsg;
    }
    
    msg(MSG::VERBOSE) << "Decay vertex for particle " << itrPart << " : ";
    if ( itrPart->end_vertex() ) {
      std::stringstream dcyVtx("");
      HepMC::Print::line(dcyVtx,itrPart->end_vertex());
      msg(MSG::VERBOSE) << std::endl<< dcyVtx.str() << endmsg;
    } else {
      msg(MSG::VERBOSE) << endmsg << "[No decay vertex]" << endmsg;
    }
      }//> end VERBOSE messages
      
    }//> loop over particles
  }//> loop over GenEvents
  
  return StatusCode::SUCCESS;
}

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

selectSpclMcBarcodes()

StatusCode PileupFilterTool::selectSpclMcBarcodes ( )

protected

Retrieve the GenParticles from the GenEvent object (located into the McEventCollection container), filter them and store their barcode into the list of barcodes of particles to keep.

skip stuff with no end-vertex

stable particles

Definition at line 142 of file PileupFilterTool.cxx.

{
  StatusCode sc = StatusCode::SUCCESS;
 
  // Get all of the generated particles (does not have Geant secondaries)
 
  std::vector<HepMC::ConstGenParticlePtr> particles;
  if ( m_includeSimul ) {
    sc = m_tesIO->getMC(particles, false, m_mcEventsReadHandleKey.key());
  } else {
    sc = m_tesIO->getMC(particles, true, m_mcEventsReadHandleKey.key());
  }
  if ( sc.isFailure() ) {
    ATH_MSG_ERROR("Could not get Monte Carlo particles from TDS at : "<< m_mcEventsReadHandleKey.key());
    return StatusCode::FAILURE;
  }
 
  m_particles.clear();
 
  //+++ Get True Vertices from Storegate
  const McEventCollection* mcTruth(nullptr);
  sc = evtStore()->retrieve(mcTruth, m_mcEventsReadHandleKey.key());
  if( sc.isFailure() ) {
    ATH_MSG_WARNING("MC Event " << m_mcEventsReadHandleKey.key() << " not found.");
    return StatusCode::SUCCESS;
  }
  ATH_MSG_DEBUG("McEventCollection successfully retrieved" << endmsg << "Number of truth particles: " << mcTruth->size());
 
  McEventCollection::const_iterator mcEventItr  = mcTruth->begin();
  McEventCollection::const_iterator mcEventItrE = mcTruth->end();
 
  for ( ; mcEventItr != mcEventItrE; ++mcEventItr ) {
 
     const HepMC::GenEvent* genEvent = (*mcEventItr);
 
#ifdef HEPMC3
     auto vxp = genEvent->vertices().begin();
#else
     HepMC::GenEvent::vertex_const_iterator vxp = genEvent->vertices_begin();
#endif
     const float xp = (*vxp)->position().x();
     const float yp = (*vxp)->position().y();
     const float zp = (*vxp)->position().z();
 
     // Loop over all particles, selecting special ones
     // keep track of them using their barcodes
     for (const auto&  part: *genEvent) {
        const int id      = part->pdg_id();
        const HepMC::FourVector hlv = part->momentum();
        const double pt   = hlv.perp();
        const HepMC::ConstGenVertexPtr& decayVtx = part->end_vertex();
        const HepMC::ConstGenVertexPtr& prodVtx  = part->production_vertex();
        bool isSpcl = false;
        if( !MC::isStable(part) && !decayVtx ) continue;
 
        float xi = (prodVtx->position()).x();
        float yi = (prodVtx->position()).y();
        float zi = (prodVtx->position()).z();
 
        ATH_MSG_DEBUG("Primary Vertex = " << xp << " " << yp << " " << zp << " " << "Production Vertex = " << xi << " " << yi << " " << zi << " " << "Particle ID = " << id);
 
        float deltaR = std::sqrt( (xp-xi)*(xp-xi) + (yp-yi)*(yp-yi) );
 
        const bool accept = (pt > m_ptMin) && (deltaR < m_rRange);
        // Select special particles
        if (m_includeSimul ) {
           if ( MC::isSimStable(part) && accept ) isSpcl = true;
        } else {
           if ( MC::isGenStable(part) && accept ) isSpcl = true;
        }

        // Save special particles and children
        if( !isSpcl ) continue;
        m_particles.insert(part); // add it to list
 
        // Children
        if( isSpcl && decayVtx ) {
          for(const auto& child: *(part->end_vertex())) {
             if( !HepMC::is_simulation_particle(child) && !m_removeDecayToSelf) { 
           m_particles.insert(child);// its not there already
             }
          }
        }
     } 
  }
  ATH_MSG_DEBUG("Read " << particles.size() << " and selected  " <<  m_particles.size() << " particles");
 
  return StatusCode::SUCCESS;
}

shapeGenEvent()

StatusCode PileupFilterTool::shapeGenEvent ( McEventCollection * outEvt )

protected

Build the out McEventCollection by removing all the GenParticles whose barcode is not in the list of barcodes to keep.

Remove also the dead vertices.

Definition at line 238 of file PileupFilterTool.cxx.

{
  //now remove all the particles except those whose barcodes are marked
  const std::string barcodeStr{"barcodes"};
  for ( McEventCollection::iterator evt = genAod->begin(); evt != genAod->end();++evt) {
    std::vector<HepMC::GenParticlePtr> going_out;
    std::list<int> evtBarcodes;
#ifdef HEPMC3
    const auto &barcodes = (*evt)->attribute<HepMC::GenEventBarcodes> (barcodeStr);
    std::map<int,int> id_to_barcode_map;
    if (barcodes) id_to_barcode_map = barcodes->id_to_barcode_map();
    for (const auto& keyval: id_to_barcode_map) evtBarcodes.push_back(keyval.second);
#else
    for ( const auto& p: **evt) {
      evtBarcodes.push_back( HepMC::barcode(p) );
    }
#endif
 
    for ( std::list<int>::const_iterator itrBc = evtBarcodes.begin(); itrBc != evtBarcodes.end(); ++itrBc ) {
//AV:  We modify the event!
      HepMC::GenParticlePtr p = HepMC::barcode_to_particle((HepMC::GenEvent*)(*evt),*itrBc);
      ATH_MSG_DEBUG("[pdg,particle]= " << p->pdg_id() << ", " << p);
      if ( m_particles.count(p) == 0) {
        going_out.push_back(p); // list of useless particles
        HepMC::GenVertexPtr pvtx = p->production_vertex();
        HepMC::GenVertexPtr evtx = p->end_vertex();
 
        std::pair<int,int> bcNext( 0, 0 );
        if ( msgLvl(MSG::DEBUG) ) {
          msg(MSG::DEBUG) << "Removing [" <<p << "]" << "\tprod/endVtx: " << pvtx << "/"  << evtx << endmsg;
          std::list<int>::const_iterator pNext = itrBc;
          ++pNext;
          if ( pNext != evtBarcodes.end() ) {
            bcNext.first = HepMC::barcode(HepMC::barcode_to_particle(*evt,*pNext));
          }
      }
#ifdef HEPMC3
    if (pvtx) pvtx->remove_particle_out(p); //remove from production vertex from useless particle
#else
    if (pvtx) pvtx->remove_particle(p); //remove from production vertex from useless particle
#endif
    if (evtx) { // if it has end vertex, may need to move the out partilces
      if(pvtx){ // move the partilces back
        if ( msgLvl(MSG::DEBUG) ) {
          msg(MSG::DEBUG) << "\tin endVtx   "<< endmsg;
        }
#ifdef HEPMC3
        while ( evtx->particles_out().begin() !=  evtx->particles_out().end()) {
          pvtx->add_particle_out(evtx->particles_out().front());
        }
      }//> end if [prod vertex]
      evtx->remove_particle_out(std::move(p)); // disconnect from end vertex    
#else 
        while ( evtx->particles_out_const_begin() !=  evtx->particles_out_const_end()) {
          HepMC::GenVertex::particles_out_const_iterator np = evtx->particles_out_const_begin();
          pvtx->add_particle_out(*np); // note that this really is a MOVE!!! it get taken off evtx by magic
        }
      }//> end if [prod vertex]
      evtx->remove_particle(p); // disconnect from end vertex   
#endif  
    }//> end if [decay vertex]
 
    if ( msgLvl(MSG::DEBUG) ) {
      std::list<int>::const_iterator pNext = itrBc;
      ++pNext;
      if ( pNext != evtBarcodes.end() ) {
        bcNext.second = HepMC::barcode(HepMC::barcode_to_particle(*evt,*pNext));
      }
 
      if ( bcNext.first != bcNext.second ) {
        ATH_MSG_WARNING("\tIterator has been CORRUPTED !!" << endmsg << "\tbcNext: " << bcNext.first << " --> " << bcNext.second);
      } else {
        ATH_MSG_DEBUG("\tIterator OK:" << endmsg << "\tbcNext: " << bcNext.first << " --> " << bcNext.second);
      }
    }
 
      }//> particle has to be removed
  }//> loop over particles
 
 
#ifdef HEPMC3
    // there may be a bunch of vertices with no particles connected to them:
    // ==> Get rid of them
    std::vector<HepMC::ConstGenVertexPtr> going_out_again;
    for ( auto& v: (*evt)->vertices() ) {
      if ( v->particles_in().empty() && v->particles_out().empty() ){
        going_out_again.push_back(v);
      }
    }//> loop over vertices
#else 
    // now get rid of all dead particles
    for ( std::vector<HepMC::GenParticle*>::iterator d = going_out.begin(); 
      d != going_out.end(); 
      ++d ){
      delete *d;
    }
 
    // there may be a bunch of vertices with no particles connected to them:
    // ==> Get rid of them
    std::vector<HepMC::GenVertex*> going_out_again;
    for ( HepMC::GenEvent::vertex_const_iterator v = (*evt)->vertices_begin();
      v != (*evt)->vertices_end(); ++v ) {
      if ( (*v)->particles_in_size() == 0 && (*v)->particles_out_size() == 0 ){
    going_out_again.push_back(*v);
      }
    }//> loop over vertices
 
   // now get rid of all dead vertices
    for ( std::vector<HepMC::GenVertex*>::iterator d = going_out_again.begin();
      d != going_out_again.end(); 
      ++d ){
      delete *d;
    }
#endif
    
  }//> loop over GenEvents in McEventCollection
  
  // Set the signal_process_vertex to NULL if not to be recorded 
  for ( McEventCollection::iterator evt = genAod->begin(); evt != genAod->end(); ++evt) { 
    auto sigProcVtx = HepMC::signal_process_vertex(*evt); 
    if ( !sigProcVtx ) continue;
    const int sigProcBC = HepMC::barcode(sigProcVtx); 
    bool isInColl = false; 
    if (HepMC::barcode_to_vertex(*evt, sigProcBC)) isInColl = true;
#ifdef HEPMC3
//AV: We don't set nullptr as signal vertex in HepMC3
    if ( !isInColl ) { 
         (*evt)->remove_attribute("signal_process_vertex");
    }
#else 
    if ( !isInColl ) { 
        (*evt)->set_signal_process_vertex(0); 
    } 
#endif
  }//> loop over GenEvent's 
 
  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_doEtIsolation

BooleanProperty TruthParticleFilterBaseTool::m_doEtIsolation

protectedinherited

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 94 of file TruthParticleFilterBaseTool.h.

m_etaRange

DoubleProperty PileupFilterTool::m_etaRange

protected

Eta acceptance cut applied on all stable particles.

Definition at line 118 of file PileupFilterTool.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_includePartonShowers

BooleanProperty PileupFilterTool::m_includePartonShowers

protected

Switch to include or not parton showers.

Definition at line 130 of file PileupFilterTool.h.

m_includeSimul

BooleanProperty PileupFilterTool::m_includeSimul

protected

Switch to include or not particles from detector simulation (Geant4).

Definition at line 126 of file PileupFilterTool.h.

m_isolationTool

IsolTool_t TruthParticleFilterBaseTool::m_isolationTool

protectedinherited

Pointer to the TruthIsolationTool to be able to compute transverse energy isolations for various isolation cones cuts.

See McParticleEvent/TruthParticleParameters.h for cone cuts.

Definition at line 85 of file TruthParticleFilterBaseTool.h.

m_mcEventsOutputWriteHandleKey

SG::WriteHandleKey<McEventCollection> TruthParticleFilterBaseTool::m_mcEventsOutputWriteHandleKey {this,"McEventsOutput","GEN_AOD","WriteHandleKey for the output McEventCollection which has been filtered"}

protectedinherited

Location of the output McEventCollection which has been filtered.

Definition at line 104 of file TruthParticleFilterBaseTool.h.

{this,"McEventsOutput","GEN_AOD","WriteHandleKey for the output McEventCollection which has been filtered"};

m_mcEventsReadHandleKey

SG::ReadHandleKey<McEventCollection> TruthParticleFilterBaseTool::m_mcEventsReadHandleKey {this,"McEvents","TruthEvent","ReadHandleKey for input McEventCollection one wants to filter"}

protectedinherited

ReadHandleKey for the input McEventCollection one wants to filter.

Definition at line 100 of file TruthParticleFilterBaseTool.h.

{this,"McEvents","TruthEvent","ReadHandleKey for input  McEventCollection one wants to filter"};

m_mcVtxFilterTool

McVtxFilterTool_t TruthParticleFilterBaseTool::m_mcVtxFilterTool

protectedinherited

Pointer to the McVtxFilterTool to be able to select additional vertices on some decay pattern criterion.

Definition at line 78 of file TruthParticleFilterBaseTool.h.

m_particles

std::set<HepMC::ConstGenParticlePtr> PileupFilterTool::m_particles

protected

List of particles which have been labelled as "special".

Definition at line 101 of file PileupFilterTool.h.

m_ptGamMin

DoubleProperty PileupFilterTool::m_ptGamMin

protected

Minimum threshold for transverse momentum of photons.

Definition at line 109 of file PileupFilterTool.h.

m_ptMin

DoubleProperty PileupFilterTool::m_ptMin

protected

Minimum threshold for transverse momentum for all particles.

Warning: this cut is applied before Pt photon cut !

Definition at line 114 of file PileupFilterTool.h.

m_removeDecayToSelf

BooleanProperty PileupFilterTool::m_removeDecayToSelf

protected

Switch to remove particles which decay into themselves (t->tg) but only for generated particles, not the ones from the Geant4 interactions.

Definition at line 139 of file PileupFilterTool.h.

m_rIsol

DoubleProperty PileupFilterTool::m_rIsol

protected

deltaR isolation energy cut for electrons, muons, taus and photons

Definition at line 105 of file PileupFilterTool.h.

m_rRange

DoubleProperty PileupFilterTool::m_rRange

protected

Radius acceptance cut on all stable particles.

Definition at line 122 of file PileupFilterTool.h.

m_tesIO

TruthHelper::GenAccessIO* PileupFilterTool::m_tesIO

protected

Pointer to a StoreGateSvc helper (Mc particle retrieval with predicates).

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

• PileupFilterTool.h
• PileupFilterTool.cxx