TrackHelper Class Reference

#include <TrackHelper.h>

Collaboration diagram for TrackHelper:

Public Member Functions
	TrackHelper (const G4Track *t)
bool	IsPrimary () const
bool	IsRegeneratedPrimary () const
bool	IsRegisteredSecondary () const
bool	IsSecondary () const
int	GetBarcode () const
	Return the truth barcode/id/status used for detector output.
int	GetUniqueID () const
int	GetStatus () const
HepMC::GenParticlePtr	GetPrimaryGenParticle ()
	Return the primary truth particle associated with this track.
HepMC::ConstGenParticlePtr	GetPrimaryGenParticle () const
TrackInformation *	GetTrackInformation ()
	Return concrete TrackInformation when callers need fields that are not part of the VTrackInformation interface.
HepMcParticleLink	GenerateParticleLink ()
	Generates a new HepMcParticleLink object on the stack based on the generation-zero unique id, assuming that the link should point at the first GenEvent in the McEventCollection.
HepMcParticleLink	GenerateParticleLink (IProxyDict *)

Private Member Functions
std::tuple< int, HepMcParticleLink::UniqueIDFlag >	particleIdentifierAndFlag () const

Private Attributes
VTrackInformation *	m_trackInfo {}

Detailed Description

Definition at line 20 of file TrackHelper.h.

Constructor & Destructor Documentation

TrackHelper()

TrackHelper::TrackHelper

(

const G4Track *

t

)

Definition at line 27 of file TrackHelper.cxx.

{
  G4VUserTrackInformation* userInfo = t ? t->GetUserInformation() : nullptr;
  m_trackInfo = dynamic_cast<VTrackInformation*>(userInfo);
}

Member Function Documentation

GenerateParticleLink() [1/2]

HepMcParticleLink TrackHelper::GenerateParticleLink ( )

inline

Generates a new HepMcParticleLink object on the stack based on the generation-zero unique id, assuming that the link should point at the first GenEvent in the McEventCollection.

Definition at line 75 of file TrackHelper.h.

{
  const auto [identifier, flag] = particleIdentifierAndFlag();
  return HepMcParticleLink(identifier,
                           0,
                           HepMcParticleLink::IS_POSITION,
                           flag);
}

GenerateParticleLink() [2/2]

HepMcParticleLink TrackHelper::GenerateParticleLink ( IProxyDict * proxy )

inline

Definition at line 84 of file TrackHelper.h.

{
  const auto [identifier, flag] = particleIdentifierAndFlag();
  if(!proxy) {
    return GenerateParticleLink();
  }
  return HepMcParticleLink(identifier,
                           0,
                           HepMcParticleLink::IS_POSITION,
                           flag,
                           proxy);
}

GetBarcode()

int TrackHelper::GetBarcode

(

)

const

Return the truth barcode/id/status used for detector output.

TrackInformation can keep both the generation-zero particle and the current regenerated particle. Detector hit links and track records use the generation-zero particle to preserve legacy output attribution, falling back to the current particle for older TrackInformation objects. Barcode-only track info keeps using its stored barcode/id/status values.

Definition at line 57 of file TrackHelper.cxx.

{
  if (const TrackInformation* concreteInfo = dynamic_cast<const TrackInformation*>(m_trackInfo)) {
    HepMC::ConstGenParticlePtr particle = outputAttributionParticle(concreteInfo);
    return particle ? HepMC::barcode(particle) : 0;
  }
  return m_trackInfo ? m_trackInfo->GetParticleBarcode() : 0;
}

GetPrimaryGenParticle() [1/2]

HepMC::GenParticlePtr TrackHelper::GetPrimaryGenParticle

(

)

Return the primary truth particle associated with this track.

This is the primary-ancestor attribution stored on VTrackInformation. It may differ from the generation-zero/current particle used by the output-link helpers above, and is null when no track information or no primary attribution is attached.

Definition at line 84 of file TrackHelper.cxx.

{
  return m_trackInfo ? m_trackInfo->GetPrimaryGenParticle() : nullptr;
}

GetPrimaryGenParticle() [2/2]

HepMC::ConstGenParticlePtr TrackHelper::GetPrimaryGenParticle

(

)

const

Definition at line 89 of file TrackHelper.cxx.

{
  return m_trackInfo ? std::as_const(m_trackInfo)->GetPrimaryGenParticle() : nullptr;
}

GetStatus()

int TrackHelper::GetStatus

(

)

const

Definition at line 75 of file TrackHelper.cxx.

{
  if (const TrackInformation* concreteInfo = dynamic_cast<const TrackInformation*>(m_trackInfo)) {
    HepMC::ConstGenParticlePtr particle = outputAttributionParticle(concreteInfo);
    return particle ? particle->status() : 0;
  }
  return m_trackInfo ? m_trackInfo->GetParticleStatus() : 0;
}

GetTrackInformation()

TrackInformation * TrackHelper::GetTrackInformation

(

)

Return concrete TrackInformation when callers need fields that are not part of the VTrackInformation interface.

Definition at line 33 of file TrackHelper.cxx.

{
  return dynamic_cast<TrackInformation*>(m_trackInfo);
}

GetUniqueID()

int TrackHelper::GetUniqueID

(

)

const

Definition at line 66 of file TrackHelper.cxx.

{
  if (const TrackInformation* concreteInfo = dynamic_cast<const TrackInformation*>(m_trackInfo)) {
    HepMC::ConstGenParticlePtr particle = outputAttributionParticle(concreteInfo);
    return particle ? HepMC::uniqueID(particle) : 0;
  }
  return m_trackInfo ? m_trackInfo->GetParticleUniqueID() : 0;
}

IsPrimary()

bool TrackHelper::IsPrimary

(

)

const

Definition at line 37 of file TrackHelper.cxx.

{
  if (m_trackInfo==0) return false;
  return m_trackInfo->GetClassification()==VTrackInformation::Primary;
}

IsRegeneratedPrimary()

bool TrackHelper::IsRegeneratedPrimary

(

)

const

Definition at line 42 of file TrackHelper.cxx.

{
  if (m_trackInfo==0) return false;
  return m_trackInfo->GetClassification()==VTrackInformation::RegeneratedPrimary;
}

IsRegisteredSecondary()

bool TrackHelper::IsRegisteredSecondary

(

)

const

Definition at line 47 of file TrackHelper.cxx.

{
  if (m_trackInfo==0) return false;
  return m_trackInfo->GetClassification()==VTrackInformation::RegisteredSecondary;
}

IsSecondary()

bool TrackHelper::IsSecondary

(

)

const

Definition at line 52 of file TrackHelper.cxx.

{
  if (m_trackInfo==0) return true;
  return m_trackInfo->GetClassification()==VTrackInformation::Secondary;
}

particleIdentifierAndFlag()

std::tuple< int, HepMcParticleLink::UniqueIDFlag > TrackHelper::particleIdentifierAndFlag ( ) const

inlineprivate

Definition at line 70 of file TrackHelper.h.

{
  return {GetUniqueID(), HepMcParticleLink::IS_ID};
}

Member Data Documentation

m_trackInfo

VTrackInformation* TrackHelper::m_trackInfo {}

private

Definition at line 66 of file TrackHelper.h.

{};

---

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

• TrackHelper.h
• TrackHelper.cxx