#include <TruthTrackBuilderTool.h>

Inheritance diagram for ActsTrk::TruthTrackBuilderTool:

Collaboration diagram for ActsTrk::TruthTrackBuilderTool:

Classes
struct	TruthHit

Public Types
using	Vector3 = Eigen::Vector3f
using	TruthHits = std::vector<TruthHit>
using	TruthTracks = std::unordered_map<const xAOD::TruthParticle*, TruthHits>

Public Member Functions
	TruthTrackBuilderTool (const std::string &type, const std::string &name, const IInterface *parent)
StatusCode	initialize () override
StatusCode	buildTruthTracks (const EventContext &ctx, TruthTracks &truthTracks) const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
template<typename ClusterContainer>
void	addClusterToTruthTracks (const ClusterContainer &clusters, const MeasurementToTruthParticleAssociation &truthAssociations, TruthTracks &truthTracks) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::PixelClusterContainer >	m_pixelClustersKey
SG::ReadHandleKey< MeasurementToTruthParticleAssociation >	m_pixelTruthAssociationKey
SG::ReadHandleKey< xAOD::StripClusterContainer >	m_stripClustersKey
SG::ReadHandleKey< MeasurementToTruthParticleAssociation >	m_stripTruthAssociationKey
Gaudi::Property< bool >	m_usePixelClusters
Gaudi::Property< bool >	m_useStripClusters
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 19 of file TruthTrackBuilderTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ TruthHits

using ActsTrk::TruthTrackBuilderTool::TruthHits = std::vector<TruthHit>

Definition at line 31 of file TruthTrackBuilderTool.h.

◆ TruthTracks

using ActsTrk::TruthTrackBuilderTool::TruthTracks = std::unordered_map<const xAOD::TruthParticle*, TruthHits>

Definition at line 32 of file TruthTrackBuilderTool.h.

◆ Vector3

using ActsTrk::TruthTrackBuilderTool::Vector3 = Eigen::Vector3f

Definition at line 23 of file TruthTrackBuilderTool.h.

Constructor & Destructor Documentation

◆ TruthTrackBuilderTool()

ActsTrk::TruthTrackBuilderTool::TruthTrackBuilderTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 11 of file TruthTrackBuilderTool.cxx.

14 : AthAlgTool(type, name, parent) {}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

Member Function Documentation

◆ addClusterToTruthTracks()

template<typename ClusterContainer>

void ActsTrk::TruthTrackBuilderTool::addClusterToTruthTracks	(	const ClusterContainer &	clusters,
		const MeasurementToTruthParticleAssociation &	truthAssociations,
		TruthTracks &	truthTracks ) const

private

Definition at line 28 of file TruthTrackBuilderTool.cxx.

                                    {
 
  for (const auto* cluster : clusters) {
 
    const auto& matchedTruthParticles = truthAssociations.at(cluster->index());
 
    // if no truth particles for cluster, skip
    if (matchedTruthParticles.empty()) {
      ATH_MSG_WARNING("empty truth particle vector for cluster, skipping");
      continue;
    }
 
    // only taking leading order truth particle
    // (most likely to be the correct truth match as it has largest depsoit in
    // cluster)
    const xAOD::TruthParticle* truthParticle = matchedTruthParticles.front();
 
    // obtain global position of cluster before upcasting (makes sorting easier)
    const auto& globalPosition = cluster->globalPosition();
    TruthHit hit{cluster, globalPosition};
 
    truthTracks[truthParticle].push_back(hit);
  }
}

◆ buildTruthTracks()

StatusCode ActsTrk::TruthTrackBuilderTool::buildTruthTracks	(	const EventContext &	ctx,
		TruthTracks &	truthTracks ) const

Definition at line 56 of file TruthTrackBuilderTool.cxx.

                                                             {
 
  // obtain truth map and clusters
  // for every cluster, obtain its truth particle and add to map
  // This can be optional for both pixel and strip clusters
  if (m_usePixelClusters) {
    SG::ReadHandle<xAOD::PixelClusterContainer> pixelClusters{
        m_pixelClustersKey, ctx};
 
    SG::ReadHandle<MeasurementToTruthParticleAssociation>
        pixelTruthAssociations{m_pixelTruthAssociationKey, ctx};
 
    if (!pixelClusters.isValid()) {
 
      ATH_MSG_ERROR(
          "Could not read pixel clusters: " << m_pixelClustersKey.key());
      return StatusCode::FAILURE;
    }
 
    if (!pixelTruthAssociations.isValid()) {
 
      ATH_MSG_ERROR("Could not read pixel truth associations: "
                    << m_pixelTruthAssociationKey.key());
      return StatusCode::FAILURE;
    }
 
    addClusterToTruthTracks(*pixelClusters, *pixelTruthAssociations,
                            truthTracks);
  }
 
  if (m_useStripClusters) {
 
    SG::ReadHandle<xAOD::StripClusterContainer> stripClusters{
        m_stripClustersKey, ctx};
 
    SG::ReadHandle<MeasurementToTruthParticleAssociation>
        stripTruthAssociations{m_stripTruthAssociationKey, ctx};
 
    if (!stripClusters.isValid()) {
 
      ATH_MSG_ERROR(
          "Could not read strip clusters: " << m_stripClustersKey.key());
      return StatusCode::FAILURE;
    }
 
    if (!stripTruthAssociations.isValid()) {
 
      ATH_MSG_ERROR("Could not read strip truth associations: "
                    << m_stripTruthAssociationKey.key());
      return StatusCode::FAILURE;
    }
 
    addClusterToTruthTracks(*stripClusters, *stripTruthAssociations,
                            truthTracks);
  }
 
  // reorder clusters for each associated truth particle
  // This is done by ordering by distance away from truth particle production
  // vertex (assuming small bending)
  for (auto it = truthTracks.begin(); it != truthTracks.end();) {
 
    auto& [truthParticle, truthClusters] = *it;
 
    if (truthParticle == nullptr || !truthParticle->hasProdVtx()) {
 
      ATH_MSG_WARNING(
          "Truth particle does not have a production vertex, erasing");
      it = truthTracks.erase(it);
      continue;
    }
 
    const xAOD::TruthVertex* vertex = truthParticle->prodVtx();
    const Vector3 vertexPosition{vertex->x(), vertex->y(), vertex->z()};
    std::sort(truthClusters.begin(), truthClusters.end(),
              [&vertexPosition](const TruthHit& firstCluster,
                                const TruthHit& secondCluster) {
                const Vector3 firstClusterDis =
                    firstCluster.globalPosition - vertexPosition;
                const Vector3 secondClusterDis =
                    secondCluster.globalPosition - vertexPosition;
 
                const float firstClusterNorm = firstClusterDis.squaredNorm();
                const float secondClusterNorm = secondClusterDis.squaredNorm();
 
                return firstClusterNorm < secondClusterNorm;
              });
 
    ++it;
  }
 
  return StatusCode::SUCCESS;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ initialize()

StatusCode ActsTrk::TruthTrackBuilderTool::initialize ( )

override

Definition at line 16 of file TruthTrackBuilderTool.cxx.

                                             {
 
  // initialize all the conatiners needed
  ATH_CHECK(m_pixelClustersKey.initialize());
  ATH_CHECK(m_pixelTruthAssociationKey.initialize());
  ATH_CHECK(m_stripClustersKey.initialize());
  ATH_CHECK(m_stripTruthAssociationKey.initialize());
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_pixelClustersKey

SG::ReadHandleKey<xAOD::PixelClusterContainer> ActsTrk::TruthTrackBuilderTool::m_pixelClustersKey

private

Initial value:

{
      this, "PixelClusters", "ITkPixelClusters",
      "Input reconstructed pixel clusters"}

Definition at line 47 of file TruthTrackBuilderTool.h.

                                                               {
      this, "PixelClusters", "ITkPixelClusters",
      "Input reconstructed pixel clusters"};

◆ m_pixelTruthAssociationKey

SG::ReadHandleKey<MeasurementToTruthParticleAssociation> ActsTrk::TruthTrackBuilderTool::m_pixelTruthAssociationKey

private

Initial value:

{
          this, "PixelClustersToTruthAssociationMap",
          "ITkPixelClustersToTruthParticles",
          "Pixel cluster-to-truth-particle associations"}

Definition at line 51 of file TruthTrackBuilderTool.h.

                                {
          this, "PixelClustersToTruthAssociationMap",
          "ITkPixelClustersToTruthParticles",
          "Pixel cluster-to-truth-particle associations"};

◆ m_stripClustersKey

SG::ReadHandleKey<xAOD::StripClusterContainer> ActsTrk::TruthTrackBuilderTool::m_stripClustersKey

private

Initial value:

{
      this, "StripClusters", "ITkStripClusters",
      "Input reconstructed strip clusters"}

Definition at line 56 of file TruthTrackBuilderTool.h.

                                                               {
      this, "StripClusters", "ITkStripClusters",
      "Input reconstructed strip clusters"};

◆ m_stripTruthAssociationKey

SG::ReadHandleKey<MeasurementToTruthParticleAssociation> ActsTrk::TruthTrackBuilderTool::m_stripTruthAssociationKey

private

Initial value:

{
          this, "StripClustersToTruthAssociationMap",
          "ITkStripClustersToTruthParticles",
          "Strip cluster-to-truth-particle associations"}

Definition at line 60 of file TruthTrackBuilderTool.h.

                                {
          this, "StripClustersToTruthAssociationMap",
          "ITkStripClustersToTruthParticles",
          "Strip cluster-to-truth-particle associations"};

◆ m_usePixelClusters

Gaudi::Property<bool> ActsTrk::TruthTrackBuilderTool::m_usePixelClusters

private

Initial value:

{this, "usePixelClusters", true,

"option for using pixel clusters"}

Definition at line 66 of file TruthTrackBuilderTool.h.

66 {this, "usePixelClusters", true,

67 "option for using pixel clusters"};

◆ m_useStripClusters

Gaudi::Property<bool> ActsTrk::TruthTrackBuilderTool::m_useStripClusters

private

Initial value:

{this, "useStripClusters", true,

"option for using strip clusters"}

Definition at line 68 of file TruthTrackBuilderTool.h.

68 {this, "useStripClusters", true,

69 "option for using strip clusters"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

◆ TruthHits

◆ TruthTracks

◆ Vector3

Constructor & Destructor Documentation

◆ TruthTrackBuilderTool()

Member Function Documentation

◆ addClusterToTruthTracks()

◆ buildTruthTracks()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_pixelClustersKey

◆ m_pixelTruthAssociationKey

◆ m_stripClustersKey

◆ m_stripTruthAssociationKey

◆ m_usePixelClusters

◆ m_useStripClusters

◆ m_varHandleArraysDeclared

◆ m_vhka