A trivial class to hold information about a single particle properties. More...

#include <Gaudi/ParticleProperty.h>

Collaboration diagram for ParticleProperty:

[legend]

Classes
struct	Compare

Public Member Functions
	ParticleProperty (const std::string &name, const Gaudi::ParticleID &pid, const double charge, const double mass, const double tlife, const double maxWidth, const std::string &evtgen, const int pythia)
	full constructor, from all data (except the antiparticle )

	ParticleProperty (const std::string &name, const Gaudi::ParticleID &pid, const double charge, const double mass, const double tlife, const double maxWidth)
	a bit simplified constructor, from all data (except the antiparticle )

const std::string &	particle () const
	Get the particle name.

const std::string &	name () const
	Get the particle name.

const Gaudi::ParticleID &	particleID () const
	get the particle ID

const Gaudi::ParticleID &	pdgID () const
	get the particle ID

const Gaudi::ParticleID &	pid () const
	get the particle ID

double	charge () const
	Get the particle charge.

double	mass () const
	Get the particle mass.

double	lifetime () const
	Get the particle lifetime.

double	lifeTime () const
	Get the particle lifetime.

double	ctau () const
	Get the particle proper lifetime in c*tau units.

double	width () const
	Get the particle natural width.

double	maxWidth () const
	Get the max width deviation.

const Gaudi::ParticleProperty *	antiParticle () const
	get the pointer to the anti-particle

const Gaudi::ParticleProperty *	anti () const
	get the pointer to the anti-particle

bool	selfcc () const
	self-charge conjugated?

int	threeCharge () const
	Three times the charge (in positron charge units)

void	setAntiParticle (const ParticleProperty *p)
	set the pointer to the antiparticle

const std::string &	evtGenName () const
	Get the EvtGen name.

const std::string &	evtGen () const
	Get the EvtGen name.

int	pythiaID () const
	Get the Pythia ID.

int	pythia () const
	Get the Pythia ID.

	operator const Gaudi::ParticleID & () const
	implicit conversion to ParticleID class

std::ostream &	fillStream (std::ostream &s) const
	the standard (a'la Gaudi) printout of the object

std::string	toString () const
	simple method for conversion into the string

Private Attributes
std::string	m_name
	the name for the particle

Gaudi::ParticleID	m_pid
	the PID for the particle

double	m_charge
	the charge for the particle

double	m_mass
	the nominal mass for the particle

double	m_tlife
	the nominal proper lifetime for the particle

double	m_maxWidth
	The maximum width deviation.

std::string	m_evtgen
	the name of the particle for EvtGen program

int	m_pythia
	the ID for the particle used in Pythia generator

const Gaudi::ParticleProperty *	m_anti
	the pointer to the anti-particle

Friends
bool	operator< (const ParticleProperty &lhs, const ParticleProperty &rhs)
	comparison/ordering operator ( "strict-less-by-PID&Name" )

Detailed Description

A trivial class to hold information about a single particle properties.

All particle properties are accessible through accessor functions

Author: Iain Last,G.Corti; Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Constructor & Destructor Documentation

◆ ParticleProperty() [1/2]

Gaudi::ParticleProperty::ParticleProperty	(	const std::string &	name,
		const Gaudi::ParticleID &	pid,
		const double	charge,
		const double	mass,
		const double	tlife,
		const double	maxWidth,
		const std::string &	evtgen,
		const int	pythia )

full constructor, from all data (except the antiparticle )

Parameters

name	the name for the particle
pid	the PID for the particle
charge	the charge of the particle
mass	the nominal mass of the particle
tlife	the nominal lifetime of the particle
maxWidth	the maximal width of the particle (used in generator)
evtgen	the name of particle in EvtGen program
pythia	the ID for the particle used in Pythia generator

Definition at line 41 of file ParticleProperty.cpp.

    : m_name( name )
    , m_pid( pid )
    , m_charge( charge )
    , m_mass( mass )
    , m_tlife( tlife )
    , m_maxWidth( maxWidth )
    , m_evtgen( evtgen )
    , m_pythia( pythia )
    , m_anti( 0 ) {}

◆ ParticleProperty() [2/2]

Gaudi::ParticleProperty::ParticleProperty	(	const std::string &	name,
		const Gaudi::ParticleID &	pid,
		const double	charge,
		const double	mass,
		const double	tlife,
		const double	maxWidth )

a bit simplified constructor, from all data (except the antiparticle )

"evtGenName" is set from the regular "name"
pythiaID is set from the regular PID

Parameters

name	the name for the particle
pid	the PID for the particle
charge	the charge of the particle
mass	the nominal mass of the particle
tlife	the nominal lifetime of the particle
maxWidth	the maximal width of the particle (used in generator)

Definition at line 65 of file ParticleProperty.cpp.

    : m_name( name )
    , m_pid( pid )
    , m_charge( charge )
    , m_mass( mass )
    , m_tlife( tlife )
    , m_maxWidth( maxWidth )
    , m_evtgen( name )
    , m_pythia( pid.pid() )
    , m_anti( 0 ) {}

Member Function Documentation

◆ anti()

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

inline

get the pointer to the anti-particle

Definition at line 106 of file ParticleProperty.h.

106{ return m_anti; }

◆ antiParticle()

const Gaudi::ParticleProperty * Gaudi::ParticleProperty::antiParticle ( ) const

inline

get the pointer to the anti-particle

Definition at line 104 of file ParticleProperty.h.

104{ return anti(); }

◆ charge()

double Gaudi::ParticleProperty::charge ( ) const

inline

Get the particle charge.

Definition at line 88 of file ParticleProperty.h.

88{ return m_charge; }

◆ ctau()

double Gaudi::ParticleProperty::ctau ( ) const

inline

Get the particle proper lifetime in c*tau units.

Definition at line 96 of file ParticleProperty.h.

96{ return Gaudi::Units::c_light * lifeTime(); }

Gaudi::Units::c_light

constexpr double c_light

Definition PhysicalConstants.h:65

◆ evtGen()

const std::string & Gaudi::ParticleProperty::evtGen ( ) const

inline

Get the EvtGen name.

Definition at line 123 of file ParticleProperty.h.

123{ return m_evtgen; }

◆ evtGenName()

const std::string & Gaudi::ParticleProperty::evtGenName ( ) const

inline

Get the EvtGen name.

Definition at line 121 of file ParticleProperty.h.

121{ return m_evtgen; }

◆ fillStream()

std::ostream & Gaudi::ParticleProperty::fillStream ( std::ostream & s ) const

the standard (a'la Gaudi) printout of the object

Parameters

s	reference to the output stream

Returns: reference to the output stream

Definition at line 80 of file ParticleProperty.cpp.

                                                                   {
  //
  typedef boost::format BF;
  //
  // name & code
  s << BF( "%1$-14s %|16t| PDG:%2$9d," ) % name() % particleID().pid();
#ifdef __INTEL_COMPILER             // Disable ICC remark
#  pragma warning( disable : 1572 ) // Floating-point equality and inequality comparisons are unreliable
#  pragma warning( push )
#endif
  // charge
  if ( 0 == charge() ) {
    s << " Q:   0";
  } else if ( 1.0 == charge() ) {
    s << " Q:  +1";
  } else if ( -1.0 == charge() ) {
    s << " Q:  -1";
  } else if ( 2.0 == charge() ) {
    s << " Q:  +2";
  } else if ( -2.0 == charge() ) {
    s << " Q:  -2";
  } else if ( 0.3 == charge() ) {
    s << " Q:+1/3";
  } else if ( -0.3 == charge() ) {
    s << " Q:-1/3";
  } else if ( 0.7 == charge() ) {
    s << " Q:+2/3";
  } else if ( -0.7 == charge() ) {
    s << " Q:-2/3";
  } else {
    s << BF( " Q:%|+3.1f|," ) % float( charge() );
  }
#ifdef __INTEL_COMPILER // Re-enable ICC remark
#  pragma warning( pop )
#endif
  // mass
  if ( mass() < 1 * Gaudi::Units::MeV ) {
    s << BF( ", mass:%|9.6g| keV" ) % ( mass() / Gaudi::Units::keV );
  } else if ( mass() < 1 * Gaudi::Units::GeV ) {
    s << BF( ", mass:%|9.6g| MeV" ) % ( mass() / Gaudi::Units::MeV );
  } else {
    s << BF( ", mass:%|9.6g| GeV" ) % ( mass() / Gaudi::Units::GeV );
  }
  // lifetime
  if ( 1 * Gaudi::Units::km < ctau() ) {
    s << ", lifetime: infinity  ";
  } else if ( 0 == lifeTime() ) {
  } // ATTENTION!!
  else if ( 1 * Gaudi::Units::meter < ctau() ) {
    s << BF( ",  ctau:%|12.6g| m" ) % ( ctau() / Gaudi::Units::meter );
  } else if ( 1 * Gaudi::Units::cm < ctau() ) {
    s << BF( ",  ctau:%|11.6g| cm" ) % ( ctau() / Gaudi::Units::cm );
  } else if ( 0.5 * Gaudi::Units::mm < ctau() ) {
    s << BF( ",  ctau:%|11.6g| mm" ) % ( ctau() / Gaudi::Units::mm );
  } else if ( 0.1 * Gaudi::Units::micrometer < ctau() ) {
    s << BF( ",  ctau:%|11.6g| um" ) % ( ctau() / Gaudi::Units::micrometer );
  } else if ( 1 * Gaudi::Units::GeV <= width() ) {
    s << BF( ", width:%|10.6g| GeV" ) % ( width() / Gaudi::Units::GeV );
  } else if ( 1 * Gaudi::Units::MeV <= width() ) {
    s << BF( ", width:%|10.6g| MeV" ) % ( width() / Gaudi::Units::MeV );
  } else if ( 1 * Gaudi::Units::keV <= width() ) {
    s << BF( ", width:%|10.6g| keV" ) % ( width() / Gaudi::Units::keV );
  } else if ( 1 * Gaudi::Units::eV <= width() ) {
    s << BF( ", width:%|10.6g| eV" ) % ( width() / Gaudi::Units::eV );
  } else {
    s << BF( ", ltime:%|12.6g| ns" ) % ( lifetime() / Gaudi::Units::ns );
  }
  // Evt Gen name
  if ( evtGen() != name() ) { s << BF( ", EvtGen: %|-10s|" ) % evtGen(); }
  // pythia ID
  if ( m_pid.pid() != pythia() ) { s << BF( ", Pythia: %|-9d|" ) % pythia(); }
  return s;
}

◆ lifeTime()

double Gaudi::ParticleProperty::lifeTime ( ) const

inline

Get the particle lifetime.

Definition at line 94 of file ParticleProperty.h.

94{ return m_tlife; }

◆ lifetime()

double Gaudi::ParticleProperty::lifetime ( ) const

inline

Get the particle lifetime.

Definition at line 92 of file ParticleProperty.h.

92{ return m_tlife; }

◆ mass()

double Gaudi::ParticleProperty::mass ( ) const

inline

Get the particle mass.

Definition at line 90 of file ParticleProperty.h.

90{ return m_mass; }

◆ maxWidth()

double Gaudi::ParticleProperty::maxWidth ( ) const

inline

Get the max width deviation.

Definition at line 102 of file ParticleProperty.h.

102{ return m_maxWidth; } // max-width

◆ name()

const std::string & Gaudi::ParticleProperty::name ( ) const

inline

Get the particle name.

Definition at line 80 of file ParticleProperty.h.

80{ return m_name; }

◆ operator const Gaudi::ParticleID &()

Gaudi::ParticleProperty::operator const Gaudi::ParticleID & ( ) const

inline

implicit conversion to ParticleID class

Definition at line 135 of file ParticleProperty.h.

135{ return m_pid; }

◆ particle()

const std::string & Gaudi::ParticleProperty::particle ( ) const

inline

Get the particle name.

Definition at line 78 of file ParticleProperty.h.

78{ return m_name; }

◆ particleID()

const Gaudi::ParticleID & Gaudi::ParticleProperty::particleID ( ) const

inline

get the particle ID

Definition at line 82 of file ParticleProperty.h.

82{ return m_pid; }

◆ pdgID()

const Gaudi::ParticleID & Gaudi::ParticleProperty::pdgID ( ) const

inline

get the particle ID

Definition at line 84 of file ParticleProperty.h.

84{ return m_pid; }

◆ pid()

const Gaudi::ParticleID & Gaudi::ParticleProperty::pid ( ) const

inline

get the particle ID

Definition at line 86 of file ParticleProperty.h.

86{ return m_pid; }

◆ pythia()

int Gaudi::ParticleProperty::pythia ( ) const

inline

Get the Pythia ID.

Definition at line 127 of file ParticleProperty.h.

127{ return m_pythia; }

◆ pythiaID()

int Gaudi::ParticleProperty::pythiaID ( ) const

inline

Get the Pythia ID.

Definition at line 125 of file ParticleProperty.h.

125{ return m_pythia; }

◆ selfcc()

bool Gaudi::ParticleProperty::selfcc ( ) const

inline

self-charge conjugated?

Definition at line 109 of file ParticleProperty.h.

109{ return m_anti == this; }

◆ setAntiParticle()

void Gaudi::ParticleProperty::setAntiParticle ( const ParticleProperty * p )

set the pointer to the antiparticle

Attention: it is the only one "setter"

Parameters

p	pointer to anti-particle

Definition at line 163 of file ParticleProperty.cpp.

163{ m_anti = p; }

◆ threeCharge()

int Gaudi::ParticleProperty::threeCharge ( ) const

inline

Three times the charge (in positron charge units)

Definition at line 112 of file ParticleProperty.h.

112{ return m_pid.threeCharge(); }

Gaudi::ParticleID::threeCharge

int threeCharge() const

Return three times the charge, in units of e+, valid for all particles.

Definition ParticleID.cpp:269

◆ toString()

std::string Gaudi::ParticleProperty::toString ( ) const

simple method for conversion into the string

Definition at line 154 of file ParticleProperty.cpp.

                                                {
  std::ostringstream s;
  fillStream( s );
  return s.str();
}

◆ width()

double Gaudi::ParticleProperty::width ( ) const

inline

Get the particle natural width.

Definition at line 98 of file ParticleProperty.h.

                         {
      return std::abs( ctau() ) < std::numeric_limits<double>::epsilon() ? 0.0 : Gaudi::Units::hbarc / ctau();
    }

Friends And Related Symbol Documentation

◆ operator<

bool operator<	(	const ParticleProperty &	lhs,
		const ParticleProperty &	rhs )

friend

comparison/ordering operator ( "strict-less-by-PID&Name" )

Definition at line 130 of file ParticleProperty.h.

                                                                                      {
      return std::tie( lhs.m_pid, lhs.m_name ) < std::tie( rhs.m_pid, rhs.m_name );
    }

Member Data Documentation

◆ m_anti

const Gaudi::ParticleProperty* Gaudi::ParticleProperty::m_anti

private

the pointer to the anti-particle

Definition at line 163 of file ParticleProperty.h.

◆ m_charge

double Gaudi::ParticleProperty::m_charge

private

the charge for the particle

Definition at line 151 of file ParticleProperty.h.

◆ m_evtgen

std::string Gaudi::ParticleProperty::m_evtgen

private

the name of the particle for EvtGen program

Definition at line 159 of file ParticleProperty.h.

◆ m_mass

double Gaudi::ParticleProperty::m_mass

private

the nominal mass for the particle

Definition at line 153 of file ParticleProperty.h.

◆ m_maxWidth

double Gaudi::ParticleProperty::m_maxWidth

private

The maximum width deviation.

Definition at line 157 of file ParticleProperty.h.

◆ m_name

std::string Gaudi::ParticleProperty::m_name

private

the name for the particle

Definition at line 147 of file ParticleProperty.h.

◆ m_pid

Gaudi::ParticleID Gaudi::ParticleProperty::m_pid

private

the PID for the particle

Definition at line 149 of file ParticleProperty.h.

◆ m_pythia

int Gaudi::ParticleProperty::m_pythia

private

the ID for the particle used in Pythia generator

Definition at line 161 of file ParticleProperty.h.

◆ m_tlife

double Gaudi::ParticleProperty::m_tlife

private

the nominal proper lifetime for the particle

Definition at line 155 of file ParticleProperty.h.

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

GaudiPartProp/include/Gaudi/ParticleProperty.h
GaudiPartProp/src/ParticleProperty.cpp

Classes

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ParticleProperty() [1/2]

◆ ParticleProperty() [2/2]

Member Function Documentation

◆ anti()

◆ antiParticle()

◆ charge()

◆ ctau()

◆ evtGen()

◆ evtGenName()

◆ fillStream()

◆ lifeTime()

◆ lifetime()

◆ mass()

◆ maxWidth()

◆ name()

◆ operator const Gaudi::ParticleID &()

◆ particle()

◆ particleID()

◆ pdgID()

◆ pid()

◆ pythia()

◆ pythiaID()

◆ selfcc()

◆ setAntiParticle()

◆ threeCharge()

◆ toString()

◆ width()

Friends And Related Symbol Documentation

◆ operator<

Member Data Documentation

◆ m_anti

◆ m_charge

◆ m_evtgen

◆ m_mass

◆ m_maxWidth

◆ m_name

◆ m_pid

◆ m_pythia

◆ m_tlife