EntryLayerToolMT.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
// class header include
#include "EntryLayerToolMT.h"
 
#include "TruthUtils/MagicNumbers.h"
 
// ISF includes
#include "ISF_Event/ISFParticle.h"
 
thread_local std::unique_ptr<std::array<TrackRecordCollection*, ISF::fNumAtlasEntryLayers>> ISF::EntryLayerToolMT::s_collection;

ISF::EntryLayerToolMT::EntryLayerToolMT(const std::string& t, const std::string& n, const IInterface* p) :
  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");
}
 

StatusCode  ISF::EntryLayerToolMT::initialize()
{
  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;
}
 

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

ISF::EntryLayer ISF::EntryLayerToolMT::identifyEntryLayer( const ISFParticle& particle) {
  // 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;
}
 

ISF::EntryLayer ISF::EntryLayerToolMT::registerParticle(const ISF::ISFParticle& particle, ISF::EntryLayer layerHit)
{
  // (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 '" << (*s_collection)[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();
 
    (*s_collection)[layerHit]->Emplace(particle.pdgCode(),
                                                   status,
                                                   energy,
                                                   hepMom,
                                                   hepPos,
                                                   particle.timeStamp(),
                                                   barcode, // FIXME barcode-based
                                                   id,
                                                   m_volumeName[layerHit] );
  }
 
  return layerHit;
}

StatusCode ISF::EntryLayerToolMT::registerTrackRecordCollection(TrackRecordCollection* collection, EntryLayer layer)
{
  if (!s_collection) {
    // need to create the array of TrackRecordCollections for this thread
    s_collection = std::make_unique<std::array<TrackRecordCollection*, ISF::fNumAtlasEntryLayers>>();
  }
  (*s_collection)[layer]=collection;
  return StatusCode::SUCCESS;
}