The generic ISF particle definition,. More...

#include <ISFParticle.h>

Collaboration diagram for ISF::ISFParticle:

Public Member Functions
	ISFParticle ()=delete
	disallow default constructor
	ISFParticle (const Amg::Vector3D &pos, const Amg::Vector3D &mom, double mass, double charge, int pdgCode, int status, double time, const ISFParticle &parent, int id, int barcode=HepMC::UNDEFINED_ID, TruthBinding truth=nullptr, const HepMcParticleLink partLink=nullptr)
	use this constructor whenever possible
	ISFParticle (const HepGeom::Point3D< double > &pos, const HepGeom::Vector3D< double > &mom, double mass, double charge, int pdgCode, int status, double time, const ISFParticle &parent, int id, int barcode=HepMC::UNDEFINED_ID, TruthBinding truth=nullptr, const HepMcParticleLink partLink=nullptr)
	CLHEP-compatible constructor.
	ISFParticle (const Amg::Vector3D &pos, const Amg::Vector3D &mom, double mass, double charge, int pdgCode, int status, double time, const DetRegionSvcIDPair &origin, int id, int barcode=HepMC::UNDEFINED_ID, TruthBinding truth=nullptr, const HepMcParticleLink partLink=nullptr)
	this constructor should only be used for event read-in
	ISFParticle (const ISFParticle &isfp)
	Copy constructor.
	ISFParticle (ISFParticle &&isfp)
	Move copy constructor.
	~ISFParticle ()
	Destructor.
ISFParticle &	operator= (const ISFParticle &rhs)
	Assignment operator.
ISFParticle &	operator= (ISFParticle &&rhs)
	Move assignment operator.
bool	operator== (const ISFParticle &rhs) const
	Comparisons.
bool	isEqual (const ISFParticle &rhs) const
bool	isIdent (const ISFParticle &rhs) const
const Amg::Vector3D &	momentum () const
	The current momentum vector of the ISFParticle.
const Amg::Vector3D &	position () const
	The current position of the ISFParticle.
void	updatePosition (const Amg::Vector3D &position)
	Update the position of the ISFParticle.
void	updateMomentum (const Amg::Vector3D &momentum)
	Update the momentum of the ISFParticle.
double	mass () const
	mass of the particle
double	charge () const
	charge of the particle
double	timeStamp () const
	Timestamp of the ISFParticle.
int	pdgCode () const
	PDG value.
double	ekin () const
	Kinetic energy.
const ParticleHistory &	history () const
	the particle's full history
AtlasDetDescr::AtlasRegion	originGeoID () const
	the sub-detector ID the particle's originates from
SimSvcID	originSimID () const
	the simulation service the particle originates from
AtlasDetDescr::AtlasRegion	prevGeoID () const
	previous geoID that the particle was simulated in
SimSvcID	prevSimID () const
	the simulation service that previously treated this particle
AtlasDetDescr::AtlasRegion	nextGeoID () const
	next geoID the particle will be simulated in
SimSvcID	nextSimID () const
	the next simulation service the particle will be sent to
void	setNextGeoID (AtlasDetDescr::AtlasRegion geoID)
	register the next AtlasDetDescr::AtlasRegion
void	setNextSimID (SimSvcID simID)
	register the next SimSvcID
int	barcode () const
	the barcode
void	setBarcode (int bc)
	set a new barcode
int	id () const
	unique ID
void	setId (int id)
	set a new unique ID
const TruthBinding *	getTruthBinding () const
	pointer to the simulation truth - optional, can be 0
TruthBinding *	getTruthBinding ()
void	setTruthBinding (TruthBinding *truth)
const HepMcParticleLink *	getParticleLink () const
	HepMcParticleLink accessors.
void	setParticleLink (const HepMcParticleLink *partLink)
ParticleOrder	getOrder () const
	return the particle order (eg used to assure ID->Calo->MS simulation order)
void	setOrder (ParticleOrder order)
const ParticleUserInformation *	getUserInformation () const
	get/set ParticleUserInformation
ParticleUserInformation *	getUserInformation ()
void	setUserInformation (ParticleUserInformation *userInfo)
MsgStream &	dump (MsgStream &out) const
	Dump methods to be used by the overloaded stream operator (inheritance!)
std::ostream &	dump (std::ostream &out) const
void	setStatus (int a)
int	status () const

Private Attributes
Amg::Vector3D	m_position
Amg::Vector3D	m_momentum
double	m_mass
double	m_charge
int	m_pdgCode
int	m_status
double	m_tstamp
ParticleHistory	m_history
int	m_barcode
	barcode TODO remove in favour of m_status + m_uid
int	m_uid
TruthBinding *	m_truth
	< unique ID
ParticleOrder	m_order
	particle simulation order
ParticleUserInformation *	m_userInfo
	user information stored with the ISFParticle
const HepMcParticleLink *	m_partLink

Detailed Description

The generic ISF particle definition,.

Author: Andreas.Salzburger -at- cern.ch , Elmar.Ritsch -at- cern.ch

Definition at line 42 of file ISFParticle.h.

Constructor & Destructor Documentation

◆ ISFParticle() [1/6]

ISF::ISFParticle::ISFParticle ( )

delete

disallow default constructor

◆ ISFParticle() [2/6]

ISF::ISFParticle::ISFParticle	(	const Amg::Vector3D &	pos,
		const Amg::Vector3D &	mom,
		double	mass,
		double	charge,
		int	pdgCode,
		int	status,
		double	time,
		const ISFParticle &	parent,
		int	id,
		int	barcode = HepMC::UNDEFINED_ID,
		TruthBinding *	truth = nullptr,
		const HepMcParticleLink *	partLink = nullptr )

use this constructor whenever possible

Definition at line 9 of file ISFParticle.cxx.

                                                                :
  m_position(pos),
  m_momentum(mom),
  m_mass(mass),
  m_charge(charge),
  m_pdgCode(pdgCode),
  m_status(status),
  m_tstamp(time),
  m_history(parent.history()),
  m_barcode(barcode), // TODO drop this soon
  m_uid(id),
  m_truth(truth),
  m_order(ISF::DefaultParticleOrder),
  m_userInfo(nullptr),
  m_partLink(partLink)
{
 
}

◆ ISFParticle() [3/6]

ISF::ISFParticle::ISFParticle	(	const HepGeom::Point3D< double > &	pos,
		const HepGeom::Vector3D< double > &	mom,
		double	mass,
		double	charge,
		int	pdgCode,
		int	status,
		double	time,
		const ISFParticle &	parent,
		int	id,
		int	barcode = HepMC::UNDEFINED_ID,
		TruthBinding *	truth = nullptr,
		const HepMcParticleLink *	partLink = nullptr )

CLHEP-compatible constructor.

Definition at line 40 of file ISFParticle.cxx.

                                                                :
  m_position( pos.x(), pos.y(), pos.z()),
  m_momentum( mom.x(), mom.y(), mom.z()),
  m_mass(mass),
  m_charge(charge),
  m_pdgCode(pdgCode),
  m_status(status),
  m_tstamp(time),
  m_history(parent.history()),
  m_barcode(barcode), // TODO drop this soon
  m_uid(id),
  m_truth(truth),
  m_order(ISF::DefaultParticleOrder),
  m_userInfo(nullptr),
  m_partLink(partLink)
{
 
}

◆ ISFParticle() [4/6]

ISF::ISFParticle::ISFParticle	(	const Amg::Vector3D &	pos,
		const Amg::Vector3D &	mom,
		double	mass,
		double	charge,
		int	pdgCode,
		int	status,
		double	time,
		const DetRegionSvcIDPair &	origin,
		int	id,
		int	barcode = HepMC::UNDEFINED_ID,
		TruthBinding *	truth = nullptr,
		const HepMcParticleLink *	partLink = nullptr )

this constructor should only be used for event read-in

Definition at line 71 of file ISFParticle.cxx.

                                                                :
  m_position(pos),
  m_momentum(mom),
  m_mass(mass),
  m_charge(charge),
  m_pdgCode(pdgCode),
  m_status(status),
  m_tstamp(time),
  m_history(1, origin),
  m_barcode(barcode), // TODO drop this soon
  m_uid(id),
  m_truth(truth),
  m_order(ISF::DefaultParticleOrder),
  m_userInfo(nullptr),
  m_partLink(partLink)
{
 
}

◆ ISFParticle() [5/6]

ISF::ISFParticle::ISFParticle ( const ISFParticle & isfp )

Copy constructor.

Definition at line 102 of file ISFParticle.cxx.

                                                  :
  m_position(isfp.position()),
  m_momentum(isfp.momentum()),
  m_mass(isfp.mass()),
  m_charge(isfp.charge()),
  m_pdgCode(isfp.pdgCode()),
  m_status(isfp.status()),
  m_tstamp(isfp.timeStamp()),
  m_history(isfp.history()),
  m_barcode(isfp.barcode()), // TODO drop this soon
  m_uid(isfp.id()),
  m_truth(nullptr),
  m_order(ISF::DefaultParticleOrder),
  m_userInfo(nullptr)
{
  const TruthBinding *truth = isfp.getTruthBinding();
  if (truth) {
    m_truth = new TruthBinding(*truth);
  }
  m_partLink = ((isfp.getParticleLink()) ? new HepMcParticleLink(*isfp.getParticleLink()) : nullptr);
}

◆ ISFParticle() [6/6]

ISF::ISFParticle::ISFParticle ( ISFParticle && isfp )

Move copy constructor.

Definition at line 124 of file ISFParticle.cxx.

                                             :
  m_position(isfp.position()),
  m_momentum(isfp.momentum()),
  m_mass(isfp.mass()),
  m_charge(isfp.charge()),
  m_pdgCode(isfp.pdgCode()),
  m_status(isfp.status()),
  m_tstamp(isfp.timeStamp()),
  m_history(isfp.history()),
  m_barcode(isfp.barcode()), // TODO drop this soon
  m_uid(isfp.id()),
  m_truth(isfp.getTruthBinding()),
  m_order(isfp.getOrder()),
  m_userInfo(isfp.getUserInformation()),
  m_partLink(isfp.getParticleLink())
{
}

◆ ~ISFParticle()

ISF::ISFParticle::~ISFParticle ( )

Destructor.

Definition at line 142 of file ISFParticle.cxx.

                             {
  delete m_truth;
  delete m_userInfo;
  if (m_partLink) delete m_partLink;
}

Member Function Documentation

◆ barcode()

int ISF::ISFParticle::barcode ( ) const

the barcode

◆ charge()

double ISF::ISFParticle::charge ( ) const

charge of the particle

◆ dump() [1/2]

MsgStream & ISF::ISFParticle::dump ( MsgStream & out ) const

Dump methods to be used by the overloaded stream operator (inheritance!)

◆ dump() [2/2]

std::ostream & ISF::ISFParticle::dump ( std::ostream & out ) const

◆ ekin()

double ISF::ISFParticle::ekin ( ) const

Kinetic energy.

◆ getOrder()

ParticleOrder ISF::ISFParticle::getOrder ( ) const

return the particle order (eg used to assure ID->Calo->MS simulation order)

◆ getParticleLink()

const HepMcParticleLink * ISF::ISFParticle::getParticleLink ( ) const

inline

HepMcParticleLink accessors.

Definition at line 172 of file ISFParticle.h.

172{return m_partLink;};

◆ getTruthBinding() [1/2]

TruthBinding * ISF::ISFParticle::getTruthBinding ( )

◆ getTruthBinding() [2/2]

const TruthBinding * ISF::ISFParticle::getTruthBinding ( ) const

pointer to the simulation truth - optional, can be 0

◆ getUserInformation() [1/2]

ParticleUserInformation * ISF::ISFParticle::getUserInformation ( )

◆ getUserInformation() [2/2]

const ParticleUserInformation * ISF::ISFParticle::getUserInformation ( ) const

get/set ParticleUserInformation

◆ history()

const ParticleHistory & ISF::ISFParticle::history ( ) const

the particle's full history

◆ id()

int ISF::ISFParticle::id ( ) const

unique ID

◆ isEqual()

bool ISF::ISFParticle::isEqual ( const ISFParticle & rhs ) const

Definition at line 208 of file ISFParticle.cxx.

{
  double epsilon = 1e-6;
 
  bool pass = true;
  pass &= m_position == rhs.position();
  pass &= m_momentum == rhs.momentum();
  pass &= std::fabs(m_mass-rhs.mass()) < epsilon;
  pass &= std::fabs(m_charge-rhs.charge()) < epsilon;
  pass &= m_pdgCode == rhs.pdgCode();
  pass &= m_status == rhs.status();
  pass &= std::fabs(m_tstamp-rhs.timeStamp()) < epsilon;
  pass &= m_history == rhs.history();
  pass &= m_barcode == rhs.barcode(); // TODO drop this soon
  pass &= m_uid == rhs.id();
  {
    const auto rhsTruthPtr = rhs.getTruthBinding();
    if (m_truth && rhsTruthPtr) {
      pass &= *m_truth == *rhsTruthPtr;
    } else {
      pass &= m_truth == rhsTruthPtr; // must be both nullptr to pass
    }
  }
 
  {
    const auto rhsUserInfoPtr = rhs.getUserInformation();
    if (m_userInfo && rhsUserInfoPtr) {
      pass &= *m_userInfo == *rhsUserInfoPtr;
    } else {
      pass &= m_userInfo == rhsUserInfoPtr; // must be both nullptr to pass
    }
  }
 
  {
    const auto rhsPartLinkPtr = rhs.getParticleLink();
    if(m_partLink && rhsPartLinkPtr) {
      pass &= *m_partLink == *rhsPartLinkPtr;
    } else {
      pass &= m_partLink == rhsPartLinkPtr; // must be both nullptr to pass
    }
  }
  return pass;
}

◆ isIdent()

bool ISF::ISFParticle::isIdent ( const ISFParticle & rhs ) const

Definition at line 252 of file ISFParticle.cxx.

{
  bool pass = true;
  pass &= m_position == rhs.position();
  pass &= m_momentum == rhs.momentum();
  pass &= m_mass == rhs.mass();
  pass &= m_charge == rhs.charge();
  pass &= m_pdgCode == rhs.pdgCode();
  pass &= m_status == rhs.status();
  pass &= m_tstamp == rhs.timeStamp();
  pass &= m_history == rhs.history();
  pass &= m_barcode == rhs.barcode(); // TODO drop this soon
  pass &= m_uid == rhs.id();
  pass &= m_truth && rhs.getTruthBinding();
  pass &= m_userInfo == rhs.getUserInformation();
  pass &= m_partLink == rhs.getParticleLink();
  return pass;
}

◆ mass()

double ISF::ISFParticle::mass ( ) const

mass of the particle

◆ momentum()

const Amg::Vector3D & ISF::ISFParticle::momentum ( ) const

The current momentum vector of the ISFParticle.

◆ nextGeoID()

AtlasDetDescr::AtlasRegion ISF::ISFParticle::nextGeoID ( ) const

next geoID the particle will be simulated in

◆ nextSimID()

SimSvcID ISF::ISFParticle::nextSimID ( ) const

the next simulation service the particle will be sent to

◆ operator=() [1/2]

ISF::ISFParticle & ISF::ISFParticle::operator= ( const ISFParticle & rhs )

Assignment operator.

Definition at line 149 of file ISFParticle.cxx.

{
 
  if (this != &rhs) {
    m_position     = rhs.position();
    m_momentum     = rhs.momentum();
    m_mass         = rhs.mass();
    m_charge       = rhs.charge();
    m_pdgCode      = rhs.pdgCode();
    m_status       = rhs.status();
    m_tstamp       = rhs.timeStamp();
    m_history      = rhs.history();
    m_barcode      = rhs.barcode(); // TODO drop this soon
    m_uid           = rhs.id();
 
    delete m_truth;
    m_truth = nullptr;
 
    const TruthBinding *rhsTruth = rhs.getTruthBinding();
    if (rhsTruth) {
      m_truth = new TruthBinding(*rhsTruth);
    }
    m_partLink = ((rhs.getParticleLink()) ? new HepMcParticleLink(*rhs.getParticleLink()): nullptr);
 
    delete m_userInfo;
    m_userInfo = nullptr;
  }
 
  return *this;
}

◆ operator=() [2/2]

ISF::ISFParticle & ISF::ISFParticle::operator= ( ISF::ISFParticle && rhs )

Move assignment operator.

Definition at line 181 of file ISFParticle.cxx.

{
  m_position     = rhs.position();
  m_momentum     = rhs.momentum();
  m_mass         = rhs.mass();
  m_charge       = rhs.charge();
  m_pdgCode      = rhs.pdgCode();
  m_status       = rhs.status();
  m_tstamp       = rhs.timeStamp();
  m_history      = rhs.history();
  m_barcode      = rhs.barcode(); // TODO drop this soon
  m_uid           = rhs.id();
  delete m_truth;
  m_truth        = rhs.getTruthBinding();
  delete m_userInfo;
  m_userInfo     = rhs.getUserInformation();
  if (m_partLink) delete m_partLink;
  m_partLink     = rhs.getParticleLink();
 
  return *this;
}

◆ operator==()

bool ISF::ISFParticle::operator== ( const ISFParticle & rhs ) const

Comparisons.

Definition at line 203 of file ISFParticle.cxx.

{
  return isEqual(rhs);
}

◆ originGeoID()

AtlasDetDescr::AtlasRegion ISF::ISFParticle::originGeoID ( ) const

the sub-detector ID the particle's originates from

◆ originSimID()

SimSvcID ISF::ISFParticle::originSimID ( ) const

the simulation service the particle originates from

◆ pdgCode()

int ISF::ISFParticle::pdgCode ( ) const

PDG value.

◆ position()

const Amg::Vector3D & ISF::ISFParticle::position ( ) const

The current position of the ISFParticle.

◆ prevGeoID()

AtlasDetDescr::AtlasRegion ISF::ISFParticle::prevGeoID ( ) const

previous geoID that the particle was simulated in

◆ prevSimID()

SimSvcID ISF::ISFParticle::prevSimID ( ) const

the simulation service that previously treated this particle

◆ setBarcode()

void ISF::ISFParticle::setBarcode ( int bc )

set a new barcode

◆ setId()

void ISF::ISFParticle::setId ( int id )

set a new unique ID

◆ setNextGeoID()

void ISF::ISFParticle::setNextGeoID ( AtlasDetDescr::AtlasRegion geoID )

register the next AtlasDetDescr::AtlasRegion

◆ setNextSimID()

void ISF::ISFParticle::setNextSimID ( SimSvcID simID )

register the next SimSvcID

◆ setOrder()

void ISF::ISFParticle::setOrder ( ParticleOrder order )

◆ setParticleLink()

void ISF::ISFParticle::setParticleLink ( const HepMcParticleLink * partLink )

inline

Definition at line 173 of file ISFParticle.h.

173{m_partLink=partLink;};

◆ setStatus()

void ISF::ISFParticle::setStatus ( int a )

inline

Definition at line 188 of file ISFParticle.h.

188{ m_status=a; }

a

static Double_t a

Definition LArPhysWaveHECTool.cxx:38

◆ setTruthBinding()

void ISF::ISFParticle::setTruthBinding ( TruthBinding * truth )

◆ setUserInformation()

void ISF::ISFParticle::setUserInformation ( ParticleUserInformation * userInfo )

◆ status()

int ISF::ISFParticle::status ( ) const

inline

Definition at line 189 of file ISFParticle.h.

189{ return m_status;}

◆ timeStamp()

double ISF::ISFParticle::timeStamp ( ) const

Timestamp of the ISFParticle.

◆ updateMomentum()

void ISF::ISFParticle::updateMomentum ( const Amg::Vector3D & momentum )

Update the momentum of the ISFParticle.

◆ updatePosition()

void ISF::ISFParticle::updatePosition ( const Amg::Vector3D & position )

Update the position of the ISFParticle.

Member Data Documentation

◆ m_barcode

int ISF::ISFParticle::m_barcode

private

barcode TODO remove in favour of m_status + m_uid

Definition at line 200 of file ISFParticle.h.

◆ m_charge

double ISF::ISFParticle::m_charge

private

Definition at line 195 of file ISFParticle.h.

◆ m_history

ParticleHistory ISF::ISFParticle::m_history

private

Definition at line 199 of file ISFParticle.h.

◆ m_mass

double ISF::ISFParticle::m_mass

private

Definition at line 194 of file ISFParticle.h.

◆ m_momentum

Amg::Vector3D ISF::ISFParticle::m_momentum

private

Definition at line 193 of file ISFParticle.h.

◆ m_order

ParticleOrder ISF::ISFParticle::m_order

private

particle simulation order

Definition at line 203 of file ISFParticle.h.

◆ m_partLink

const HepMcParticleLink* ISF::ISFParticle::m_partLink

private

Definition at line 205 of file ISFParticle.h.

◆ m_pdgCode

int ISF::ISFParticle::m_pdgCode

private

Definition at line 196 of file ISFParticle.h.

◆ m_position

Amg::Vector3D ISF::ISFParticle::m_position

private

Definition at line 192 of file ISFParticle.h.

◆ m_status

int ISF::ISFParticle::m_status

private

Definition at line 197 of file ISFParticle.h.

◆ m_truth

TruthBinding* ISF::ISFParticle::m_truth

private

< unique ID

Definition at line 202 of file ISFParticle.h.

◆ m_tstamp

double ISF::ISFParticle::m_tstamp

private

Definition at line 198 of file ISFParticle.h.

◆ m_uid

int ISF::ISFParticle::m_uid

private

Definition at line 201 of file ISFParticle.h.

◆ m_userInfo

ParticleUserInformation* ISF::ISFParticle::m_userInfo

private

user information stored with the ISFParticle

Definition at line 204 of file ISFParticle.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ISFParticle() [1/6]

◆ ISFParticle() [2/6]

◆ ISFParticle() [3/6]

◆ ISFParticle() [4/6]

◆ ISFParticle() [5/6]

◆ ISFParticle() [6/6]

◆ ~ISFParticle()

Member Function Documentation

◆ barcode()

◆ charge()

◆ dump() [1/2]

◆ dump() [2/2]

◆ ekin()

◆ getOrder()

◆ getParticleLink()

◆ getTruthBinding() [1/2]

◆ getTruthBinding() [2/2]

◆ getUserInformation() [1/2]

◆ getUserInformation() [2/2]

◆ history()

◆ id()

◆ isEqual()

◆ isIdent()

◆ mass()

◆ momentum()

◆ nextGeoID()

◆ nextSimID()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ originGeoID()

◆ originSimID()

◆ pdgCode()

◆ position()

◆ prevGeoID()

◆ prevSimID()

◆ setBarcode()

◆ setId()

◆ setNextGeoID()

◆ setNextSimID()

◆ setOrder()

◆ setParticleLink()

◆ setStatus()

◆ setTruthBinding()

◆ setUserInformation()

◆ status()

◆ timeStamp()

◆ updateMomentum()

◆ updatePosition()

Member Data Documentation

◆ m_barcode

◆ m_charge

◆ m_history

◆ m_mass

◆ m_momentum

◆ m_order

◆ m_partLink

◆ m_pdgCode

◆ m_position

◆ m_status

◆ m_truth

◆ m_tstamp

◆ m_uid

◆ m_userInfo