#include <EntryLayerToolMT.h>

Inheritance diagram for ISF::EntryLayerToolMT:

Collaboration diagram for ISF::EntryLayerToolMT:

Public Member Functions
	EntryLayerToolMT (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with parameters. More...

virtual	~EntryLayerToolMT ()=default
	Destructor. More...

virtual StatusCode	initialize () override final
	Athena algtool's Hooks. More...

virtual bool	passesFilters (const ISFParticle &particle) override final
	Check if given particle passes the EntryLayer filters. More...

virtual ISF::EntryLayer	identifyEntryLayer (const ISFParticle &particle) override final
	Identify the corresponding entry layer for the given particle (may return ISF::fUnsetEntryLayere if particle is not on an entry layer surface) More...

virtual ISF::EntryLayer	registerParticle (const ISF::ISFParticle &particle, ISF::EntryLayer entryLayer) override final
	Add the given particle to the corresponding Entry/Exit layer if applicable. More...

virtual StatusCode	registerTrackRecordCollection (TrackRecordCollection *collection, EntryLayer layer) override final
	Register the TrackRecordCollection pointer for a layer. More...

virtual void	setupEvent () override

Private Attributes
ServiceHandle< ISF::IGeoIDSvc >	m_geoIDSvc {this, "GeoIDSvc", "GeoIDSvc", "AthenaService used to indentify sub-detector by (x,y,z) coordintes."}
	GeoIDSvc will be used to determine the entry layer surface, the particle is on. More...

ISF::IGeoIDSvc *	m_geoIDSvcQuick {}

ParticleFilterArray	m_particleFilterHandle {this, "ParticleFilters", {}, "ISF Particle filters, defining whether a particle will be stored or not."}
	Array of filters to decide whether a particle is added to the Entry/Exit layer. More...

ISF::IParticleFilter **	m_particleFilter {}

size_t	m_numParticleFilters {0}

thread_utils::ThreadLocalOwner< std::array< TrackRecordCollection *, ISF::fNumAtlasEntryLayers > >	m_collectionHolder
	The entry layer collections. More...

std::string	m_volumeName [ISF::fNumAtlasEntryLayers]

Detailed Description

Definition at line 41 of file EntryLayerToolMT.h.

Constructor & Destructor Documentation

◆ EntryLayerToolMT()

ISF::EntryLayerToolMT::EntryLayerToolMT	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Constructor with parameters.

Constructor.

Definition at line 14 of file EntryLayerToolMT.cxx.

                                                                                                  :
   base_class(t,n,p),
   m_volumeName()
 {
   // volumeNames for TrackRecords
   declareProperty( "CaloEntryVolumeString",
                    m_volumeName[ISF::fAtlasCaloEntry] = "IDET::IDET",
                    "VolumeName in TrackRecords in CaloEntryLayer");
   declareProperty( "MuonEntryVolumeString",
                    m_volumeName[ISF::fAtlasMuonEntry] = "CALO::CALO",
                    "VolumeName in TrackRecords in MuonEntryLayer");
   declareProperty( "MuonExitVolumeString",
                    m_volumeName[ISF::fAtlasMuonExit]  = "MUONQ02::MUONQ02",
                    "VolumeName in TrackRecords in MuonExitLayer");
 }

◆ ~EntryLayerToolMT()

virtual ISF::EntryLayerToolMT::~EntryLayerToolMT ( )

virtualdefault

Destructor.

Member Function Documentation

◆ identifyEntryLayer()

ISF::EntryLayer ISF::EntryLayerToolMT::identifyEntryLayer ( const ISFParticle & particle )

finaloverridevirtual

Identify the corresponding entry layer for the given particle (may return ISF::fUnsetEntryLayere if particle is not on an entry layer surface)

Definition at line 70 of file EntryLayerToolMT.cxx.

                                                                                   {
   // the return value
   ISF::EntryLayer layerHit = ISF::fUnsetEntryLayer;
  
   const Amg::Vector3D &pos = particle.position();
  
   // check if particle on ID and/or Calo surface
   bool onIDSurface   = (m_geoIDSvcQuick->inside( pos, AtlasDetDescr::fAtlasID)   == ISF::fSurface);
   bool onCaloSurface = (m_geoIDSvcQuick->inside( pos, AtlasDetDescr::fAtlasCalo) == ISF::fSurface);
  
   // on CaloEntry layer ?
   if ( onIDSurface && onCaloSurface ) {
     layerHit = ISF::fAtlasCaloEntry;
   }
  
   // no surface hit yet -> test MS volume surface hit
   else {
     // check if particle on MS surface
     bool onMSSurface   = (m_geoIDSvcQuick->inside( pos, AtlasDetDescr::fAtlasMS) == ISF::fSurface);
  
     // on MuonEntry layer ?
     if (onCaloSurface && onMSSurface) {
       layerHit = ISF::fAtlasMuonEntry;
     }
     // on MuonExit layer ?
     else if (onMSSurface) {
       layerHit = ISF::fAtlasMuonExit;
     }
   }
   return layerHit;
 }

◆ initialize()

StatusCode ISF::EntryLayerToolMT::initialize ( )

finaloverridevirtual

Athena algtool's Hooks.

Definition at line 32 of file EntryLayerToolMT.cxx.

 {
   ATH_MSG_INFO("initialize() ...");
  
   // retrieve the GeoIDSvc
   ATH_CHECK ( m_geoIDSvc.retrieve() );
   // store a quick-access pointer to the c++ class directly
   m_geoIDSvcQuick = &(*m_geoIDSvc);
  
   // retrieve the ParticleFilters
   ATH_CHECK ( m_particleFilterHandle.retrieve() );
   // store a quick-access pointer to the c++ classes directly
   m_numParticleFilters = m_particleFilterHandle.size();
   m_particleFilter = new ISF::IParticleFilter*[ m_numParticleFilters ];
   for ( size_t curFilter = 0; curFilter<m_numParticleFilters; curFilter++) {
     // convert ToolHandle to standard c++ class pointer
     m_particleFilter[curFilter] = &(*m_particleFilterHandle[curFilter]);
   }
  
   ATH_MSG_INFO("initialize() successful");
   return StatusCode::SUCCESS;
 }

◆ passesFilters()

bool ISF::EntryLayerToolMT::passesFilters ( const ISFParticle & particle )

finaloverridevirtual

Check if given particle passes the EntryLayer filters.

Definition at line 57 of file EntryLayerToolMT.cxx.

                                                                     {
   bool pass = true;
   for ( size_t curFilter=0; pass && (curFilter<m_numParticleFilters); curFilter++) {
     // check current filter
     pass = m_particleFilter[curFilter]->passFilter( particle);
   }
  
   return pass;
 }

◆ registerParticle()

ISF::EntryLayer ISF::EntryLayerToolMT::registerParticle	(	const ISF::ISFParticle &	particle,
		ISF::EntryLayer	entryLayer
	)

finaloverridevirtual

Add the given particle to the corresponding Entry/Exit layer if applicable.

Definition at line 104 of file EntryLayerToolMT.cxx.

 {
   // (1.) check whether the particle actually passes all the filters
   //      -> rather fast usually
   if ( !passesFilters(particle) ) {
     // return if not passed
     return ISF::fUnsetEntryLayer;
   }
  
   // (2.) check whether the particle lies on any entry surface
   //      -> this goes second because computation intensive routines
   //         are used for this
   if ( layerHit == ISF::fUnsetEntryLayer) {
     layerHit = identifyEntryLayer( particle);
   }
  
   // (3.) if particle is on a boundary surface
   //        -> add it to TrackRecordCollection
   if ( layerHit != ISF::fUnsetEntryLayer) {
     ATH_MSG_VERBOSE( "Particle >>" << particle << "<< hit boundary surface, "
                      "adding it to '" << (*m_collectionHolder.get())[layerHit]->Name() << "' TrackRecord collection");
  
     const Amg::Vector3D   &pos = particle.position();
     const Amg::Vector3D   &mom = particle.momentum();
     CLHEP::Hep3Vector      hepPos( pos.x(), pos.y(), pos.z() ); // not optimal, but required by TrackRecord
     CLHEP::Hep3Vector      hepMom( mom.x(), mom.y(), mom.z() ); // not optimal, but required by TrackRecord
  
     double mass            = particle.mass();
     double energy          = std::sqrt(mass*mass + mom.mag2());
  
     // Use barcode of generation zero particle from truth binding if possible (reproduces legacy AtlasG4 behaviour).
     // Use barcode assigend to ISFParticle only if no generation zero particle is present.
     auto                truthBinding = particle.getTruthBinding();
     auto generationZeroGenParticle = truthBinding ? truthBinding->getGenerationZeroGenParticle() : nullptr;
     const int barcode = generationZeroGenParticle ? HepMC::barcode(generationZeroGenParticle) : HepMC::barcode(particle); // FIXME barcode-based
     const int id = generationZeroGenParticle ? HepMC::uniqueID(generationZeroGenParticle) : particle.id();
     const int status = generationZeroGenParticle ? generationZeroGenParticle->status() : particle.status();
  
     (*m_collectionHolder.get())[layerHit]->Emplace(particle.pdgCode(),
                                                    status,
                                                    energy,
                                                    hepMom,
                                                    hepPos,
                                                    particle.timeStamp(),
                                                    barcode, // FIXME barcode-based
                                                    id,
                                                    m_volumeName[layerHit] );
   }
  
   return layerHit;
 }

◆ registerTrackRecordCollection()

StatusCode ISF::EntryLayerToolMT::registerTrackRecordCollection	(	TrackRecordCollection *	collection,
		EntryLayer	layer
	)

finaloverridevirtual

Register the TrackRecordCollection pointer for a layer.

Definition at line 157 of file EntryLayerToolMT.cxx.

 {
   // Do we need to lock around this code???
   auto* collectionArray = m_collectionHolder.get();
   if (not collectionArray) {
     // need to create the array of TrackRecordCollections for this thread
     auto* temp = new std::array<TrackRecordCollection*, ISF::fNumAtlasEntryLayers>;
     m_collectionHolder.set(temp);
     collectionArray = m_collectionHolder.get();
   }
   (*collectionArray)[layer]=collection;
   return StatusCode::SUCCESS;
 }

◆ setupEvent()

virtual void ISF::EntryLayerToolMT::setupEvent ( )

inlineoverridevirtual

Definition at line 70 of file EntryLayerToolMT.h.

70 { return; }

Member Data Documentation

◆ m_collectionHolder

thread_utils::ThreadLocalOwner< std::array<TrackRecordCollection*, ISF::fNumAtlasEntryLayers> > ISF::EntryLayerToolMT::m_collectionHolder

private

The entry layer collections.

Definition at line 83 of file EntryLayerToolMT.h.

◆ m_geoIDSvc

ServiceHandle<ISF::IGeoIDSvc> ISF::EntryLayerToolMT::m_geoIDSvc {this, "GeoIDSvc", "GeoIDSvc", "AthenaService used to indentify sub-detector by (x,y,z) coordintes."}

private

GeoIDSvc will be used to determine the entry layer surface, the particle is on.

Definition at line 74 of file EntryLayerToolMT.h.

◆ m_geoIDSvcQuick

ISF::IGeoIDSvc* ISF::EntryLayerToolMT::m_geoIDSvcQuick {}

private

Definition at line 75 of file EntryLayerToolMT.h.

◆ m_numParticleFilters

size_t ISF::EntryLayerToolMT::m_numParticleFilters {0}

private

Definition at line 80 of file EntryLayerToolMT.h.

◆ m_particleFilter

ISF::IParticleFilter** ISF::EntryLayerToolMT::m_particleFilter {}

private

Definition at line 79 of file EntryLayerToolMT.h.

◆ m_particleFilterHandle

ParticleFilterArray ISF::EntryLayerToolMT::m_particleFilterHandle {this, "ParticleFilters", {}, "ISF Particle filters, defining whether a particle will be stored or not."}

private

Array of filters to decide whether a particle is added to the Entry/Exit layer.

Definition at line 78 of file EntryLayerToolMT.h.

◆ m_volumeName

std::string ISF::EntryLayerToolMT::m_volumeName[ISF::fNumAtlasEntryLayers]

private

Definition at line 84 of file EntryLayerToolMT.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EntryLayerToolMT()

◆ ~EntryLayerToolMT()

Member Function Documentation

◆ identifyEntryLayer()

◆ initialize()

◆ passesFilters()

◆ registerParticle()

◆ registerTrackRecordCollection()

◆ setupEvent()

Member Data Documentation

◆ m_collectionHolder

◆ m_geoIDSvc

◆ m_geoIDSvcQuick

◆ m_numParticleFilters

◆ m_particleFilter

◆ m_particleFilterHandle

◆ m_volumeName