PileUpType.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
//*************************************************************************
//*                                                                       *
//*  class  PileUpType                                                   **
//*                                                                       *
//*  Returns iterators on the pileup type particles:
//*  - the  signal particles
//*  - the  in-time Minimum bias particles
//*  - the signal+in-time Minimum bias particles
//*  - the out-of-time Minimum bias particles
//*  - the cavern background particles
//*  - the Selector function MUST have the operator() implemented - for example: isGenStable
//*
// Author: Ketevi A. Assamagan <ketevi@bnl.gov>
// Date: February 2008                                                    *
//*************************************************************************
#ifndef TRUTHHELPER_PILEUPTYPE_H
#define TRUTHHELPER_PILEUPTYPE_H
 
#include "GeneratorObjects/McEventCollection.h"
#include "AtlasHepMC/GenEvent.h"
#include "AtlasHepMC/GenParticle.h"
 
#include <vector>
 
class PileUpType {
public:
 
    PileUpType(const McEventCollection * collection);
 
 
 
    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;
    McEventCollection::const_iterator in_time_minimum_bias_event_end() const;
 
    McEventCollection::const_iterator signal_and_in_time_minimum_bias_event_begin() const;
    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;
    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;
 
    template<class Selector>
    void particles_outside_two_bunch_crossings( std::vector<HepMC::ConstGenParticlePtr>& particleList,
            const Selector& select ) const;
 
    template<class Selector>
    void cavern_background_particles( std::vector<HepMC::ConstGenParticlePtr>& particleList,
                                      const Selector& select ) const;
 
private:
    const McEventCollection * m_particleList;
};
 
 
#include "InDetRecStatistics/PileUpType.icc"
 
 
#endif