This service provides access to particle properties. More...

#include <src/ParticlePropertySvc.h>

Inheritance diagram for Gaudi::ParticlePropertySvc:

[legend]

Collaboration diagram for Gaudi::ParticlePropertySvc:

[legend]

Public Types
typedef ParticleProperty *	mapped_type

typedef std::map< int, mapped_type >	MapID

typedef std::map< std::string, mapped_type >	MapName

typedef std::map< int, mapped_type >	MapStdHepID

typedef std::map< int, mapped_type >	MapPythiaID

typedef VectPP::const_iterator	const_iterator

typedef VectPP::iterator	iterator

typedef std::vector< ParticleProperty * >	VectPP

Public Types inherited from extends< Service, IParticlePropertySvc >
using	base_class = extends
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Public Member Functions
StatusCode	initialize () override
	Initialise the service. More...

StatusCode	finalize () override
	Finalise the service. More...

StatusCode	push_back (const std::string &particle, int geantId, int jetsetId, double charge, double mass, double tlife, const std::string &evtName, int pythiaId, double maxWidth) override
	Create a new particle property. More...

StatusCode	push_back (ParticleProperty *pp) override
	Add a new particle property. More...

const_iterator	begin () const override
	Get a const reference to the beginning of the container. More...

const_iterator	end () const override
	Get a const reference to the end of the container. More...

int	size () const override
	Get the container size. More...

ParticleProperty *	find (int geantId) override
	Retrieve a property by geant3 id. More...

ParticleProperty *	find (const std::string &name) override
	Retrieve a property by particle name. More...

ParticleProperty *	findByStdHepID (int stdHepId) override
	Retrieve a property by StdHep id. More...

ParticleProperty *	findByPythiaID (int pythiaID) override
	Retrieve a property by Pythia id. More...

StatusCode	erase (int geantId) override
	Erase a property by geant3 id. More...

StatusCode	erase (const std::string &name) override
	Erase a property by particle name. More...

StatusCode	eraseByStdHepID (int stdHepId) override
	Erase a property by StdHep id ??? More...

	ParticlePropertySvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor. More...

Public Member Functions inherited from extends< Service, IParticlePropertySvc >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service. More...

StatusCode	sysStart () override
	Initialize Service. More...

StatusCode	sysStop () override
	Initialize Service. More...

StatusCode	sysFinalize () override
	Finalize Service. More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (const std::string &name) const override
	get the property by name More...

StatusCode	getProperty (const std::string &n, std::string &v) const override
	convert the property to the string More...

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...

bool	hasProperty (const std::string &name) const override
	Return true if we have a property with the given name. More...

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

Protected Member Functions
const ParticleProperty *	anti (const ParticleProperty *pp) const
	helper (protected) function to find an antiparticle for the given particle ID (StdHepID) More...

StatusCode	setAntiParticles ()
	helper (protected) function to set the valid particle<-->antiparticle relations More...

StatusCode	rebuild ()
	rebuild "the linear container" from the map More...

StatusCode	erase (const ParticleProperty *pp)
	remove particle property from all maps More...

StatusCode	parse (const std::string &file)
	parse the file More...

StatusCode	parse ()
	Parses the file and fill all the maps. More...

StatusCode	addParticles ()

bool	diff (const ParticleProperty o, const ParticleProperty n, const MSG::Level l=MSG::DEBUG) const

Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Private Attributes
Gaudi::Property< std::string >	m_filename

Gaudi::Property< std::vector< std::string > >	m_other {this, "OtherFiles", {}, "additional file names"}

Gaudi::Property< std::vector< std::string > >	m_particles

VectPP	m_vectpp
	Vector of all particle properties. More...

MapID	m_idmap
	Map for geant IDs. More...

MapName	m_namemap
	Map for particle names. More...

MapStdHepID	m_stdhepidmap
	Map for StdHep Ids. More...

MapPythiaID	m_pythiaidmap
	Map for Pythia Ids. More...

std::deque< ParticleProperty >	m_owned

std::set< std::string >	m_replaced

SmartIF< IFileAccess >	m_fileAccess

Additional Inherited Members
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::Property< int >	m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}

Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, " unused"}

Gaudi::Property< bool >	m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}

Gaudi::Property< bool >	m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}

Gaudi::Property< bool >	m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}

Gaudi::Property< bool >	m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}

Gaudi::Property< bool >	m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}

Gaudi::Property< bool >	m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Detailed Description

This service provides access to particle properties.

The settable property of this service is the ParticlePropertiesFile, an ASCII file containing the list of properties for the particles. The default file is: "$PARAMFILESROOT/data/ParticleTable.txt" or if $PARAMFILESROOT is not defined "ParticleTable.txt"

Author: Iain Last; Gloria Corti 8/11/1999 change default file from $CDF/particle.cdf to $LHCBDBASE/cdf/particle.cdf on Unix and use environment variable also on WinNT Also introduce finding of particle by StdHepID; Vanya BELYAEV

Date: 2006-09-22 1) Modified to add possibility to redefine properties of existing particles and to read additional files. New property "OtherFiles" (default is empty vector) is introduces. Service parsed additional files after the main one.

// read additional properties
ParticlePropertySvc.OtherFiles = {
   "$SOMELOCATION1/file1.txt" ,
   "$SOMELOCATION2/file2.txt"
} ;

2) Add possibility to modify only certain particles through the new property "Particles" (default is empty list), Each line is interpreted as a line in particle data table, e.g.

// redefine the properties of H_20 and H_30 particles:
ParticlePropertySvc.Particles = {
    "H_20 88 35 0.0 120.0 9.4e-26 Higgs'0 35 0.0e+00" ,
    "H_30 89 36 0.0  40.0 1.0e-12      A0 36 0.0e+00"
  } ;

The replaces/modified particles are reported.

Definition at line 82 of file ParticlePropertySvc.h.

Member Typedef Documentation

◆ const_iterator

typedef VectPP::const_iterator IParticlePropertySvc::const_iterator

Definition at line 36 of file IParticlePropertySvc.h.

◆ iterator

typedef VectPP::iterator IParticlePropertySvc::iterator

Definition at line 37 of file IParticlePropertySvc.h.

◆ MapID

typedef std::map<int, mapped_type> Gaudi::ParticlePropertySvc::MapID

Definition at line 86 of file ParticlePropertySvc.h.

◆ MapName

typedef std::map<std::string, mapped_type> Gaudi::ParticlePropertySvc::MapName

Definition at line 87 of file ParticlePropertySvc.h.

◆ mapped_type

typedef ParticleProperty* Gaudi::ParticlePropertySvc::mapped_type

Definition at line 85 of file ParticlePropertySvc.h.

◆ MapPythiaID

typedef std::map<int, mapped_type> Gaudi::ParticlePropertySvc::MapPythiaID

Definition at line 89 of file ParticlePropertySvc.h.

◆ MapStdHepID

typedef std::map<int, mapped_type> Gaudi::ParticlePropertySvc::MapStdHepID

Definition at line 88 of file ParticlePropertySvc.h.

◆ VectPP

typedef std::vector<ParticleProperty*> IParticlePropertySvc::VectPP

Definition at line 35 of file IParticlePropertySvc.h.

Constructor & Destructor Documentation

◆ ParticlePropertySvc()

Gaudi::ParticlePropertySvc::ParticlePropertySvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard Constructor.

Parameters

name	String with service name
svc	Pointer to service locator interface

Todo:: : remove reference to LHCb-specific environment variable

Definition at line 56 of file ParticlePropertySvc.cpp.

                                                                                     : base_class( name, svc ) {
     // Redefine the default name:
     if ( System::getEnv( "PARAMFILESROOT", m_filename.value() ) ) { m_filename.value() += "/data/ParticleTable.txt"; }
   }

Member Function Documentation

◆ addParticles()

StatusCode Gaudi::ParticlePropertySvc::addParticles ( )

protected

Definition at line 346 of file ParticlePropertySvc.cpp.

                                                {
     // loop over all "explicit" particles
     for ( const auto& item : m_particles ) {
       std::istringstream input( item );
       // get the name
       std::string p_name;
       int         p_geant;
       int         p_jetset;
       double      p_charge;
       double      p_mass;
       double      p_ltime;
       std::string p_evtgen;
       int         p_pythia;
       double      p_maxwid;
       if ( input >> p_name >> p_geant >> p_jetset >> p_charge >> p_mass >> p_ltime >> p_evtgen >> p_pythia >>
            p_maxwid ) {
         always() << " Add/Modify the particle: "
                  << " name='" << p_name << "'"
                  << " geant=" << p_geant << " jetset=" << p_jetset << " charge=" << p_charge << " mass=" << p_mass
                  << " ltime=" << p_ltime << " evtgen='" << p_evtgen << "'"
                  << " pythia=" << p_pythia << " maxwid=" << p_maxwid << endmsg;
         //
         StatusCode sc = push_back( p_name, p_geant, p_jetset, p_charge, p_mass * Gaudi::Units::GeV,
                                    p_ltime * Gaudi::Units::s, p_evtgen, p_pythia, p_maxwid * Gaudi::Units::GeV );
         if ( sc.isFailure() ) { return sc; } // RETURN
       } else {
         error() << " could not parse '" << item << "'" << endmsg;
         return StatusCode::FAILURE; // RETURN
       }
     }
     //
     return StatusCode::SUCCESS;
   }

◆ anti()

const ParticleProperty * Gaudi::ParticlePropertySvc::anti ( const ParticleProperty * pp ) const

protected

helper (protected) function to find an antiparticle for the given particle ID (StdHepID)

Helper (protected) function to find an antiparticle for the given particle ID (StdHepID)

Parameters

pp	pointer to particle property

Returns: pointer to antiparticle

Definition at line 294 of file ParticlePropertySvc.cpp.

                                                                                       {
     if ( !pp ) { return nullptr; }
     const int ID     = pp->pdgID();
     const int antiID = -1 * ID;
     for ( const auto& ap : m_vectpp ) {
       if ( ap && antiID == ap->pdgID() ) { return ap; } // RETURN
     };
     //
     return pp; // RETURN
   }

◆ begin()

const_iterator Gaudi::ParticlePropertySvc::begin ( ) const

inlineoverride

Get a const reference to the beginning of the container.

Definition at line 120 of file ParticlePropertySvc.h.

120 { return m_vectpp.begin(); }

std::vector::begin

T begin(T... args)

Gaudi::ParticlePropertySvc::m_vectpp

VectPP m_vectpp

Vector of all particle properties.

Definition: ParticlePropertySvc.h:177

◆ diff()

bool Gaudi::ParticlePropertySvc::diff	(	const ParticleProperty *	o,
		const ParticleProperty *	n,
		const MSG::Level	l = `MSG::DEBUG`
	)		const

protected

Definition at line 386 of file ParticlePropertySvc.cpp.

                                                                                                                {
     //
     if ( o == n ) { return false; }
     //
     auto& log = msgStream();
     log << l;
     if ( !o || !n ) {
       log << MSG::WARNING << " ParticleProperty* point to NULL" << endmsg;
       return true; // RETURN
     }
     //
     bool result = false;
     if ( o->particle() != n->particle() ) {
       result = true;
       log << " Name:'" << o->particle() << "'/'" << n->particle() << "'";
     }
     if ( o->geantID() != n->geantID() ) {
       result = true;
       log << " G3ID:" << o->geantID() << "/" << n->geantID() << "'";
     }
     if ( o->pdgID() != n->pdgID() ) {
       result = true;
       log << " PDGID:" << o->pdgID() << "/" << n->pdgID() << "'";
     }
     if ( o->pythiaID() != n->pythiaID() ) {
       result = true;
       log << " PYID:" << o->pythiaID() << "/" << n->pythiaID() << "'";
     }
     if ( o->charge() != n->charge() ) {
       result = true;
       log << " Q:" << o->charge() << "/" << n->charge() << "'";
     }
     if ( o->mass() != n->mass() ) {
       result = true;
       log << " M:" << o->mass() << "/" << n->mass() << "'";
     }
     if ( o->lifetime() != n->lifetime() ) {
       result = true;
       log << " T:" << o->lifetime() << "/" << n->lifetime() << "'";
     }
     if ( o->evtGenName() != n->evtGenName() ) {
       result = true;
       log << " EvtGen:" << o->evtGenName() << "/" << n->evtGenName() << "'";
     }
     if ( o->maxWidth() != n->maxWidth() ) {
       result = true;
       log << " WMAX:" << o->maxWidth() << "/" << n->maxWidth() << "'";
     }
     if ( result ) { log << endmsg; }
     //
     return result;
   }

◆ end()

const_iterator Gaudi::ParticlePropertySvc::end ( ) const

inlineoverride

Get a const reference to the end of the container.

Definition at line 122 of file ParticlePropertySvc.h.

122 { return m_vectpp.end(); }

std::vector::end

T end(T... args)

Gaudi::ParticlePropertySvc::m_vectpp

VectPP m_vectpp

Vector of all particle properties.

Definition: ParticlePropertySvc.h:177

◆ erase() [1/3]

StatusCode Gaudi::ParticlePropertySvc::erase ( int geantId )

inlineoverride

Erase a property by geant3 id.

Definition at line 134 of file ParticlePropertySvc.h.

134 { return erase( find( geantId ) ); }

Gaudi::ParticlePropertySvc::erase

StatusCode erase(int geantId) override

Erase a property by geant3 id.

Definition: ParticlePropertySvc.h:134

Gaudi::ParticlePropertySvc::find

ParticleProperty * find(int geantId) override

Retrieve a property by geant3 id.

Definition: ParticlePropertySvc.h:126

◆ erase() [2/3]

StatusCode Gaudi::ParticlePropertySvc::erase ( const std::string & name )

inlineoverride

Erase a property by particle name.

Definition at line 136 of file ParticlePropertySvc.h.

136 { return erase( find( name ) ); }

Gaudi::ParticlePropertySvc::erase

StatusCode erase(int geantId) override

Erase a property by geant3 id.

Definition: ParticlePropertySvc.h:134

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition: Service.cpp:284

Gaudi::ParticlePropertySvc::find

ParticleProperty * find(int geantId) override

Retrieve a property by geant3 id.

Definition: ParticlePropertySvc.h:126

◆ erase() [3/3]

StatusCode Gaudi::ParticlePropertySvc::erase ( const ParticleProperty * pp )

protected

remove particle property from all maps

Definition at line 212 of file ParticlePropertySvc.cpp.

                                                                     {
     if ( !pp ) { return StatusCode::FAILURE; }
 
     _remove_( m_idmap, pp );
     _remove_( m_namemap, pp );
     _remove_( m_stdhepidmap, pp );
     _remove_( m_pythiaidmap, pp );
     //
     return rebuild();
   }

◆ eraseByStdHepID()

StatusCode Gaudi::ParticlePropertySvc::eraseByStdHepID ( int stdHepId )

inlineoverride

Erase a property by StdHep id ???

Definition at line 138 of file ParticlePropertySvc.h.

138 { return erase( findByStdHepID( stdHepId ) ); }

Gaudi::ParticlePropertySvc::erase

StatusCode erase(int geantId) override

Erase a property by geant3 id.

Definition: ParticlePropertySvc.h:134

Gaudi::ParticlePropertySvc::findByStdHepID

ParticleProperty * findByStdHepID(int stdHepId) override

Retrieve a property by StdHep id.

Definition: ParticlePropertySvc.h:130

◆ finalize()

StatusCode Gaudi::ParticlePropertySvc::finalize ( )

override

Finalise the service.

finalize

finalize the base class

Definition at line 115 of file ParticlePropertySvc.cpp.

                                            {
     if ( !m_other.empty() ) {
       info() << "Additional Properties have been read from files: " << Gaudi::Utils::toString( m_other ) << endmsg;
     }
 
     if ( !m_replaced.empty() ) {
       always() << "Properties have been redefined for " << m_replaced.size()
                << " particles : " << Gaudi::Utils::toString( m_replaced ) << endmsg;
     }
 
     m_fileAccess.reset();
 
     return Service::finalize();
   }

◆ find() [1/2]

ParticleProperty* Gaudi::ParticlePropertySvc::find ( int geantId )

inlineoverride

Retrieve a property by geant3 id.

Definition at line 126 of file ParticlePropertySvc.h.

126 { return m_idmap[geantId]; }

Gaudi::ParticlePropertySvc::m_idmap

MapID m_idmap

Map for geant IDs.

Definition: ParticlePropertySvc.h:178

◆ find() [2/2]

ParticleProperty* Gaudi::ParticlePropertySvc::find ( const std::string & name )

inlineoverride

Retrieve a property by particle name.

Definition at line 128 of file ParticlePropertySvc.h.

128 { return m_namemap[name]; }

Gaudi::ParticlePropertySvc::m_namemap

MapName m_namemap

Map for particle names.

Definition: ParticlePropertySvc.h:179

Service::name

const std::string & name() const override

Retrieve name of the service.

Definition: Service.cpp:284

◆ findByPythiaID()

ParticleProperty* Gaudi::ParticlePropertySvc::findByPythiaID ( int pythiaID )

inlineoverride

Retrieve a property by Pythia id.

Definition at line 132 of file ParticlePropertySvc.h.

132 { return m_pythiaidmap[pythiaID]; }

Gaudi::ParticlePropertySvc::m_pythiaidmap

MapPythiaID m_pythiaidmap

Map for Pythia Ids.

Definition: ParticlePropertySvc.h:181

◆ findByStdHepID()

ParticleProperty* Gaudi::ParticlePropertySvc::findByStdHepID ( int stdHepId )

inlineoverride

Retrieve a property by StdHep id.

Definition at line 130 of file ParticlePropertySvc.h.

130 { return m_stdhepidmap[stdHepId]; }

Gaudi::ParticlePropertySvc::m_stdhepidmap

MapStdHepID m_stdhepidmap

Map for StdHep Ids.

Definition: ParticlePropertySvc.h:180

◆ initialize()

StatusCode Gaudi::ParticlePropertySvc::initialize ( )

override

Initialise the service.

initialize the service and setProperties

Definition at line 64 of file ParticlePropertySvc.cpp.

                                              {
     StatusCode sc = Service::initialize();
     if ( sc.isFailure() ) { return sc; }
 
     sc = setProperties();
     if ( sc.isFailure() ) {
       error() << " Could not set the properties " << endmsg;
       return sc;
     }
 
     m_fileAccess = service( "VFSSvc" );
     if ( !m_fileAccess ) {
       error() << " Cannot retrieve the VFS service " << endmsg;
       return StatusCode::FAILURE;
     }
 
     sc = parse();
     if ( sc.isFailure() ) {
       error() << " Could not parse the file " << endmsg;
       return sc;
     }
     if ( !m_particles.empty() ) {
       sc = addParticles();
       if ( sc.isFailure() ) {
         error() << " Could not treat particles! " << endmsg;
         return sc;
       }
     }
     debug() << "ParticleProperties parsed successfully" << endmsg;
 
     debug() << "Access properties" << endmsg;
     // For debugging purposes print out the size of the internal maps
     // particle name as key: all particles in database are present here
     debug() << "NameMap size =" << m_namemap.size() << endmsg;
     // Geant3 ID as key: all particles in database are present here
     debug() << "GeantID Map size =" << m_idmap.size() << endmsg;
     // StdHep ID as key: some particles have no valid StdHep ID
     debug() << "StdHepID Map size =" << m_stdhepidmap.size() << endmsg;
     // Pythia ID as key: some particles are not defined in Pythia
     debug() << "PythiaID Map size =" << m_pythiaidmap.size() << endmsg;
 
     if ( !m_replaced.empty() ) {
       info() << "Properties have been redefined for " << m_replaced.size()
              << " particles : " << Gaudi::Utils::toString( m_replaced ) << endmsg;
     }
 
     return StatusCode::SUCCESS;
   }

◆ parse() [1/2]

StatusCode Gaudi::ParticlePropertySvc::parse ( const std::string & file )

protected

parse the file

Definition at line 248 of file ParticlePropertySvc.cpp.

                                                                {
     auto infile = ( m_fileAccess ? m_fileAccess->open( file ) : nullptr );
     if ( !infile ) {
       error() << "Unable to open properties file : " << file << endmsg;
       return StatusCode::FAILURE;
     }
 
     StatusCode sc = StatusCode::SUCCESS;
     info() << "Opened particle properties file : " << file << endmsg;
 
     std::vector<std::string> tokens;
     tokens.reserve( 9 );
     std::string line;
     while ( std::getline( *infile, line ) ) {
       // parse each line of the file (comment lines begin with # in the cdf
       // file,
       if ( line.front() == '#' ) continue;
 
       tokens.clear();
       ba::trim_left_if( line, ba::is_space() );
       ba::split( tokens, line, ba::is_space(), boost::token_compress_on );
       if ( tokens.size() != 9 ) continue;
 
       auto gid = std::stoi( tokens[1] );
       auto jid = std::stoi( tokens[2] );
       // Change the particles that do not correspond to a pdg number
       if ( jid == 0 ) jid = 10000000 * gid;
 
       // add a particle property
       sc = push_back( tokens[0], gid, jid, std::stod( tokens[3] ), std::stod( tokens[4] ) * Gaudi::Units::GeV,
                       std::stod( tokens[5] ) * Gaudi::Units::s, tokens[6], std::stoi( tokens[7] ),
                       std::stod( tokens[8] ) * Gaudi::Units::GeV );
 
       if ( sc.isFailure() ) {
         error() << "Error from ParticlePropertySvc::push_back for particle='" << tokens[0] << "'" << endmsg;
       }
     }
     return StatusCode::SUCCESS;
   }

◆ parse() [2/2]

StatusCode Gaudi::ParticlePropertySvc::parse ( )

protected

Parses the file and fill all the maps.

Definition at line 225 of file ParticlePropertySvc.cpp.

                                         {
 
     // parse "the main" file
     StatusCode sc = parse( m_filename );
     if ( sc.isFailure() ) { return sc; }
 
     // parse "other" files
     for ( auto& file : m_other ) {
       sc = parse( file );
       if ( sc.isFailure() ) { return sc; }
     }
 
     // Now check that the file format was consistent with what parser
     // expected
     if ( m_namemap.empty() ) {
       error() << "Format of input file inconsistent with what expected"
               << " - Check you are using ParticleData.txt" << endmsg;
       return StatusCode::FAILURE;
     }
 
     return sc;
   }

◆ push_back() [1/2]

StatusCode Gaudi::ParticlePropertySvc::push_back	(	const std::string &	particle,
		int	geantId,
		int	jetsetId,
		double	charge,
		double	mass,
		double	tlife,
		const std::string &	evtName,
		int	pythiaId,
		double	maxWidth
	)

override

Create a new particle property.

Create a particle property and insert it in the maps.

Attention: ParticlePropertySvc IS the owner if this property! @paramparticle String name of the particle.

Parameters

geantId	Geant3 ID of the particle.
jetsetId	Jetset ID of the particle.
charge	Particle charge (/e).
mass	Particle mass (GeV).
tlife	Particle lifetime (s).
evtName	String name of the particle in EvtGen.
pythiaId	Pythia ID of the particle.

Returns: StatusCode - SUCCESS if the particle property was added.

Definition at line 133 of file ParticlePropertySvc.cpp.

                                                                {
     //
     auto& pp = m_owned.emplace_back( particle, geantId, jetsetId, charge, mass, tlife, evtName, pythiaId, maxWidth );
     return push_back( &pp );
   }

◆ push_back() [2/2]

StatusCode Gaudi::ParticlePropertySvc::push_back ( ParticleProperty * pp )

override

Add a new particle property.

Add a particle property.

Attention: ParticlePropertySvc is not the owner of this property!

Parameters

pp,a	particle property class.

Returns: StatusCode - SUCCESS if the particle property was added.

Definition at line 143 of file ParticlePropertySvc.cpp.

                                                                   {
     if ( !pp ) { return StatusCode::FAILURE; }
     //
     { // try to add into Geant(3)ID map
       const int ID = pp->geantID();
       // is this already in the map?
       auto ifind = m_idmap.find( ID );
       if ( m_idmap.end() != ifind && 0 != m_idmap[ID] ) {
         diff( ifind->second, pp );
         m_replaced.insert( m_idmap[ID]->particle() );
       }
       // put it into the map
       m_idmap[ID] = pp;
     }
     //
     { // try to add into Name map
       const std::string& particle = pp->particle();
       // is this already in the map?
       auto ifind = m_namemap.find( particle );
       if ( ifind != m_namemap.end() && ifind->second ) {
         diff( ifind->second, pp );
         m_replaced.insert( ifind->second->particle() );
       }
       // put it into the map
       m_namemap[particle] = pp;
     }
     //
     // add to StdHep map only if StdHep ID different from zero and if
     // not Cerenkov (StdHep ID = gamma)
     if ( 0 != pp->jetsetID() && "Tcherenkov" != pp->particle() ) { // try to add into StdHepID map
       const int ID = pp->jetsetID();
       // is this already in the map?
       auto ifind = m_stdhepidmap.find( ID );
       if ( m_stdhepidmap.end() != ifind && ifind->second ) {
         diff( ifind->second, pp );
         m_replaced.insert( ifind->second->particle() );
       }
       // put it into the map
       m_stdhepidmap[ID] = pp;
     }
     //
     // add to Pythia map only if Pythia ID is different from
     // zero ( StdHep id is always different from zero in this case )
     if ( 0 != pp->pythiaID() && 0 != pp->jetsetID() && "Tcherenkov" != pp->particle() ) { // try to add into PythiaID
                                                                                           // map
       const int ID = pp->pythiaID();
       // is this already in the map?
       auto ifind = m_pythiaidmap.find( ID );
       if ( m_pythiaidmap.end() != ifind && ifind->second ) {
         diff( ifind->second, pp );
         m_replaced.insert( ifind->second->particle() );
       }
       // put it into the map
       m_pythiaidmap[ID] = pp;
     }
     //
     return rebuild();
   }

◆ rebuild()

StatusCode Gaudi::ParticlePropertySvc::rebuild ( )

protected

rebuild "the linear container" from the map

Definition at line 330 of file ParticlePropertySvc.cpp.

                                           {
     std::set<mapped_type> local;
     m_vectpp.clear();
     m_vectpp.reserve( m_idmap.size() + 100 );
     // load information from maps into the set
     _load_( m_idmap, local );
     _load_( m_namemap, local );
     _load_( m_stdhepidmap, local );
     _load_( m_pythiaidmap, local );
     // load information from set to the linear container vector
     std::copy( std::begin( local ), std::end( local ), std::back_inserter( m_vectpp ) );
     return setAntiParticles();
   }

◆ setAntiParticles()

StatusCode Gaudi::ParticlePropertySvc::setAntiParticles ( )

protected

helper (protected) function to set the valid particle<-->antiparticle relations

Returns: status code

Definition at line 310 of file ParticlePropertySvc.cpp.

                                                    {
     // initialize particle<-->antiParticle relations
     for ( auto& pp : m_vectpp ) {
       if ( !pp ) { continue; } // CONTINUE
       const ParticleProperty* ap = anti( pp );
       if ( ap ) { pp->setAntiParticle( ap ); }
     }
     return StatusCode::SUCCESS;
   }

◆ size()

int Gaudi::ParticlePropertySvc::size ( ) const

inlineoverride

Get the container size.

Definition at line 124 of file ParticlePropertySvc.h.

124 { return m_vectpp.size(); };

std::vector::size

T size(T... args)

Gaudi::ParticlePropertySvc::m_vectpp

VectPP m_vectpp

Vector of all particle properties.

Definition: ParticlePropertySvc.h:177

Member Data Documentation

◆ m_fileAccess

SmartIF<IFileAccess> Gaudi::ParticlePropertySvc::m_fileAccess

private

Definition at line 187 of file ParticlePropertySvc.h.

◆ m_filename

Gaudi::Property<std::string> Gaudi::ParticlePropertySvc::m_filename

private

Initial value:

{this, "ParticlePropertiesFile", "ParticleTable.txt",

"Filename of the particle properties file"}

Definition at line 171 of file ParticlePropertySvc.h.

◆ m_idmap

MapID Gaudi::ParticlePropertySvc::m_idmap

private

Map for geant IDs.

Definition at line 178 of file ParticlePropertySvc.h.

◆ m_namemap

MapName Gaudi::ParticlePropertySvc::m_namemap

private

Map for particle names.

Definition at line 179 of file ParticlePropertySvc.h.

◆ m_other

Gaudi::Property<std::vector<std::string> > Gaudi::ParticlePropertySvc::m_other {this, "OtherFiles", {}, "additional file names"}

private

Definition at line 173 of file ParticlePropertySvc.h.

◆ m_owned

std::deque<ParticleProperty> Gaudi::ParticlePropertySvc::m_owned

private

Definition at line 184 of file ParticlePropertySvc.h.

◆ m_particles

Gaudi::Property<std::vector<std::string> > Gaudi::ParticlePropertySvc::m_particles

private

Initial value:

{

this, "Particles", {}, "properties to be redefined explicitly"}

Definition at line 174 of file ParticlePropertySvc.h.

◆ m_pythiaidmap

MapPythiaID Gaudi::ParticlePropertySvc::m_pythiaidmap

private

Map for Pythia Ids.

Definition at line 181 of file ParticlePropertySvc.h.

◆ m_replaced

std::set<std::string> Gaudi::ParticlePropertySvc::m_replaced

private

Definition at line 185 of file ParticlePropertySvc.h.

◆ m_stdhepidmap

MapStdHepID Gaudi::ParticlePropertySvc::m_stdhepidmap

private

Map for StdHep Ids.

Definition at line 180 of file ParticlePropertySvc.h.

◆ m_vectpp

VectPP Gaudi::ParticlePropertySvc::m_vectpp

private

Vector of all particle properties.

Definition at line 177 of file ParticlePropertySvc.h.

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

GaudiPartProp/src/ParticlePropertySvc.h
GaudiPartProp/src/ParticlePropertySvc.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ MapID

◆ MapName

◆ mapped_type

◆ MapPythiaID

◆ MapStdHepID

◆ VectPP

Constructor & Destructor Documentation

◆ ParticlePropertySvc()

Member Function Documentation

◆ addParticles()

◆ anti()

◆ begin()

◆ diff()

◆ end()

◆ erase() [1/3]

◆ erase() [2/3]

◆ erase() [3/3]

◆ eraseByStdHepID()

◆ finalize()

◆ find() [1/2]

◆ find() [2/2]

◆ findByPythiaID()

◆ findByStdHepID()

◆ initialize()

◆ parse() [1/2]

◆ parse() [2/2]

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ rebuild()

◆ setAntiParticles()

◆ size()

Member Data Documentation

◆ m_fileAccess

◆ m_filename

◆ m_idmap

◆ m_namemap

◆ m_other

◆ m_owned

◆ m_particles

◆ m_pythiaidmap

◆ m_replaced

◆ m_stdhepidmap

◆ m_vectpp