Algorithm to skim the xAOD truth particle container for pileup minbias samples. More...

#include <PileupTruthParticleSlimmer.h>

Inheritance diagram for PileupTruthParticleSlimmer:

Collaboration diagram for PileupTruthParticleSlimmer:

Public Member Functions
	PileupTruthParticleSlimmer (const std::string &name, ISvcLocator *svcLoc)
	Regular algorithm constructor.
virtual StatusCode	initialize ()
	Function initialising the algorithm.
virtual StatusCode	execute ()
	Function executing the algorithm.
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 Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_xaodTruthPileupParticleContainerName
	The key for the output xAOD truth containers.
std::string	m_xaodTruthParticleContainerName
double	m_photon_pt_selection
	Selection values for keeping photons and leptons.
double	m_lepton_pt_selection
double	m_abseta_selection
bool	m_forceRerun
	a flag to force rerunning (useful for rerunning on ESDs)
ToolHandle< IMCTruthClassifier >	m_classifier
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

Algorithm to skim the xAOD truth particle container for pileup minbias samples.

This algorithm is used to copy and skim the the particles from the xAOD TruthParticles container, keeping just relevant photons, electrons, and muons from the event. These particles are made available in the output EVNT file so they can later be combined with other pileup overlay events into a pileup TruthParticles container. The design of this class heavily mirrors the DerivationFramework::TruthCollectionMaker.

Author: Jeff Dandoy Jeff..nosp@m.Dand.nosp@m.oy@ce.nosp@m.rn.c.nosp@m.h

Definition at line 29 of file PileupTruthParticleSlimmer.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ PileupTruthParticleSlimmer()

PileupTruthParticleSlimmer::PileupTruthParticleSlimmer	(	const std::string &	name,
		ISvcLocator *	svcLoc )

Regular algorithm constructor.

Todo: TruthParticle -> TruthParticles

Definition at line 25 of file PileupTruthParticleSlimmer.cxx.

: AthAlgorithm( name, svcLoc ), m_classifier("MCTruthClassifier/MCTruthClassifier")
{
    declareProperty("xAODTruthParticleContainerName", m_xaodTruthParticleContainerName="TruthParticles" );
    declareProperty("xAODTruthPileupParticleContainerName", m_xaodTruthPileupParticleContainerName="TruthPileupParticles" );
    declareProperty( "ForceRerun", m_forceRerun = false);
    declareProperty("photon_pt_selection", m_photon_pt_selection=8.*Gaudi::Units::GeV ); //User provides units in MeV!
    declareProperty("lepton_pt_selection", m_lepton_pt_selection=1.*Gaudi::Units::GeV ); //User provides units in MeV!
    declareProperty("abseta_selection", m_abseta_selection=4.5 );
}

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 PileupTruthParticleSlimmer::execute ( )

virtual

Function executing the algorithm.

Definition at line 47 of file PileupTruthParticleSlimmer.cxx.

                                               {
    
    
    // If the containers already exist then assume that nothing needs to be done
    if ( evtStore()->contains< xAOD::TruthParticleContainer >(m_xaodTruthPileupParticleContainerName) &&
        !m_forceRerun) {
        ATH_MSG_WARNING("xAOD Pileup Truth Particles are already available in the event");
        return StatusCode::SUCCESS;
    }
    
 
    // Create new output container
    xAOD::TruthParticleContainer* xTruthPileupParticleContainer = new xAOD::TruthParticleContainer();
    CHECK( evtStore()->record( xTruthPileupParticleContainer, m_xaodTruthPileupParticleContainerName ) );
    xAOD::TruthParticleAuxContainer* xTruthPileupParticleAuxContainer = new xAOD::TruthParticleAuxContainer();
    CHECK( evtStore()->record( xTruthPileupParticleAuxContainer, m_xaodTruthPileupParticleContainerName + "Aux." ) );
    xTruthPileupParticleContainer->setStore( xTruthPileupParticleAuxContainer );
    ATH_MSG_DEBUG( "Recorded TruthPileupParticleContainer with key: " << m_xaodTruthPileupParticleContainerName );
 
    // Retrieve full TruthParticle container
    const xAOD::TruthParticleContainer* xTruthParticleContainer = nullptr;
    if (evtStore()->retrieve(xTruthParticleContainer, m_xaodTruthParticleContainerName).isFailure()) {
        ATH_MSG_ERROR("No TruthParticle collection with name " << m_xaodTruthParticleContainerName << " found in StoreGate!");
        return StatusCode::FAILURE;
    }
 
    // Set up decorators
    const static SG::AuxElement::Decorator<unsigned int> originDecorator("classifierParticleOrigin");
    const static SG::AuxElement::Decorator<unsigned int> typeDecorator("classifierParticleType");
    const static SG::AuxElement::Decorator<unsigned int> outcomeDecorator("classifierParticleOutCome");
    const static SG::AuxElement::Decorator<unsigned int> classificationDecorator("Classification");
    const static SG::AuxElement::Decorator<int> parenthadronPIDDecorator("parentHadronID");
 
    // Loop over full TruthParticle container
    //unsigned int nParticles = xTruthParticleContainer->size();
    //for (unsigned int iPart=0; iPart<nParticles; ++iPart) {
    for (const xAOD::TruthParticle *theParticle : *xTruthParticleContainer) {
     
      //We only want to save stable particles (lifetime > 10mm)
      if (!MC::isStable(theParticle)){
          continue; //Skip this particle
      }
 
      float this_abseta = theParticle->abseta();
      float this_pt =  theParticle->pt();
 
      //Save photons above 8 GeV or electrons/muons above 1 GeV, & within detector acceptance (4.5)
      if( ( (MC::isPhoton(theParticle) && this_pt >= m_photon_pt_selection) || ((MC::isElectron(theParticle) || MC::isMuon(theParticle)) && this_pt >= m_lepton_pt_selection) )
          && (this_abseta < m_abseta_selection) ){
 
        xAOD::TruthParticle* xTruthParticle = new xAOD::TruthParticle();
        xTruthPileupParticleContainer->push_back( xTruthParticle );
 
        // Fill with numerical content
        *xTruthParticle=*theParticle;
 
unsigned int particleOutCome;
unsigned int result;
unsigned int particleType;
unsigned int particleOrigin;
int hadron_pdg;
Common::classify(m_classifier,theParticle,particleOutCome,result,hadron_pdg,particleType,particleOrigin );
        typeDecorator(*xTruthParticle) = particleType;
        originDecorator(*xTruthParticle) = particleOrigin;
        outcomeDecorator(*xTruthParticle) = particleOutCome;  
 
        classificationDecorator(*xTruthParticle) = result;
        parenthadronPIDDecorator(*xTruthParticle) = hadron_pdg;
      }
 
    } //end of loop over particles
 
    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();
}

◆ initialize()

StatusCode PileupTruthParticleSlimmer::initialize ( )

virtual

Function initialising the algorithm.

Definition at line 38 of file PileupTruthParticleSlimmer.cxx.

                                                  {
    ATH_MSG_DEBUG("Initializing");
    ATH_MSG_DEBUG("xAOD input TruthParticleContainer name = " << m_xaodTruthParticleContainerName );
    ATH_MSG_DEBUG("xAOD output TruthPileupParticleContainer name = " << m_xaodTruthPileupParticleContainerName );
    ATH_CHECK(m_classifier.retrieve());
    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_abseta_selection

double PileupTruthParticleSlimmer::m_abseta_selection

private

Definition at line 50 of file PileupTruthParticleSlimmer.h.

◆ m_classifier

ToolHandle<IMCTruthClassifier> PileupTruthParticleSlimmer::m_classifier

private

Definition at line 55 of file PileupTruthParticleSlimmer.h.

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

bool PileupTruthParticleSlimmer::m_forceRerun

private

a flag to force rerunning (useful for rerunning on ESDs)

Definition at line 53 of file PileupTruthParticleSlimmer.h.

◆ m_lepton_pt_selection

double PileupTruthParticleSlimmer::m_lepton_pt_selection

private

Definition at line 49 of file PileupTruthParticleSlimmer.h.

◆ m_photon_pt_selection

double PileupTruthParticleSlimmer::m_photon_pt_selection

private

Selection values for keeping photons and leptons.

Definition at line 48 of file PileupTruthParticleSlimmer.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.

◆ m_xaodTruthParticleContainerName

std::string PileupTruthParticleSlimmer::m_xaodTruthParticleContainerName

private

Definition at line 45 of file PileupTruthParticleSlimmer.h.

◆ m_xaodTruthPileupParticleContainerName

std::string PileupTruthParticleSlimmer::m_xaodTruthPileupParticleContainerName

private

The key for the output xAOD truth containers.

Definition at line 44 of file PileupTruthParticleSlimmer.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ PileupTruthParticleSlimmer()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_abseta_selection

◆ m_classifier

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_forceRerun

◆ m_lepton_pt_selection

◆ m_photon_pt_selection

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_xaodTruthParticleContainerName

◆ m_xaodTruthPileupParticleContainerName