TruthTrackRecordToTrack is an AlgTool to create Trk::TrackParameters from a HepMC::GenParticle expressed at a "TrackRecordCollection" anywhere in ATLAS. More...

#include <TruthTrackRecordToTrack.h>

Inheritance diagram for Trk::TruthTrackRecordToTrack:

Collaboration diagram for Trk::TruthTrackRecordToTrack:

Public Member Functions
	TruthTrackRecordToTrack (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize ()
virtual const Trk::TrackParameters *	makeProdVertexParameters (HepMC::ConstGenParticlePtr part) const
	This function produces a Trk::TrackParameters object corresponding to the HepMC::GenParticle at the production vertex.
virtual const Trk::TrackParameters *	makeProdVertexParameters (const xAOD::TruthParticle *part) const
virtual const Trk::TrackParameters *	makePerigeeParameters (HepMC::ConstGenParticlePtr part) const
	This function extrapolates track to the perigee, and returns perigee parameters.
virtual const Trk::TrackParameters *	makePerigeeParameters (const xAOD::TruthParticle *part) 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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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
	TruthTrackRecordToTrack (const TruthTrackRecordToTrack &)=delete
	Forbid copying of Truth...ToTrack to not mess with the internal pointers.
TruthTrackRecordToTrack &	operator= (const TruthTrackRecordToTrack &)=delete
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< Trk::IExtrapolator >	m_extrapolator
SG::ReadHandleKey< TrackRecordCollection >	m_reccollkey
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

TruthTrackRecordToTrack is an AlgTool to create Trk::TrackParameters from a HepMC::GenParticle expressed at a "TrackRecordCollection" anywhere in ATLAS.

The purpose is to analyse non-collision particles (therefore uses TrackRecord, not GenParticle's prod vertex) in the reconstructed Track's reference frame. The code stems from old cosmics-testbeam analysis refurbished under the ITruthToTrack interface.

Author: Wolfgang.Liebig -at- cern.ch

Definition at line 37 of file TruthTrackRecordToTrack.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TruthTrackRecordToTrack() [1/2]

Trk::TruthTrackRecordToTrack::TruthTrackRecordToTrack	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 23 of file TruthTrackRecordToTrack.cxx.

  : AthAlgTool(type,name,parent),
    m_extrapolator("Trk::Extrapolator/AtlasExtrapolator")
{
  declareInterface<ITruthToTrack>(this);
 
  declareProperty("Extrapolator", m_extrapolator);
  declareProperty("TrackRecordKey",m_reccollkey="CosmicPerigee");
}

◆ TruthTrackRecordToTrack() [2/2]

Trk::TruthTrackRecordToTrack::TruthTrackRecordToTrack ( const TruthTrackRecordToTrack & )

privatedelete

Forbid copying of Truth...ToTrack to not mess with the internal pointers.

Member Function Documentation

◆ 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 Trk::TruthTrackRecordToTrack::initialize ( )

virtual

Definition at line 35 of file TruthTrackRecordToTrack.cxx.

                                                  {
 
  ATH_CHECK ( m_extrapolator.retrieve() );
 
  ATH_CHECK( m_reccollkey.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.

◆ interfaceID()

const InterfaceID & Trk::ITruthToTrack::interfaceID ( )

inlinestaticinherited

Definition at line 40 of file ITruthToTrack.h.

                                            { 
      static const InterfaceID IID_ITruthToTrack("Trk::ITruthToTrack",1,0);
      return IID_ITruthToTrack;
    }

◆ makePerigeeParameters() [1/2]

const Trk::TrackParameters * Trk::TruthTrackRecordToTrack::makePerigeeParameters ( const xAOD::TruthParticle * part ) const

virtual

Implements Trk::ITruthToTrack.

Definition at line 187 of file TruthTrackRecordToTrack.cxx.

                                                                                                               {
  const Trk::TrackParameters* generatedTrackPerigee = nullptr;
 
  if(part && part->hasProdVtx() && m_extrapolator) {
 
    MsgStream log(msgSvc(), name());
 
    std::unique_ptr<const Trk::TrackParameters> productionVertexTrackParams( makeProdVertexParameters(part) );
    if(productionVertexTrackParams) {
 
      // Extrapolate the TrackParameters object to the perigee. Direct extrapolation,
      // no material effects.
      generatedTrackPerigee =
        m_extrapolator->extrapolateDirectly(Gaudi::Hive::currentContext(),
                                            *productionVertexTrackParams,
                                            Trk::PerigeeSurface(),
                                            Trk::anyDirection,
                                            false,
                                            Trk::nonInteracting).release();
    }
  }
 
  return generatedTrackPerigee;
}

◆ makePerigeeParameters() [2/2]

const Trk::TrackParameters * Trk::TruthTrackRecordToTrack::makePerigeeParameters ( HepMC::ConstGenParticlePtr part ) const

virtual

This function extrapolates track to the perigee, and returns perigee parameters.

The return value points to an object allocated with the operator new. The caller is responsible for deletion of the object.

Implements Trk::ITruthToTrack.

Definition at line 161 of file TruthTrackRecordToTrack.cxx.

                                                                                                               {
  const Trk::TrackParameters* generatedTrackPerigee = nullptr;
 
  if(part && part->production_vertex() && m_extrapolator) {
 
    MsgStream log(msgSvc(), name());
 
    std::unique_ptr<const Trk::TrackParameters> productionVertexTrackParams( makeProdVertexParameters(part) );
    if(productionVertexTrackParams) {
 
      // Extrapolate the TrackParameters object to the perigee. Direct extrapolation,
      // no material effects.
      generatedTrackPerigee =
        m_extrapolator->extrapolateDirectly(Gaudi::Hive::currentContext(),
                                            *productionVertexTrackParams,
                                            Trk::PerigeeSurface(),
                                            Trk::anyDirection,
                                            false,
                                            Trk::nonInteracting).release();
    }
  }
 
  return generatedTrackPerigee;
}

◆ makeProdVertexParameters() [1/2]

const Trk::TrackParameters * Trk::TruthTrackRecordToTrack::makeProdVertexParameters ( const xAOD::TruthParticle * part ) const

virtual

Implements Trk::ITruthToTrack.

Definition at line 105 of file TruthTrackRecordToTrack.cxx.

                                                                                                                  {
 
  if (part == nullptr) return nullptr;
 
  Trk::TrackParameters *result{};
  Amg::Vector3D prodVertexVector(0., 0., 0.);
  Amg::Vector3D globalPos(0., 0., 0.);
  Amg::Vector3D globalMom(0., 0., 0.);
  int id=0;
  double charge = 0.0;
 
  SG::ReadHandle<TrackRecordCollection> trackRecordCollection(m_reccollkey);
 
  if (trackRecordCollection.isValid()) {
    ATH_MSG_ERROR ("Could not get track record!");
    return nullptr;
  }
 
  ATH_MSG_DEBUG("reading from track record, size=" << trackRecordCollection->size());
 
  if (trackRecordCollection->empty()) ATH_MSG_WARNING ("action required but TrackRecordCollection size is 0");
 
  for (const auto & trackRecord : *trackRecordCollection) {
    if ( HepMC::is_same_particle(trackRecord,part) ) {
      id = trackRecord.GetPDGCode();
      if (!id) continue;
      CLHEP::Hep3Vector  tv = trackRecord.GetPosition();
      prodVertexVector = Amg::Vector3D(tv.x(),tv.y(),tv.z());
      globalPos = prodVertexVector;
      Amg::Vector3D hv2(trackRecord.GetMomentum().x(), trackRecord.GetMomentum().y(), trackRecord.GetMomentum().z());
      globalMom = hv2;
      ATH_MSG_DEBUG("found particle " << part << ", momentum " << hv2 << " production " << globalPos);
    }
  }   // loop over G4 records
 
  if (id) {
    charge = MC::charge(id);
 
    Amg::Translation3D prodSurfaceCentre( prodVertexVector.x(),
                                          prodVertexVector.y(),
                                          prodVertexVector.z() );
 
    Amg::Transform3D tmpTransf =  prodSurfaceCentre *  Amg::RotationMatrix3D::Identity();
 
    Trk::PlaneSurface planeSurface(tmpTransf, 5., 5. );
    result = new Trk::AtaPlane(globalPos, globalMom, charge, planeSurface);
 
  } else {
    ATH_MSG_WARNING ("Could not get particle data for particle ID="<<id);
  }
  return result;
}

◆ makeProdVertexParameters() [2/2]

const Trk::TrackParameters * Trk::TruthTrackRecordToTrack::makeProdVertexParameters ( HepMC::ConstGenParticlePtr part ) const

virtual

This function produces a Trk::TrackParameters object corresponding to the HepMC::GenParticle at the production vertex.

The object is allocated using operator new and returned by pointer. The caller is responsible for deletion of the object. (Wrapping it into a smart pointer may be the most convenient way to make sure the memory is freed.)

Implements Trk::ITruthToTrack.

Definition at line 45 of file TruthTrackRecordToTrack.cxx.

                                                                                                                  {
 
  if (part == nullptr) return nullptr;
 
  Trk::TrackParameters *result = nullptr;
  Amg::Vector3D prodVertexVector;
  prodVertexVector.setZero();
  Amg::Vector3D globalPos;
  Amg::Vector3D globalMom;
  int id=0;
 
  SG::ReadHandle<TrackRecordCollection> trackRecordCollection(m_reccollkey);
 
  if (trackRecordCollection.isValid()) {
    ATH_MSG_ERROR ("Could not get track record!");
    return nullptr;
  }
  ATH_MSG_DEBUG("reading from track record, size=" << trackRecordCollection->size());
 
  if (trackRecordCollection->empty()) ATH_MSG_WARNING ("action required but TrackRecordCollection size is 0");
 
  for (const auto & trackRecord : *trackRecordCollection) {
 
    if ( !HepMC::is_same_particle(trackRecord,part) ) continue;
 
    id = trackRecord.GetPDGCode();
 
    CLHEP::Hep3Vector tv = trackRecord.GetPosition();
    prodVertexVector = Amg::Vector3D(tv.x(),tv.y(),tv.z());
    globalPos = prodVertexVector;
 
    Amg::Vector3D hv2(trackRecord.GetMomentum().x(), trackRecord.GetMomentum().y(),
                      trackRecord.GetMomentum().z());
    globalMom = hv2;
 
    ATH_MSG_DEBUG("Found particle " << part << ", momentum " << hv2 << " production " << globalPos);
 
 
  }   // loop over G4 records
 
  if (id) {
    const double charge = MC::charge(id);
 
    Amg::Translation3D prodSurfaceCentre( prodVertexVector.x(),
                                          prodVertexVector.y(),
                                          prodVertexVector.z() );
 
    Amg::Transform3D tmpTransf =  prodSurfaceCentre *  Amg::RotationMatrix3D::Identity();
 
    Trk::PlaneSurface planeSurface(tmpTransf, 5., 5. );
    result = new Trk::AtaPlane(globalPos, globalMom, charge, planeSurface);
  } else {
    ATH_MSG_WARNING ("Could not get particle data for particle ID="<<id);
  }
  return result;
}

◆ 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);
  }

◆ operator=()

TruthTrackRecordToTrack & Trk::TruthTrackRecordToTrack::operator= ( const TruthTrackRecordToTrack & )

privatedelete

◆ 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 >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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_extrapolator

ToolHandle<Trk::IExtrapolator> Trk::TruthTrackRecordToTrack::m_extrapolator

private

Definition at line 65 of file TruthTrackRecordToTrack.h.

◆ m_reccollkey

SG::ReadHandleKey<TrackRecordCollection> Trk::TruthTrackRecordToTrack::m_reccollkey

private

Definition at line 66 of file TruthTrackRecordToTrack.h.

◆ 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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TruthTrackRecordToTrack() [1/2]

◆ TruthTrackRecordToTrack() [2/2]

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ makePerigeeParameters() [1/2]

◆ makePerigeeParameters() [2/2]

◆ makeProdVertexParameters() [1/2]

◆ makeProdVertexParameters() [2/2]

◆ msg()

◆ msgLvl()

◆ operator=()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extrapolator

◆ m_reccollkey

◆ m_varHandleArraysDeclared

◆ m_vhka