This class represents the "type of event" where the type is given by one or more "characteristics". More...

#include <EventType.h>

Collaboration diagram for EventType:

Public Types
typedefs
typedef unsigned int	number_type

typedef std::vector< bool >	BitMask

typedef BitMask::const_iterator	BitMaskIterator

typedef BitMask::size_type	EventTypeCode

typedef std::pair< std::string, std::string >	NameTagPair

typedef std::vector< NameTagPair >	NameTagPairVec

Public Member Functions
structors
	EventType ()

virtual	~EventType ()

bool	operator< (const EventType &rhs) const
	Less than comparision needed to create e.g. set<EventType> More...

Accessors
bool	test (EventTypeCode type_code) const
	Tests for standard characteristics. More...

std::string	typeToString () const
	Access to standard characteristics in string for - for print out. More...

std::string	user_type (void) const
	Access to user type. More...

const std::string &	user_type_raw (void) const
	Access to user type. More...

void	get_detdescr_tags (NameTagPairVec &pairs) const
	Access DetDescr tags. More...

std::string	get_detdescr_tags () const
	Access DetDescr tags as a single string. More...

number_type	mc_channel_number () const
	Access to the MC generator channel number (was used as run number for generator events) More...

uint64_t	mc_event_number () const
	Access to the MC generator event number. More...

float	mc_event_weight (unsigned int iweight=0) const
	Access to MC weight. More...

unsigned int	n_mc_event_weights () const
	Total number of MC weights. More...

Iterator access to full set of standard characteristics
BitMaskIterator	bit_mask_begin (void) const

BitMaskIterator	bit_mask_end (void) const

const BitMask &	bit_mask () const

Static Public Attributes
The set of possible characteristic codes:
static const EventTypeCode	IS_SIMULATION = 0
	true: IS_SIMULATION, false: IS_DATA More...

static const EventTypeCode	IS_TESTBEAM = 1
	true: IS_TESTBEAM, false: IS_FROM_ATLAS_DET More...

static const EventTypeCode	IS_CALIBRATION = 2
	true: IS_CALIBRATION, false: IS_PHYSICS More...

Set characteristics:
BitMask	m_bit_mask

std::string	m_user_type

std::vector< float >	m_mc_event_weights

number_type	m_mc_channel_number

uint64_t	m_mc_event_number

void	add_type (EventTypeCode type_code)
	Add a new event type. More...

void	set_user_type (const std::string &user_type)
	Add user (string) type. More...

void	set_mc_channel_number (number_type chan)
	Add in the MC generator channel number (aka gen run number) More...

void	set_mc_event_number (uint64_t evt)
	Add in the MC generator event number. More...

void	set_mc_event_weight (float weight, unsigned int iweight=0, unsigned int nWeightsMax=0)
	Add in MC weight. For more than 1 weight, add with iweight > 0. More...

void	reset_detdescr_tags ()
	Reset DetDescr tags - to remove them from old EventInfo objects being read in. More...

Detailed Description

This class represents the "type of event" where the type is given by one or more "characteristics".

Standard characteristics:

IS_SIMULATION // false means IS_DATA
IS_TESTBEAM // false means IS_FROM_ATLAS_DET
IS_CALIBRATION // false means IS_PHYSICS

Since an event may have MORE than one characteristic, a testbeam simulation event would respond true to first two of the above characteristics, whereas an offline simulation event would respond true to ONLY IS_SIMULATION.

These are set with:

      void       add_type   (EventTypeCode type_code);

where the possible EventTypeCode's are provided as constants,
e.g.:

      static const EventTypeCode    IS_SIMULATION;

Thus, one would set IS_SIMULATION by:

      an_event_type.set_type_bit(EventType::IS_SIMULATION);

User-defined characteristics:

There is a possible to set and get a "user-defined" characteristic in terms of a string:

    void         add_type   (const string& user_type);
    const string&   user_type   (void) const;

Access to the full set of characteristics:

This is possible via:

      BitMaskIterator    bit_mask_begin (void) const;
      BitMaskIterator    bit_mask_end   (void) const;

Implementation details:

The full set of characteristics is provided by static constants. One may add new event characteristics BOTH by adding more static constants AND by providing the corresponding new boolean methods.

Definition at line 92 of file EventType.h.

Member Typedef Documentation

◆ BitMask

typedef std::vector<bool> EventType::BitMask

Definition at line 97 of file EventType.h.

◆ BitMaskIterator

typedef BitMask::const_iterator EventType::BitMaskIterator

Definition at line 98 of file EventType.h.

◆ EventTypeCode

typedef BitMask::size_type EventType::EventTypeCode

Definition at line 99 of file EventType.h.

◆ NameTagPair

typedef std::pair<std::string, std::string> EventType::NameTagPair

Definition at line 100 of file EventType.h.

◆ NameTagPairVec

typedef std::vector<NameTagPair> EventType::NameTagPairVec

Definition at line 101 of file EventType.h.

◆ number_type

typedef unsigned int EventType::number_type

Definition at line 96 of file EventType.h.

Constructor & Destructor Documentation

◆ EventType()

EventType::EventType ( )

Definition at line 24 of file EventType.cxx.

   : m_mc_event_weights(1, 1),
   m_mc_channel_number(0),
   m_mc_event_number(0)
  
 {}

◆ ~EventType()

EventType::~EventType ( )

virtual

Definition at line 32 of file EventType.cxx.

33 {}

Member Function Documentation

◆ add_type()

void EventType::add_type ( EventTypeCode type_code )

Add a new event type.

Definition at line 51 of file EventType.cxx.

                                            {
   if (m_bit_mask.size() <= type_code) m_bit_mask.resize(type_code + 1, false);
   m_bit_mask[type_code] = true;
 }

◆ bit_mask()

const EventType::BitMask & EventType::bit_mask ( ) const

Definition at line 192 of file EventType.cxx.

                           {
   return m_bit_mask;
 }

◆ bit_mask_begin()

EventType::BitMaskIterator EventType::bit_mask_begin ( void ) const

Definition at line 182 of file EventType.cxx.

                                     {
   return m_bit_mask.begin();
 }

◆ bit_mask_end()

EventType::BitMaskIterator EventType::bit_mask_end ( void ) const

Definition at line 187 of file EventType.cxx.

                                   {
   return m_bit_mask.end();
 }

◆ get_detdescr_tags() [1/2]

std::string EventType::get_detdescr_tags ( ) const

Access DetDescr tags as a single string.

Definition at line 151 of file EventType.cxx.

                                    {
   // Concatenate the dd tags to a single string
   NameTagPairVec pairs;
  
   get_detdescr_tags(pairs);
   std::string result;
   result.clear();
   for (unsigned int i = 0; i < pairs.size(); ++i) {
     result += pairs[i].first + ' ' + pairs[i].second + ' ';
   }
   return(result);
 }

◆ get_detdescr_tags() [2/2]

void EventType::get_detdescr_tags ( NameTagPairVec & pairs ) const

Access DetDescr tags.

Definition at line 113 of file EventType.cxx.

                                                         {
   // We must extract from m_user_type the dd tags for the moment to
   // avoid schema evolution.
  
   char sep = '#';
   bool done = false;
  
   std::string::size_type beg = m_user_type.find(sep);
   do {
     if (beg != std::string::npos) {
       std::string::size_type end1 = m_user_type.find(sep, beg + 1);
       if (end1 != std::string::npos) {
         std::string::size_type end2 = m_user_type.find(sep, end1 + 1);
         if (end2 != std::string::npos) {
           // end2 is a new separator
           std::string first = m_user_type.substr(beg + 1, end1 - beg - 1);
           std::string second = m_user_type.substr(end1 + 1, end2 - end1 - 1);
           pairs.push_back(NameTagPair(first, second));
  
           // continue with new beg
           beg = end2;
         } else {
           // end2 is the end of the string
           std::string first = m_user_type.substr(beg + 1, end1 - beg - 1);
           std::string second = m_user_type.substr(end1 + 1, m_user_type.size() - 1);
           pairs.push_back(NameTagPair(first, second));
           done = true; // finished
         }
       } else {
         done = true; // finished
       }
     } else {
       done = true; // finished
     }
   } while (!done);
 }

◆ mc_channel_number()

EventType::number_type EventType::mc_channel_number ( ) const

Access to the MC generator channel number (was used as run number for generator events)

Definition at line 165 of file EventType.cxx.

                                    {
   return m_mc_channel_number;
 }

◆ mc_event_number()

uint64_t EventType::mc_event_number ( ) const

Access to the MC generator event number.

Definition at line 170 of file EventType.cxx.

                                  {
   return m_mc_event_number;
 }

◆ mc_event_weight()

float EventType::mc_event_weight ( unsigned int iweight = 0 ) const

Access to MC weight.

Definition at line 175 of file EventType.cxx.

                                                      {
   if (iweight < m_mc_event_weights.size()) return m_mc_event_weights[iweight];
  
   return 0;
 }

◆ n_mc_event_weights()

unsigned int EventType::n_mc_event_weights ( ) const

Total number of MC weights.

Definition at line 214 of file EventType.cxx.

                                     {
   return (unsigned int) m_mc_event_weights.size();
 }

◆ operator<()

bool EventType::operator< ( const EventType & rhs ) const

Less than comparision needed to create e.g. set<EventType>

Definition at line 36 of file EventType.cxx.

                                                  {
   if (this->m_bit_mask.size() != rhs.m_bit_mask.size()) {
     return(this->m_bit_mask.size() < rhs.m_bit_mask.size());
   }
   for (BitMaskIterator i = this->bit_mask_begin(), j = rhs.bit_mask_begin();
        i != this->bit_mask_end(); ++i, ++j) {
     if (*i != *j) {
       return(*i < *j);
     }
   }
   return(this->m_user_type < rhs.m_user_type);
 }

◆ reset_detdescr_tags()

void EventType::reset_detdescr_tags ( )

Reset DetDescr tags - to remove them from old EventInfo objects being read in.

Definition at line 219 of file EventType.cxx.

                                {
   m_user_type = user_type();
 }

◆ set_mc_channel_number()

void EventType::set_mc_channel_number ( number_type chan )

Add in the MC generator channel number (aka gen run number)

Definition at line 197 of file EventType.cxx.

                                                  {
   m_mc_channel_number = chan;
 }

◆ set_mc_event_number()

void EventType::set_mc_event_number ( uint64_t evt )

Add in the MC generator event number.

Definition at line 202 of file EventType.cxx.

                                            {
   m_mc_event_number = evt;
 }

◆ set_mc_event_weight()

void EventType::set_mc_event_weight	(	float	weight,
		unsigned int	iweight = `0`,
		unsigned int	nWeightsMax = `0`
	)

Add in MC weight. For more than 1 weight, add with iweight > 0.

Definition at line 207 of file EventType.cxx.

                                                                                            {
   if (nWeightsMax > m_mc_event_weights.capacity()) m_mc_event_weights.reserve(nWeightsMax);
   if (m_mc_event_weights.size() <= iweight) m_mc_event_weights.resize(iweight + 1);
   m_mc_event_weights[iweight] = weight;
 }

◆ set_user_type()

void EventType::set_user_type ( const std::string & user_type )

Add user (string) type.

Definition at line 57 of file EventType.cxx.

                                                    {
   m_user_type = user_type;
 }

◆ test()

bool EventType::test ( EventTypeCode type_code ) const

Tests for standard characteristics.

Definition at line 62 of file EventType.cxx.

                                              {
   if (m_bit_mask.size() <= type_code) return false;
  
   return m_bit_mask[type_code];
 }

◆ typeToString()

std::string EventType::typeToString ( ) const

Access to standard characteristics in string for - for print out.

Definition at line 69 of file EventType.cxx.

                               {
   std::string result;
  
   result += "Event type: sim/data - ";
   if (test(EventType::IS_SIMULATION)) {
     result += " is sim ";
   } else {
     result += " is data ";
   }
   result += ", testbeam/atlas - ";
   if (test(EventType::IS_TESTBEAM)) {
     result += " is testbeam ";
   } else {
     result += " is atlas ";
   }
   result += ", calib/physics - ";
   if (test(EventType::IS_CALIBRATION)) {
     result += " is calib ";
   } else {
     result += " is physics ";
   }
   return(result);
 }

◆ user_type()

std::string EventType::user_type ( void ) const

Access to user type.

Definition at line 94 of file EventType.cxx.

                                {
   char sep = '#';
  
   std::string::size_type beg = m_user_type.find(sep);
   std::string user_type;
   if (beg != std::string::npos) {
     user_type = m_user_type.substr(0, beg);
   } else {
     user_type = m_user_type;
   }
   return user_type;
 }

◆ user_type_raw()

const std::string & EventType::user_type_raw ( void ) const

Access to user type.

Definition at line 108 of file EventType.cxx.

                                {
   return m_user_type;
 }

Member Data Documentation

◆ IS_CALIBRATION

const EventType::EventTypeCode EventType::IS_CALIBRATION = 2

static

true: IS_CALIBRATION, false: IS_PHYSICS

Definition at line 157 of file EventType.h.

◆ IS_SIMULATION

const EventType::EventTypeCode EventType::IS_SIMULATION = 0

static

true: IS_SIMULATION, false: IS_DATA

Definition at line 151 of file EventType.h.

◆ IS_TESTBEAM

const EventType::EventTypeCode EventType::IS_TESTBEAM = 1

static

true: IS_TESTBEAM, false: IS_FROM_ATLAS_DET

Definition at line 154 of file EventType.h.

◆ m_bit_mask

BitMask EventType::m_bit_mask

private

Definition at line 192 of file EventType.h.

◆ m_mc_channel_number

number_type EventType::m_mc_channel_number

private

Definition at line 195 of file EventType.h.

◆ m_mc_event_number

uint64_t EventType::m_mc_event_number

private

Definition at line 196 of file EventType.h.

◆ m_mc_event_weights

std::vector<float> EventType::m_mc_event_weights

private

Definition at line 194 of file EventType.h.

◆ m_user_type

std::string EventType::m_user_type

private

Definition at line 193 of file EventType.h.

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

Public Types

Public Member Functions

Static Public Attributes

Set characteristics:

Detailed Description

Member Typedef Documentation

◆ BitMask

◆ BitMaskIterator

◆ EventTypeCode

◆ NameTagPair

◆ NameTagPairVec

◆ number_type

Constructor & Destructor Documentation

◆ EventType()

◆ ~EventType()

Member Function Documentation

◆ add_type()

◆ bit_mask()

◆ bit_mask_begin()

◆ bit_mask_end()

◆ get_detdescr_tags() [1/2]

◆ get_detdescr_tags() [2/2]

◆ mc_channel_number()

◆ mc_event_number()

◆ mc_event_weight()

◆ n_mc_event_weights()

◆ operator<()

◆ reset_detdescr_tags()

◆ set_mc_channel_number()

◆ set_mc_event_number()

◆ set_mc_event_weight()

◆ set_user_type()

◆ test()

◆ typeToString()

◆ user_type()

◆ user_type_raw()

Member Data Documentation

◆ IS_CALIBRATION

◆ IS_SIMULATION

◆ IS_TESTBEAM

◆ m_bit_mask

◆ m_mc_channel_number

◆ m_mc_event_number

◆ m_mc_event_weights

◆ m_user_type