A simple wrapper for std::list<int> to model a list of particle identity candidates. More...

#include <ParticleCandidateList.h>

Inheritance diagram for ParticleCandidateList:

Collaboration diagram for ParticleCandidateList:

Public Member Functions
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

list typedefs: it behaves like a std::list<int>
typedef std::list< int >::iterator	iterator
typedef std::list< int >::const_iterator	const_iterator
typedef std::list< int >::size_type	size_type
	ParticleCandidateList ()
	Default constructor:
	ParticleCandidateList (const ParticleCandidateList &rhs)
	Copy constructor:
virtual	~ParticleCandidateList ()
	Destructor:
ParticleCandidateList &	operator= (const ParticleCandidateList &rhs)
	Assignment operator:
bool	hasInList (const int &pdgID, const bool tightMatch=false) const
	Tells if a given particle or pID is in the list if tightMatch = false : look only if std::abs() of particle data group id-s matches.
void	dropList () const
const std::list< int > &	list () const
	Return the wrapped STL list.

forward some of the std::list<int> const methods
std::list< int >	m_list
const_iterator	begin () const
const_iterator	end () const
bool	empty () const
size_type	size () const
size_type	max_size () const
void	push_back (const int &id)
	forward the std::list<int>::push_back() method
void	clear ()
	forward the std::list<int>::clear() method
void	addLeptons ()
	Non-const methods:
void	addLightJets ()
void	addLightQuarks ()
void	addBQuark ()
void	addBbarQuark ()
void	addBQuarks ()
void	addBjet ()
void	addWBosons ()
void	addZBoson ()
void	add (const int &partID)
void	add (const std::string &listOfParticlesName="LightQuarks")

Detailed Description

A simple wrapper for std::list<int> to model a list of particle identity candidates.

This candidate list is used by the PdgIdFilter and McVtxFilter to select for particles which might fulfill some criterion (well in our case this is its Particle Data Group identity.

Definition at line 29 of file ParticleCandidateList.h.

Member Typedef Documentation

◆ const_iterator

typedef std::list<int>::const_iterator ParticleCandidateList::const_iterator

Definition at line 41 of file ParticleCandidateList.h.

◆ iterator

typedef std::list<int>::iterator ParticleCandidateList::iterator

Definition at line 40 of file ParticleCandidateList.h.

◆ size_type

typedef std::list<int>::size_type ParticleCandidateList::size_type

Definition at line 42 of file ParticleCandidateList.h.

Constructor & Destructor Documentation

◆ ParticleCandidateList() [1/2]

ParticleCandidateList::ParticleCandidateList ( )

Default constructor:

Definition at line 19 of file ParticleCandidateList.cxx.

20 : AthMessaging ("ParticleCandidateList")

21{}

AthMessaging::AthMessaging

AthMessaging()

Default constructor:

◆ ParticleCandidateList() [2/2]

ParticleCandidateList::ParticleCandidateList ( const ParticleCandidateList & rhs )

Copy constructor:

Definition at line 23 of file ParticleCandidateList.cxx.

  : AthMessaging ("ParticleCandidateList"),
    m_list(rhs.m_list)
{}

◆ ~ParticleCandidateList()

ParticleCandidateList::~ParticleCandidateList ( )

inlinevirtual

Destructor:

Definition at line 124 of file ParticleCandidateList.h.

125{}

Member Function Documentation

◆ add() [1/2]

void ParticleCandidateList::add ( const int & partID )

inline

Definition at line 185 of file ParticleCandidateList.h.

{
  push_back( partID );
}

◆ add() [2/2]

void ParticleCandidateList::add ( const std::string & listOfParticlesName = "LightQuarks" )

Definition at line 122 of file ParticleCandidateList.cxx.

{
  ATH_MSG_VERBOSE( "add( " << list << " )" );
  if ( list == "LightQuarks" )    addLightQuarks();
  else if ( list == "BQuark" )    addBQuark();
  else if ( list == "BbarQuark" ) addBbarQuark();
  else if ( list == "BQuarks" )   addBQuarks();
  else if ( list == "Bjet" ||
        list == "BJet"      ) addBjet();
  else if ( list == "Leptons" || 
        list == "leptons" )   addLeptons();
  else if ( list == "W+/-" )      addWBosons();
  else if ( list == "Z0" )        addZBoson();
  else {
    static const std::string error( "Unknown Candidate List Name !!" );
    ATH_MSG_ERROR( error );
    throw GaudiException( error, "ParticleCandidateList", 
              StatusCode::FAILURE );
  }
 
  if ( msg().level() <= MSG::VERBOSE ) { dropList(); 
  }
 
}

◆ addBbarQuark()

void ParticleCandidateList::addBbarQuark ( )

inline

Definition at line 195 of file ParticleCandidateList.h.

{
  add( -MC::BQUARK ); //> b_bar
}

◆ addBjet()

void ParticleCandidateList::addBjet ( )

inline

Definition at line 206 of file ParticleCandidateList.h.

{
  add( MC::BQUARK      ); //> b
  add( -MC::BQUARK ); //> b_bar
}

◆ addBQuark()

void ParticleCandidateList::addBQuark ( )

inline

Definition at line 190 of file ParticleCandidateList.h.

{
  add( MC::BQUARK ); //> b
}

◆ addBQuarks()

void ParticleCandidateList::addBQuarks ( )

inline

Definition at line 200 of file ParticleCandidateList.h.

{
  add( MC::BQUARK      ); //> b
  add( -MC::BQUARK ); //> b_bar
}

◆ addLeptons()

void ParticleCandidateList::addLeptons ( )

Non-const methods:

Definition at line 75 of file ParticleCandidateList.cxx.

{
  m_list.push_back( MC::ELECTRON   ); //>e-
  m_list.push_back( MC::POSITRON    ); //>e+
  m_list.push_back( MC::NU_E      ); //>nu_e
  m_list.push_back( -MC::NU_E ); //>nu_e_bar
 
  m_list.push_back( MC::MUON  ); //>mu-
  m_list.push_back( -MC::MUON   ); //>mu+
  m_list.push_back( MC::NU_MU     ); //>nuMu
  m_list.push_back( -MC::NU_MU ); //>nuMu_bar
 
  m_list.push_back( MC::TAU  ); //>tau-
  m_list.push_back( -MC::TAU   ); //>tau+
  m_list.push_back( MC::NU_TAU     ); //>nuTau
  m_list.push_back( -MC::NU_TAU ); //>nuTau_bar
}

◆ addLightJets()

void ParticleCandidateList::addLightJets ( )

To cope with Full Reconstruction scheme : a light-jet, is a jet which could not have been tagged One has also to add PDG::null to the matching list

Definition at line 93 of file ParticleCandidateList.cxx.

{
  m_list.push_back( 0 ); //> untagged jet : so taken light
 
  m_list.push_back( MC::DQUARK      ); //> d
  m_list.push_back( -MC::DQUARK ); //> d_bar
  m_list.push_back( MC::UQUARK      ); //> u
  m_list.push_back( -MC::UQUARK ); //> u_bar
  m_list.push_back( MC::CQUARK      ); //> c
  m_list.push_back( -MC::CQUARK ); //> c_bar
  m_list.push_back( MC::SQUARK      ); //> s
  m_list.push_back( -MC::SQUARK ); //> s_bar
}

◆ addLightQuarks()

void ParticleCandidateList::addLightQuarks ( )

Definition at line 110 of file ParticleCandidateList.cxx.

{
  m_list.push_back( MC::DQUARK      ); //> d
  m_list.push_back( -MC::DQUARK ); //> d_bar
  m_list.push_back( MC::UQUARK      ); //> u
  m_list.push_back( -MC::UQUARK ); //> u_bar
  m_list.push_back( MC::CQUARK      ); //> c
  m_list.push_back( -MC::CQUARK ); //> c_bar
  m_list.push_back( MC::SQUARK      ); //> s
  m_list.push_back( -MC::SQUARK ); //> s_bar
}

◆ addWBosons()

void ParticleCandidateList::addWBosons ( )

inline

Definition at line 212 of file ParticleCandidateList.h.

{
  add( MC::WPLUSBOSON  ); //> W+
  add( -MC::WPLUSBOSON ); //> W-
 }

◆ addZBoson()

void ParticleCandidateList::addZBoson ( )

inline

Definition at line 218 of file ParticleCandidateList.h.

{
  add( MC::Z0BOSON );
}

◆ begin()

ParticleCandidateList::const_iterator ParticleCandidateList::begin ( ) const

inline

Definition at line 145 of file ParticleCandidateList.h.

{
  return m_list.begin();
}

◆ clear()

void ParticleCandidateList::clear ( )

inline

forward the std::list<int>::clear() method

Definition at line 180 of file ParticleCandidateList.h.

{
  m_list.clear();
}

◆ dropList()

void ParticleCandidateList::dropList ( ) const

Definition at line 59 of file ParticleCandidateList.cxx.

{
  ATH_MSG_VERBOSE("---------------------------------------------------\n"
                  << "Added those particles : " );
  for ( auto itrPart = m_list.begin();
    itrPart != m_list.end();
    ++itrPart ) {
    ATH_MSG_VERBOSE( "\tpdgID= " << (*itrPart) );
  }
 
  ATH_MSG_VERBOSE ("---------------------------------------------------" );
}

◆ empty()

bool ParticleCandidateList::empty ( ) const

inline

Definition at line 155 of file ParticleCandidateList.h.

{
  return m_list.empty();
}

◆ end()

ParticleCandidateList::const_iterator ParticleCandidateList::end ( ) const

inline

Definition at line 150 of file ParticleCandidateList.h.

{
  return m_list.end();
}

◆ hasInList()

bool ParticleCandidateList::hasInList	(	const int &	pdgID,
		const bool	tightMatch = false ) const

Tells if a given particle or pID is in the list if tightMatch = false : look only if std::abs() of particle data group id-s matches.

Definition at line 29 of file ParticleCandidateList.cxx.

{
  ATH_MSG_VERBOSE( "In ParticleCandidateList::hasInList( pdgID ) : " << this
                   << endmsg
                   << "Size of List = " << size() );
  if ( size() <= unsigned(0) ) {
    static const std::string error( "List size <=0 !!" );
    ATH_MSG_ERROR( error );
    throw GaudiException( error, "ParticleCandidateList", 
              StatusCode::FAILURE );
  }
 
  for ( auto itrPart = m_list.begin();
    itrPart != m_list.end();
    ++itrPart ) {//> Loop over the list of intern particles
    ATH_MSG_VERBOSE( "in loop over list of intern particle candidates"
                     << "\t>>>Comparing pid-s..." );
    if ( tightMatch && ( (*itrPart) == pdgID ) ) {
      ATH_MSG_VERBOSE( ">>> " << pdgID << " is in list (" << (*itrPart) << ")" );
      return true;
    } else if ( !tightMatch && 
        std::abs( (*itrPart) ) == std::abs( pdgID ) ) {
      return true;
    }
  }//> end loop over the list of intern particles
 
  return false;
}

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ list()

const std::list< int > & ParticleCandidateList::list ( ) const

inline

Return the wrapped STL list.

Definition at line 140 of file ParticleCandidateList.h.

{
  return m_list;
}

◆ max_size()

ParticleCandidateList::size_type ParticleCandidateList::max_size ( ) const

inline

Definition at line 165 of file ParticleCandidateList.h.

{
  return m_list.max_size();
}

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 163 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 178 of file AthMessaging.h.

179{ return msg() << lvl; }

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ operator=()

ParticleCandidateList & ParticleCandidateList::operator= ( const ParticleCandidateList & rhs )

inline

Assignment operator:

Definition at line 129 of file ParticleCandidateList.h.

{
  if ( this != &rhs ) {
    m_list = rhs.m_list;
  }
  return *this;
}

◆ push_back()

void ParticleCandidateList::push_back ( const int & id )

inline

forward the std::list<int>::push_back() method

Definition at line 175 of file ParticleCandidateList.h.

{
  m_list.push_back( partID );
}

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

◆ size()

ParticleCandidateList::size_type ParticleCandidateList::size ( ) const

inline

Definition at line 160 of file ParticleCandidateList.h.

{
  return m_list.size();
}

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_list

std::list<int> ParticleCandidateList::m_list

protected

Definition at line 120 of file ParticleCandidateList.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

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

Public Member Functions

Private Member Functions

Private Attributes

list typedefs: it behaves like a std::list<int>

forward some of the std::list<int> const methods

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ size_type

Constructor & Destructor Documentation

◆ ParticleCandidateList() [1/2]

◆ ParticleCandidateList() [2/2]

◆ ~ParticleCandidateList()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ addBbarQuark()

◆ addBjet()

◆ addBQuark()

◆ addBQuarks()

◆ addLeptons()

◆ addLightJets()

◆ addLightQuarks()

◆ addWBosons()

◆ addZBoson()

◆ begin()

◆ clear()

◆ dropList()

◆ empty()

◆ end()

◆ hasInList()

◆ initMessaging()

◆ list()

◆ max_size()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator=()

◆ push_back()

◆ setLevel()

◆ size()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_imsg

◆ m_list

◆ m_lvl

◆ m_msg_tls

◆ m_nm