This class is attached to G4PrimaryParticle objects as UserInformation. More...

#include <PrimaryParticleInformation.h>

Inheritance diagram for PrimaryParticleInformation:

Collaboration diagram for PrimaryParticleInformation:

Public Member Functions
	PrimaryParticleInformation ()
	PrimaryParticleInformation (HepMC::GenParticlePtr p, ISF::ISFParticle *isp=nullptr)
HepMC::ConstGenParticlePtr	GetHepMCParticle () const
	return a pointer to the GenParticle used to create the G4PrimaryParticle
HepMC::GenParticlePtr	GetHepMCParticle ()
int	GetRegenerationNr ()
	return the number of times the particle represented by the G4PrimaryParticle has undergone a non-destructive interaction that was recorded in the HepMC::GenEvent.
void	SetRegenerationNr (int i)
	update the number of times the particle represented by the G4PrimaryParticle has undergone a non-destructive interaction that was recorded in the HepMC::GenEvent.
const ISF::ISFParticle *	GetISFParticle () const
	return a pointer to the ISFParticle used to create the G4PrimaryParticle
ISF::ISFParticle *	GetISFParticle ()
void	SetISFParticle (ISF::ISFParticle *isp)
int	GetParticleBarcode () const
int	GetParticleUniqueID () const
void	Print () const

Private Attributes
HepMC::GenParticlePtr	m_theParticle {}
ISF::ISFParticle *	m_theISFParticle {}
int	m_regenerationNr {0}
int m_barcode	ATLAS_THREAD_SAFE = HepMC::INVALID_PARTICLE_BARCODE
int m_uniqueID	ATLAS_THREAD_SAFE = HepMC::INVALID_PARTICLE_BARCODE

Detailed Description

This class is attached to G4PrimaryParticle objects as UserInformation.

The member variable m_theParticle holds a pointer to the HepMC::GenParticle which was used to create the G4PrimaryParticle. Tthe member variable m_theISFParticle holds a pointer to the ISFParticle used to create the G4PrimaryParticle. (See ISF::InputConverter::getG4PrimaryParticle().) The behaviour is slightly different inside and outside ISF:

outside of ISF: m_theParticle is used to build the initial VTrackInformation attached as UserInformation to G4Tracks created from G4PrimaryParticles. (See AthenaStackingAction::ClassifyNewTrack(...))
inside ISF: The TruthBinding of m_theISFParticle is used to build the VTrackInformation object attached as UserInformation to G4Tracks created from G4PrimaryParticles. (See TrackProcessorUserActionBase::setupPrimary(...)) NB While the GenParticlePtr held by the VTrackInformation object can change during simulation (i.e. each time the track undergoes a non-destructive interaction). The GenParticlePtr held by PrimaryParticleInformation never changes.

Definition at line 39 of file PrimaryParticleInformation.h.

Constructor & Destructor Documentation

◆ PrimaryParticleInformation() [1/2]

PrimaryParticleInformation::PrimaryParticleInformation ( )

Definition at line 8 of file PrimaryParticleInformation.cxx.

9{

10}

◆ PrimaryParticleInformation() [2/2]

PrimaryParticleInformation::PrimaryParticleInformation	(	HepMC::GenParticlePtr	p,
		ISF::ISFParticle *	isp = nullptr )

Definition at line 12 of file PrimaryParticleInformation.cxx.

  : m_theParticle(std::move(p))
  , m_theISFParticle(isp)
{
}

Member Function Documentation

◆ GetHepMCParticle() [1/2]

HepMC::GenParticlePtr PrimaryParticleInformation::GetHepMCParticle ( )

inline

Definition at line 48 of file PrimaryParticleInformation.h.

48{ return m_theParticle; }

◆ GetHepMCParticle() [2/2]

HepMC::ConstGenParticlePtr PrimaryParticleInformation::GetHepMCParticle ( ) const

inline

return a pointer to the GenParticle used to create the G4PrimaryParticle

Definition at line 47 of file PrimaryParticleInformation.h.

47{ return m_theParticle; }

◆ GetISFParticle() [1/2]

ISF::ISFParticle * PrimaryParticleInformation::GetISFParticle ( )

inline

Definition at line 67 of file PrimaryParticleInformation.h.

67{ return m_theISFParticle; }

◆ GetISFParticle() [2/2]

const ISF::ISFParticle * PrimaryParticleInformation::GetISFParticle ( ) const

inline

return a pointer to the ISFParticle used to create the G4PrimaryParticle

Definition at line 66 of file PrimaryParticleInformation.h.

66{ return m_theISFParticle; }

◆ GetParticleBarcode()

int PrimaryParticleInformation::GetParticleBarcode ( ) const

Definition at line 18 of file PrimaryParticleInformation.cxx.

{
  if (m_barcode !=  HepMC::INVALID_PARTICLE_BARCODE) return m_barcode;
  if (m_theParticle) {
      m_barcode = HepMC::barcode(m_theParticle);
      return m_barcode;
  }
  return 0;
}

◆ GetParticleUniqueID()

int PrimaryParticleInformation::GetParticleUniqueID ( ) const

Definition at line 28 of file PrimaryParticleInformation.cxx.

{
  if (m_uniqueID !=  HepMC::INVALID_PARTICLE_BARCODE) return m_uniqueID;
  if (m_theParticle) {
    HepMC::ConstGenParticlePtr particle = m_theParticle;
    m_uniqueID = HepMC::uniqueID(particle);
    return m_uniqueID;
  }
  return 0;
}

◆ GetRegenerationNr()

int PrimaryParticleInformation::GetRegenerationNr ( )

inline

return the number of times the particle represented by the G4PrimaryParticle has undergone a non-destructive interaction that was recorded in the HepMC::GenEvent.

Definition at line 55 of file PrimaryParticleInformation.h.

55{return m_regenerationNr;}

PrimaryParticleInformation::m_regenerationNr

int m_regenerationNr

Definition PrimaryParticleInformation.h:77

◆ Print()

void PrimaryParticleInformation::Print ( ) const

inline

Definition at line 72 of file PrimaryParticleInformation.h.

72{}

◆ SetISFParticle()

void PrimaryParticleInformation::SetISFParticle ( ISF::ISFParticle * isp )

Definition at line 39 of file PrimaryParticleInformation.cxx.

{
  m_theISFParticle=p;
}

◆ SetRegenerationNr()

void PrimaryParticleInformation::SetRegenerationNr ( int i )

inline

update the number of times the particle represented by the G4PrimaryParticle has undergone a non-destructive interaction that was recorded in the HepMC::GenEvent.

Definition at line 61 of file PrimaryParticleInformation.h.

61{m_regenerationNr=i;}

lumiFormat.i

int i

Definition lumiFormat.py:85