TRT_TrackExtensionTool_xk.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/

//   Implementation file for class InDet::TRT_TrackExtensionTool_xk
// (c) ATLAS Detector software
// Version 1.0 21/04/2004 I.Gavrilenko
 
 
#include "AthenaPoolUtilities/CondAttrListCollection.h"
#include "TRT_TrackExtensionTool_xk/TRT_TrackExtensionTool_xk.h"
#include "TrkRIO_OnTrack/RIO_OnTrack.h"
#include "InDetPrepRawData/SCT_Cluster.h"
#include "TrkTrack/Track.h"
#include "TrkTrack/TrackStateOnSurface.h"
#include <array>
#include <vector>
#include <iostream>
 
namespace{
  constexpr size_t MAX_ROAD_SIZE(399);
 
  std::vector<const Trk::Surface*> 
  vectorOfSurfacesFromVectorOfElements(const std::vector<const InDetDD::TRT_BaseElement*> & v){
    size_t roadsize{0};
    std::vector<const Trk::Surface*> surfaces;
    for(const auto &pThisElement: v) {
     surfaces.emplace_back(&(pThisElement->surface())); 
     if(++roadsize==MAX_ROAD_SIZE) break;
    }
    return surfaces;
  }
}

// Constructor
 
InDet::TRT_TrackExtensionTool_xk::TRT_TrackExtensionTool_xk
(const std::string& t,const std::string& n,const IInterface* p)
  : AthAlgTool(t,n,p)
{
  declareInterface<ITRT_TrackExtensionTool>(this);
}

// Destructor
 
InDet::TRT_TrackExtensionTool_xk::~TRT_TrackExtensionTool_xk()
= default;

// Initialisation
 
StatusCode InDet::TRT_TrackExtensionTool_xk::initialize()
{
 
  // Get magnetic field service
  //
  if(m_fieldmode != "NoField" ) {
    ATH_CHECK( m_fieldCondObjInputKey.initialize());
  }
 
  if     (m_fieldmode == "NoField"    ) m_fieldprop = Trk::MagneticFieldProperties(Trk::NoField  );
  else if(m_fieldmode == "MapSolenoid") m_fieldprop = Trk::MagneticFieldProperties(Trk::FastField);
  else                                  m_fieldprop = Trk::MagneticFieldProperties(Trk::FullField);
 
  // Get RIO_OnTrack creator with drift time information
  //
  ATH_CHECK(m_riontrackD.retrieve());
  ATH_MSG_DEBUG("Retrieved tool " << m_riontrackD);
  
  // Get RIO_OnTrack creator without drift time information
  //
  ATH_CHECK(m_riontrackN.retrieve());
  ATH_MSG_DEBUG("Retrieved tool " << m_riontrackN ) ;
 
  // Get detector elements road maker tool
  //
  ATH_CHECK(m_roadtool.retrieve());
  ATH_MSG_DEBUG("Retrieved tool " << m_roadtool);
 
  // Get propagator tool
  //
  ATH_CHECK(m_proptool.retrieve());
  ATH_MSG_DEBUG("Retrieved tool " << m_proptool);
 
  // Get updator tool
  //
  ATH_CHECK(m_updatortool.retrieve());
  ATH_MSG_DEBUG("Retrieved tool " << m_updatortool);
 
  // Get segment selector tool
  //
  ATH_CHECK(m_selectortool.retrieve(DisableTool { !m_parameterization } ));
 
  // TRT
  ATH_CHECK(detStore()->retrieve(m_trtid,"TRT_ID"));
 
  //Initialize container
  ATH_CHECK(m_trtname.initialize());
 
  // Get output print level
  //
  m_outputlevel = msg().level()-MSG::DEBUG;
  return StatusCode::SUCCESS;
}

// Finalize-
 
StatusCode InDet::TRT_TrackExtensionTool_xk::finalize()
{
   return StatusCode::SUCCESS;
}

// Dumps relevant information into the MsgStream
 
MsgStream& InDet::TRT_TrackExtensionTool_xk::dump( MsgStream& out ) const
{
  out<<std::endl;
  return dumpConditions(out);
}
 

// Dumps conditions information into the MsgStream
 
MsgStream& InDet::TRT_TrackExtensionTool_xk::dumpConditions( MsgStream& out ) const
{
  auto pad = [](const std::string & s)->std::string{
    std::string s1(s.size(),' ');
    s1+="|";
    return s + s1 +"\n";
  };
  const std::array<std::string,9> fieldmode{"NoField"       ,"ConstantField","SolenoidalField",
                 "ToroidalField" ,"Grid3DField"  ,"RealisticField" ,
                 "UndefinedField","AthenaField"  , "?????"         };
  int mode = m_fieldprop.magneticFieldMode();
  if(mode<0 || mode>8 ) mode = 8;
  std::string lineSeparator(90,'-');
  lineSeparator = "|" + lineSeparator + "|\n";
  const auto & w12 = std::setw(12);
  const auto & sp5 = std::setprecision(5);
  const std::string spaces = "                                                    |\n";
  out<< lineSeparator;
  out<<"| TRT container           | "<< pad(m_trtname.key());
  out<<"| Tool for propagation    | "<< pad(m_proptool.type());
  out<<"| Tool for updator        | "<< pad(m_updatortool.type());
  out<<"| Tool for rio  on trackD | "<< pad(m_riontrackD.type());
  out<<"| Tool for rio  on trackN | "<< pad(m_riontrackN.type());
  out<<"| Tool for road builder   | "<< pad(m_roadtool.type());
  out<<"| Magnetic field mode     | "<< pad(fieldmode[mode]);
  out<<"| Segments find  mode     | "<< w12 << m_segmentFindMode << spaces;
  out<<"| TRT road half width (mm)| "<< w12 << sp5<< m_roadwidth << spaces;
  out<<"| Min number DriftCircles | "<< w12 << m_minNumberDCs << spaces;
  out<<"| Use drift time  ?       | "<< w12 << m_usedriftrad << spaces;
  out<<"| Z vertex half width     | "<< w12 << m_zVertexWidth << spaces;
  out<<"| Scalefactor hit error   | "<< w12 << m_scale_error <<spaces;
  out<<"| Max impact parameter    | "<< w12 << m_impact <<spaces;
  out<< lineSeparator;
  return out;
}

// Dumps relevant information into the ostream
 
std::ostream& InDet::TRT_TrackExtensionTool_xk::dump( std::ostream& out ) const
{
  return out;
}

// Overload of << operator MsgStream
 
MsgStream& InDet::operator    <<
  (MsgStream& sl,const InDet::TRT_TrackExtensionTool_xk& se)
{
  return se.dump(sl);
}

// Overload of << operator std::ostream
 
std::ostream& InDet::operator <<
  (std::ostream& sl,const InDet::TRT_TrackExtensionTool_xk& se)
{
  return se.dump(sl);
}

// Track extension initiation
 
std::unique_ptr<InDet::ITRT_TrackExtensionTool::IEventData>
InDet::TRT_TrackExtensionTool_xk::newEvent(const EventContext& ctx) const
{
  SG::ReadHandle<TRT_DriftCircleContainer> trtcontainer(m_trtname, ctx);
 
  if((not trtcontainer.isValid()) && m_outputlevel<=0) {
    std::stringstream msg;
    msg << "Missing TRT_DriftCircleContainer " << m_trtname.key();
    throw std::runtime_error( msg.str() );
  }
 
  // Get AtlasFieldCache
  MagField::AtlasFieldCache fieldCache;
 
  SG::ReadCondHandle<AtlasFieldCacheCondObj> readHandle{m_fieldCondObjInputKey, ctx};
  const AtlasFieldCacheCondObj* fieldCondObj{*readHandle};
  if (fieldCondObj == nullptr) {
      ATH_MSG_ERROR("InDet::TRT_TrackExtensionTool_xk::findSegment: Failed to retrieve AtlasFieldCacheCondObj with key " << m_fieldCondObjInputKey.key());
      return nullptr;
  }
  fieldCondObj->getInitializedCache (fieldCache);
 
  Trk::MagneticFieldProperties     fieldprop =  ( fieldCache.solenoidOn()
                                                  ? m_fieldprop
                                                  : Trk::MagneticFieldProperties(Trk::NoField  ));
 
  auto event_data = std::make_unique<EventData>(EventData(trtcontainer.cptr(), m_maxslope));
  event_data->m_trajectory.set(fieldprop, fieldCondObj);
  event_data->m_trajectory.set (m_trtid,
                                m_proptool.get(),
                                m_updatortool.get(),
                                m_riontrackD.get(),
                                m_riontrackN.get(),
                                m_roadwidth,
                                m_zVertexWidth,
                                m_impact,
                                m_scale_error,
                                m_minTRTSegmentpT);
  event_data->m_measurement.reserve(200);
  return event_data;
}

// Main methods for track extension to TRT
 
std::vector<const Trk::MeasurementBase*>&
InDet::TRT_TrackExtensionTool_xk::extendTrack(const EventContext& ctx,
                                              const Trk::Track& Tr,
                                              InDet::ITRT_TrackExtensionTool::IEventData &virt_event_data,
                                              InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap& used) const
{
  InDet::TRT_TrackExtensionTool_xk::EventData &
     event_data=InDet::TRT_TrackExtensionTool_xk::EventData::getPrivateEventData(virt_event_data);
  event_data.m_measurement.clear();
  const Trk::TrackStates* tsos = Tr.trackStateOnSurfaces();
  const Trk::TrackParameters* par = tsos->back()->trackParameters(); //tsos owns this
  if(!par ) return event_data.m_measurement;
  const Trk::TrackParameters* parb = tsos->front()->trackParameters(); //tsos owns this
  if(parb && par!=parb) {
    const Amg::Vector3D& g1 = par ->position();
    const Amg::Vector3D& g2 = parb->position();
    if((g2.x()*g2.x()+g2.y()*g2.y()) > (g1.x()*g1.x()+g1.y()*g1.y())) par=parb;
  }
  return extendTrackFromParameters(ctx, par, event_data,used);
}

// Main methods for track extension to TRT for pixles+sct tracks
 
std::vector<const Trk::MeasurementBase*>&
InDet::TRT_TrackExtensionTool_xk::extendTrack(const EventContext& ctx,
                                              const Trk::TrackParameters * par,
                                              InDet::ITRT_TrackExtensionTool::IEventData &virt_event_data,
                                              InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap& used) const
{
  InDet::TRT_TrackExtensionTool_xk::EventData &
     event_data=InDet::TRT_TrackExtensionTool_xk::EventData::getPrivateEventData(virt_event_data);
  return extendTrackFromParameters(ctx, par, event_data, used);
}
 
 
std::vector<const Trk::MeasurementBase*>&
InDet::TRT_TrackExtensionTool_xk::extendTrackFromParameters(const EventContext& ctx,
                                                            const Trk::TrackParameters * par,
                                                            InDet::TRT_TrackExtensionTool_xk::EventData &event_data,
                                                            InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap& used) const
{
  event_data.m_measurement.clear();
  if(isGoodExtension(ctx, par,event_data,used)) event_data.m_trajectory.convert(event_data.m_measurement);
  return event_data.m_measurement;
}

// Main methods for segment finding in TRT for TRT seeds
 
Trk::TrackSegment*
InDet::TRT_TrackExtensionTool_xk::findSegment(const EventContext& ctx,
                                              const Trk::TrackParameters * par,
                                              InDet::ITRT_TrackExtensionTool::IEventData &virt_event_data,
                                              InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap& used) const
{
  InDet::TRT_TrackExtensionTool_xk::EventData &
     event_data=InDet::TRT_TrackExtensionTool_xk::EventData::getPrivateEventData(virt_event_data);
 
  int nCut = m_minNumberDCs;
  if(m_parameterization) {nCut = m_selectortool->minNumberDCs(par); 
  if(nCut<m_minNumberDCs) nCut=m_minNumberDCs;}
 
  // Get AtlasFieldCache
  MagField::AtlasFieldCache fieldCache;
 
  SG::ReadCondHandle<AtlasFieldCacheCondObj> readHandle{m_fieldCondObjInputKey, ctx};
  const AtlasFieldCacheCondObj* fieldCondObj{*readHandle};
  if (fieldCondObj == nullptr) {
      ATH_MSG_ERROR("InDet::TRT_TrackExtensionTool_xk::findSegment: Failed to retrieve AtlasFieldCacheCondObj with key " << m_fieldCondObjInputKey.key());
      return nullptr;
  }
  fieldCondObj->getInitializedCache (fieldCache);
 
  // TRT detector elements road builder
  //
  const std::vector<const InDetDD::TRT_BaseElement*>& detectorElements =
      m_roadtool->detElementsRoad(ctx, fieldCache, *par, Trk::alongMomentum,
                                  used);
 
  if(int(detectorElements.size())< nCut) return nullptr;
 
  // Array pointers to surface preparation
  //
  auto surfaces =vectorOfSurfacesFromVectorOfElements(detectorElements);
 
  // Global position on surfaces production
  //
  Trk::PatternTrackParameters Tp; 
  if(!Tp.production(par)) return nullptr;
  std::vector< std::pair<Amg::Vector3D,double> > gpos;
  m_proptool->globalPositions(ctx, Tp, surfaces, gpos, m_fieldprop);
 
  // Initiate trajectory
  //
  event_data.m_trajectory.initiateForTRTSeed(gpos,detectorElements,event_data.m_trtcontainer,Tp);
  if(event_data.m_trajectory.naElements() < nCut) return nullptr;
  event_data.m_maxslope      = .0002     ;
  if(event_data.m_trajectory.isFirstElementBarrel()) {
    if(m_usedriftrad)  event_data.m_trajectory.trackFindingWithDriftTime   (event_data.m_maxslope);
    else               event_data.m_trajectory.trackFindingWithoutDriftTime(event_data.m_maxslope);
    if(!event_data.m_trajectory.searchStartStop()) {return nullptr;}
  } else   {
    event_data.m_trajectory.trackFindingWithoutDriftTime(event_data.m_maxslope);
    if(!event_data.m_trajectory.searchStartStop()) { return nullptr;}
    event_data.m_trajectory.radiusCorrection();
    if(m_usedriftrad) event_data.m_trajectory.trackFindingWithDriftTimeBL   (event_data.m_maxslope);
    else              event_data.m_trajectory.trackFindingWithoutDriftTimeBL(event_data.m_maxslope);
    if(!event_data.m_trajectory.searchStartStop()) { return nullptr;}
  }
 
  // Track associate with clusters and holes
  //
  event_data.m_trajectory.buildTrajectoryForTRTSeed(m_usedriftrad);
  event_data.m_maxslope = m_maxslope;
 
  // Trajectory quality test
  //
  int nc = event_data.m_trajectory.nclusters();
  int nh = event_data.m_trajectory.nholes   ();
  if( nc < nCut  || (1000*nc) < (700*(nc+nh)) ) return nullptr;
 
  if     (m_segmentFindMode==0) {
    if(!event_data.m_trajectory.trackParametersEstimationForPerigeeWithVertexConstraint())
      return nullptr;
  }
  else if(m_segmentFindMode==1) {
    if(!event_data.m_trajectory.trackParametersEstimationForFirstPointWithVertexConstraint())
      return nullptr;
  }
  else if(m_segmentFindMode==2) {
    if(!event_data.m_trajectory.trackParametersEstimationForFirstPoint())
      return nullptr;
  }
  else                          {
    if(!event_data.m_trajectory.fitter())
      return nullptr;
  }
 
  if(event_data.m_trajectory.nclusters() < nCut) return nullptr;
 
  // Trk::TrackSegment production
  //
  return event_data.m_trajectory.convert();
}

// Test possiblity extend track to TRT for pixels+sct tracks
 
bool 
InDet::TRT_TrackExtensionTool_xk::isGoodExtension(const EventContext& ctx,
                                                       const Trk::TrackParameters * par,
                                                       InDet::TRT_TrackExtensionTool_xk::EventData &event_data,
                                                       InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap& used) const
{
  // Get AtlasFieldCache
  MagField::AtlasFieldCache fieldCache;
 
  SG::ReadCondHandle<AtlasFieldCacheCondObj> readHandle{m_fieldCondObjInputKey, ctx};
  const AtlasFieldCacheCondObj* fieldCondObj{*readHandle};
  if (fieldCondObj == nullptr) {
      ATH_MSG_ERROR("InDet::TRT_TrackExtensionTool_xk::findSegment: Failed to retrieve AtlasFieldCacheCondObj with key " << m_fieldCondObjInputKey.key());
      return false;
  }
  fieldCondObj->getInitializedCache (fieldCache);
  // TRT detector elements road builder
  //
  const std::vector<const InDetDD::TRT_BaseElement*>& detectorElements =
      m_roadtool->detElementsRoad(ctx, fieldCache, *par, Trk::alongMomentum, used);
  if (int(detectorElements.size()) < m_minNumberDCs)
      return false;
  // Array pointers to surface preparation
  //
  auto surfaces = vectorOfSurfacesFromVectorOfElements(detectorElements);
  
  // Global position on surfaces production
  //
  Trk::PatternTrackParameters Tp; 
  if(!Tp.production(par)) return false;
  std::vector< std::pair<Amg::Vector3D,double> > gpos;
  m_proptool->globalPositions(ctx, Tp,surfaces,gpos,m_fieldprop);
 
  // Initiate trajectory
  //
 
  event_data.m_trajectory.initiateForPrecisionSeed(gpos,detectorElements,event_data.m_trtcontainer,Tp);
  if(event_data.m_trajectory.naElements() < m_minNumberDCs) return false;
 
  // Track finding
  //
  if(m_usedriftrad)  event_data.m_trajectory.trackFindingWithDriftTime   (event_data.m_maxslope);
  else               event_data.m_trajectory.trackFindingWithoutDriftTime(event_data.m_maxslope);
 
  // Track associate with clusters and holes
  //
  event_data.m_trajectory.buildTrajectoryForPrecisionSeed(m_usedriftrad);
 
  // Final test quality
  //
  return event_data.m_trajectory.nclusters() >= m_minNumberDCs;
}

// Methods for track extension to TRT for pixles+sct tracks
// and new track production
 
Trk::Track* 
InDet::TRT_TrackExtensionTool_xk::newTrack(const EventContext& ctx,
                                           const Trk::Track& Tr,
                                           InDet::ITRT_TrackExtensionTool::IEventData &virt_event_data,
                                           InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap& used) const
{
  InDet::TRT_TrackExtensionTool_xk::EventData &
     event_data=InDet::TRT_TrackExtensionTool_xk::EventData::getPrivateEventData(virt_event_data);
 
  const Trk::TrackStates* tsos = Tr.trackStateOnSurfaces();
 
  // Test conditions to start track extension to TRT
  //
  const Trk::TrackParameters* pe  = tsos->back()->trackParameters(); 
  if(!pe) return nullptr; 
  if(!pe->covariance()) return nullptr;
  const Trk::TrackParameters* pb  = tsos->front()->trackParameters(); 
  if(!pb) return nullptr;
  if(!pb->covariance()) return nullptr;
 
  // Number PIX and SCT clusters cuts
  //
  if(!numberPIXandSCTclustersCut(Tr)) return nullptr;
 
  // Test possibility extend track and new track production
  //
  if(isGoodExtension(ctx, pe,event_data,used)) return event_data.m_trajectory.convert(Tr);
  return nullptr;
}

// Number of SCT clusters test for start extension
 
bool 
InDet::TRT_TrackExtensionTool_xk::numberPIXandSCTclustersCut(const Trk::Track& Tr) const
{
  if(m_minNumberSCT <=0 && m_minNumberPIX <=0) return true;
  const Trk::TrackStates*tsos = Tr.trackStateOnSurfaces();
  Trk::TrackStates::const_iterator s = tsos->begin(), se = tsos->end();
  int npix = 0;
  int nsct = 0;
  for(; s!=se; ++s) {
    if((*s)->type(Trk::TrackStateOnSurface::Measurement)) {
      const Trk::MeasurementBase* mb = (*s)->measurementOnTrack();
      if(!mb) continue;
      const Trk::RIO_OnTrack*     ri = dynamic_cast<const Trk::RIO_OnTrack*>(mb);
      if(!ri) continue;
      const Trk::PrepRawData*     rd = ri->prepRawData();
      if(!rd) continue;
      const InDet::SiCluster*     si = dynamic_cast<const InDet::SiCluster*>(rd);
      if(si) {
        if(dynamic_cast<const InDet::SCT_Cluster*>(si)) ++nsct;
        else                                            ++npix;
      }
      else return false;
    }
  }
  return npix >= m_minNumberPIX && nsct >= m_minNumberSCT;
}