TrackHelper.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MCTRUTH_TRACKHELPER_H
#define MCTRUTH_TRACKHELPER_H
 
 
#include <tuple>
 
#include "AtlasHepMC/GenParticle_fwd.h"
#include "GeneratorObjects/HepMcParticleLink.h"
 
class IProxyDict;
 
class G4Track;
class TrackInformation;
class VTrackInformation;
 
class TrackHelper {
public:
  TrackHelper(const G4Track* t);
  bool IsPrimary() const ;
  bool IsRegeneratedPrimary() const;
  bool IsRegisteredSecondary() const ;
  bool IsSecondary() const ;
  int GetBarcode() const ; // TODO Drop this once UniqueID and Status are used instead
  int GetUniqueID() const;
  int GetStatus() const ;
  HepMC::GenParticlePtr GetPrimaryGenParticle();
  HepMC::ConstGenParticlePtr GetPrimaryGenParticle() const;
  TrackInformation * GetTrackInformation();
  inline HepMcParticleLink GenerateParticleLink();
  inline HepMcParticleLink GenerateParticleLink(IProxyDict*);
 private:
  inline std::tuple<int, HepMcParticleLink::UniqueIDFlag> particleIdentifierAndFlag() const;
 
  // TrackHelper also handles lightweight TrackBarcodeInfo instances, so the
  // cached pointer intentionally uses the common VTrackInformation base.
  VTrackInformation *m_trackInfo{};
};
 
inline std::tuple<int, HepMcParticleLink::UniqueIDFlag>
TrackHelper::particleIdentifierAndFlag() const
{
  return {GetUniqueID(), HepMcParticleLink::IS_ID};
}
 
HepMcParticleLink TrackHelper::GenerateParticleLink()
{
  const auto [identifier, flag] = particleIdentifierAndFlag();
  return HepMcParticleLink(identifier,
                           0,
                           HepMcParticleLink::IS_POSITION,
                           flag);
}
 
HepMcParticleLink TrackHelper::GenerateParticleLink(IProxyDict* proxy)
{
  const auto [identifier, flag] = particleIdentifierAndFlag();
  if(!proxy) {
    return GenerateParticleLink();
  }
  return HepMcParticleLink(identifier,
                           0,
                           HepMcParticleLink::IS_POSITION,
                           flag,
                           proxy);
}
 
#endif // MCTRUTH_TRACKHELPER_H