PileUpType Class Reference

For details on how the MC particles are defined and organized see https://twiki.cern.ch/twiki/bin/view/Atlas/PileupPerformance#MC_Truth_Task_Force_Recommendati. More...

#include <PileUpType.h>

Collaboration diagram for PileUpType:

Public Member Functions
	PileUpType (const McEventCollection *collection)
	need to pass the McEvntCollection this class does not own this collection and will NOT delete it at the end More...
const HepMC::GenEvent *	signal_mc_event () const
template<class Selector >
void	signal_particles (std::vector< HepMC::ConstGenParticlePtr > &particleList, const Selector &select) const
McEventCollection::const_iterator	in_time_minimum_bias_event_begin () const
	extract the in-time minimum bias McEvent Particles from the McEventCollection A pair of iterators is returned on all the McEventCollection More...
McEventCollection::const_iterator	in_time_minimum_bias_event_end () const
McEventCollection::const_iterator	signal_and_in_time_minimum_bias_event_begin () const
	extract the signal and the in-time minimum bias McEvent Particles from the McEventCollection A pair of iterators is returned on all the McEventCollection The signal is the first in the list More...
McEventCollection::const_iterator	signal_and_in_time_minimum_bias_event_end () const
template<class Selector >
void	in_time_minimum_bias_particles (std::vector< HepMC::ConstGenParticlePtr > &particleList, const Selector &select) const
McEventCollection::const_iterator	in_time_event_begin () const
	the in-time particles - this includes in the signal More...
McEventCollection::const_iterator	in_time_event_end () const
template<class Selector >
void	in_time_particles (std::vector< HepMC::ConstGenParticlePtr > &particleList, const Selector &select) const
template<class Selector >
void	particles_in_two_bunch_crossings (std::vector< HepMC::ConstGenParticlePtr > &particleList, const Selector &select) const
	return the MC events in [-2BC, +2BC], including the signal McEvent at BC=0 More...
template<class Selector >
void	particles_outside_two_bunch_crossings (std::vector< HepMC::ConstGenParticlePtr > &particleList, const Selector &select) const
	return the MC events in [-inf,-2BC] and [2BC,+inf], excluding the cavern background and the beam halo More...
template<class Selector >
void	cavern_background_particles (std::vector< HepMC::ConstGenParticlePtr > &particleList, const Selector &select) const
	return the MC events of the cavern background More...

Private Attributes
const McEventCollection *	m_particleList

Detailed Description

For details on how the MC particles are defined and organized see https://twiki.cern.ch/twiki/bin/view/Atlas/PileupPerformance#MC_Truth_Task_Force_Recommendati.

Todo:

Move this elsewhere – it does not implement the GenAccessIO API.

Definition at line 33 of file PileUpType.h.

Constructor & Destructor Documentation

PileUpType()

PileUpType::PileUpType

(

const McEventCollection *

collection

)

need to pass the McEvntCollection this class does not own this collection and will NOT delete it at the end

Definition at line 8 of file PileUpType.cxx.

                                                           {
    m_particleList = collection;
}

Member Function Documentation

cavern_background_particles()

template<class Selector >

void PileUpType::cavern_background_particles	(	std::vector< HepMC::ConstGenParticlePtr > &	particleList,
		const Selector &	select
	)		const

return the MC events of the cavern background

in_time_event_begin()

McEventCollection::const_iterator PileUpType::in_time_event_begin

(

)

const

the in-time particles - this includes in the signal

Definition at line 50 of file PileUpType.cxx.

                                                                      {
    return m_particleList->begin();
}

in_time_event_end()

McEventCollection::const_iterator PileUpType::in_time_event_end

(

)

const

Definition at line 55 of file PileUpType.cxx.

                                                                    {
    return this->in_time_minimum_bias_event_end(); //FIXME - we want ALL the in-time McEvents
}

in_time_minimum_bias_event_begin()

McEventCollection::const_iterator PileUpType::in_time_minimum_bias_event_begin

(

)

const

extract the in-time minimum bias McEvent Particles from the McEventCollection A pair of iterators is returned on all the McEventCollection

Definition at line 19 of file PileUpType.cxx.

                                                                                   {
    McEventCollection::const_iterator ibegin = m_particleList->begin();
    McEventCollection::const_iterator iend = m_particleList->end();
    if ( (ibegin!=iend) && (m_particleList->size()>1) ) {
        ++ibegin;
        return ibegin;
    }
    else return iend;
}

in_time_minimum_bias_event_end()

McEventCollection::const_iterator PileUpType::in_time_minimum_bias_event_end

(

)

const

Definition at line 30 of file PileUpType.cxx.

                                                                                 {
    McEventCollection::const_iterator ibegin = m_particleList->begin();
    McEventCollection::const_iterator iend = m_particleList->end();
    for ( ; ibegin != iend; ++ibegin ) {
        if ( (*ibegin)->event_number() == -1 && HepMC::signal_process_id(*ibegin) == 0 ) break;
    }
    return ibegin;
}

in_time_minimum_bias_particles()

template<class Selector >

void PileUpType::in_time_minimum_bias_particles	(	std::vector< HepMC::ConstGenParticlePtr > &	particleList,
		const Selector &	select
	)		const

in_time_particles()

template<class Selector >

void PileUpType::in_time_particles	(	std::vector< HepMC::ConstGenParticlePtr > &	particleList,
		const Selector &	select
	)		const

particles_in_two_bunch_crossings()

template<class Selector >

void PileUpType::particles_in_two_bunch_crossings	(	std::vector< HepMC::ConstGenParticlePtr > &	particleList,
		const Selector &	select
	)		const

return the MC events in [-2BC, +2BC], including the signal McEvent at BC=0

particles_outside_two_bunch_crossings()

template<class Selector >

void PileUpType::particles_outside_two_bunch_crossings	(	std::vector< HepMC::ConstGenParticlePtr > &	particleList,
		const Selector &	select
	)		const

return the MC events in [-inf,-2BC] and [2BC,+inf], excluding the cavern background and the beam halo

signal_and_in_time_minimum_bias_event_begin()

McEventCollection::const_iterator PileUpType::signal_and_in_time_minimum_bias_event_begin

(

)

const

extract the signal and the in-time minimum bias McEvent Particles from the McEventCollection A pair of iterators is returned on all the McEventCollection The signal is the first in the list

Definition at line 40 of file PileUpType.cxx.

                                                                                              {
    return m_particleList->begin();
}

signal_and_in_time_minimum_bias_event_end()

McEventCollection::const_iterator PileUpType::signal_and_in_time_minimum_bias_event_end

(

)

const

Definition at line 45 of file PileUpType.cxx.

                                                                                            {
    return this->in_time_minimum_bias_event_end();
}

signal_mc_event()

const HepMC::GenEvent * PileUpType::signal_mc_event

(

)

const

Definition at line 13 of file PileUpType.cxx.

                                                        {
    if ( m_particleList->size() > 0 ) return m_particleList->at(0);
    else return NULL;
}

signal_particles()

template<class Selector >

void PileUpType::signal_particles	(	std::vector< HepMC::ConstGenParticlePtr > &	particleList,
		const Selector &	select
	)		const

Member Data Documentation

m_particleList

const McEventCollection* PileUpType::m_particleList

private

Definition at line 88 of file PileUpType.h.

---

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

• PileUpType.h
• PileUpType.cxx