PileUpClassification Class Reference

Utilities to retrieve GenEvents according to their pile-up type from the McEventCollection. More...

#include <PileUpClassification.h>

Collaboration diagram for PileUpClassification:

Public Types
enum	PileuType_t {   SIGNAL = 0 , ALL , INTIME , OUTOFTIME ,   RESTOFMB , CAVERN , ALLMINBIAS , UNKONW = 9999 }
	define some Pile-up classification Important : this classification is copied in McParticleAlgs/python/JobOptCfg.py report any modification here to this jobOption ! More...
typedef enum PileUpClassification::PileuType_t	PileuType_t
	define some Pile-up classification Important : this classification is copied in McParticleAlgs/python/JobOptCfg.py report any modification here to this jobOption !

Static Public Member Functions
static void	findEventIterators (PileuType_t putype, McEventCollection::const_iterator &fEvt, McEventCollection::const_iterator &lEvt)
	Find interval [fEvt,lEvt] containing all GenEvents of type putype from the McEventCollection.
static void	findEventIterators (PileuType_t putype, const McEventCollection *evts, size_t &firstIndex, size_t &lastIndex)
	Find interval [firstIndex,lastIndex] containing all GenEvents of type putype from the McEventCollection.
static PileuType_t	pileUpType (const McEventCollection *evts, size_t evtIndex)
	Return the type of pile-up event of the GenEvent number evtIndex in the McEventCollection.
static void	fillPileUpType (const McEventCollection *evts, std::vector< size_t > &evtToPUType)
	Fill evtToPUType so that entry i is the pile-up type of GenEvent number i inside the McEventCollection.

Detailed Description

Utilities to retrieve GenEvents according to their pile-up type from the McEventCollection.

The pile-up type is defined in https://twiki.cern.ch/twiki/bin/viewauth/Atlas/PileupDigitization#Arrangement_of_Truth_Information All utilities provided here rely on the above organisation.

Author

P.A. Delsart

Definition at line 23 of file PileUpClassification.h.

Member Typedef Documentation

PileuType_t

typedef enum PileUpClassification::PileuType_t PileUpClassification::PileuType_t

define some Pile-up classification Important : this classification is copied in McParticleAlgs/python/JobOptCfg.py report any modification here to this jobOption !

Member Enumeration Documentation

PileuType_t

enum PileUpClassification::PileuType_t

define some Pile-up classification Important : this classification is copied in McParticleAlgs/python/JobOptCfg.py report any modification here to this jobOption !

Enumerator
SIGNAL
ALL
INTIME
OUTOFTIME
RESTOFMB
CAVERN
ALLMINBIAS
UNKONW

Definition at line 29 of file PileUpClassification.h.

                           { SIGNAL = 0,
                             ALL,
                             INTIME, OUTOFTIME, RESTOFMB, CAVERN, ALLMINBIAS, UNKONW = 9999  } PileuType_t;

Member Function Documentation

fillPileUpType()

void PileUpClassification::fillPileUpType ( const McEventCollection * evts, std::vector< size_t > & evtToPUType )

static

Fill evtToPUType so that entry i is the pile-up type of GenEvent number i inside the McEventCollection.

Definition at line 93 of file PileUpClassification.cxx.

                                                                                                       {
  evtToPUType.resize(evts->size());
  McEventCollection::const_iterator fEvt = evts->begin();
  McEventCollection::const_iterator lEvt = evts->end();
  // 1st GenEvent is always SIGNAL
  evtToPUType[0] = SIGNAL; ++fEvt;
  // increment automatically following GenEvents
  PileuType_t type = INTIME;
  int c=1;
  for(; fEvt != lEvt; ++fEvt){
    if(HepMC::signal_process_id(*fEvt) == 0 ) type= (PileuType_t)(type+1);
    evtToPUType[c] = type;
    c++;
  }
 
}

findEventIterators() [1/2]

void PileUpClassification::findEventIterators ( PileuType_t putype, const McEventCollection * evts, size_t & firstIndex, size_t & lastIndex )

static

Find interval [firstIndex,lastIndex] containing all GenEvents of type putype from the McEventCollection.

Definition at line 66 of file PileUpClassification.cxx.

                                                                                                                                      {
 
  McEventCollection::const_iterator fEvt = evts->begin();
  McEventCollection::const_iterator lEvt = evts->end();
  findEventIterators(putype, fEvt, lEvt);
  firstIndex = fEvt - evts->begin();
  lastIndex  = lEvt - evts->begin();
}

findEventIterators() [2/2]

void PileUpClassification::findEventIterators ( PileuType_t putype, McEventCollection::const_iterator & fEvt, McEventCollection::const_iterator & lEvt )

static

Find interval [fEvt,lEvt] containing all GenEvents of type putype from the McEventCollection.

IMPORTANT : fEvt and lEvt are expected to be first and last iterators on the McEventCollection !

Definition at line 8 of file PileUpClassification.cxx.

                                                                                                                                              {
 
  McEventCollection::const_iterator maxIterator = lEvt;
  //McEventCollection::const_iterator minIterator = fEvt;
 
  int intervallN =-1; // -1 means no interval search.
 
 
  switch(putype){
  case SIGNAL:
    lEvt = fEvt; ++lEvt;
    break;
  case ALL:
    break;
  case INTIME:
    {
      // Special case : there's no SEPARATOR between SIGNAL and INTIME :
      ++fEvt; lEvt = fEvt; ++lEvt;
      for(; lEvt < maxIterator; ++lEvt){
        if(HepMC::signal_process_id(*lEvt) == 0 ) break;
      }
    break;
    }
  case OUTOFTIME:
    intervallN = 1;
    break;
  case RESTOFMB:
    intervallN = 2;
    break;
  case CAVERN:
    intervallN = 3;
    break;
  case ALLMINBIAS:
    ++fEvt;
    break;
  default:
    break;
  };
 
 
  // if needed, search the correct interval
  while(intervallN>0){
    for(; fEvt < maxIterator; ++fEvt){
      if( HepMC::signal_process_id(*fEvt) == 0 ) { ++fEvt; break; }
    }
    lEvt = fEvt;
    for(; lEvt < maxIterator; ++lEvt){
      if( HepMC::signal_process_id(*lEvt) == 0 ) break;
    }
    intervallN--;
  }
 
  // don't overstep your bounds!
  if (lEvt>maxIterator) lEvt=maxIterator;
  if (fEvt>maxIterator) fEvt=maxIterator;
 
}

pileUpType()

PileUpClassification::PileuType_t PileUpClassification::pileUpType ( const McEventCollection * evts, size_t evtIndex )

static

Return the type of pile-up event of the GenEvent number evtIndex in the McEventCollection.

Definition at line 75 of file PileUpClassification.cxx.

                                                                                                              {
  if(evtIndex == 0 ) return SIGNAL;
 
  McEventCollection::const_iterator fEvt = evts->begin();
  McEventCollection::const_iterator lEvt = evts->end();
  McEventCollection::const_iterator itEvt = fEvt;
  ++itEvt;
  PileuType_t type = INTIME;
  while( itEvt != lEvt){
    if( size_t(itEvt - fEvt) == evtIndex ){ return type ;}
    ++itEvt;
    if(HepMC::signal_process_id(*itEvt) == 0 ) {  // a SEPARATOR
      ++itEvt; type = (PileuType_t) (type+1); 
    }
  }
  return  UNKONW;
}

---

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

• PileUpClassification.h
• PileUpClassification.cxx