TrackHandle_TrkTrack.cxx

Go to the documentation of this file.

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

//                                                            //
//  Implementation of class TrackHandle_TrkTrack              //
//                                                            //
//  Author: Thomas H. Kittelmann (Thomas.Kittelmann@cern.ch)  //
//  Initial version: February 2008                            //
//
//  Updates:
//  - 2023 Sep, Riccardo Maria BIANCHI @ cern.ch, added Pt to track item in the browser
//                                                            //
 
#include "VP1TrackSystems/TrackHandle_TrkTrack.h"
#include "VP1TrackSystems/TrackSystemController.h"
#include "VP1TrackSystems/TrackCollHandle_TrkTrack.h"
#include "VP1TrackSystems/VP1TrackSanity.h"
#include "VP1TrackSystems/TrkObjToString.h"
#include "VP1Utils/VP1JobConfigInfo.h"
#include "TrkTrack/Track.h"
#include "TrkTrack/TrackStateOnSurface.h"
#include "TrkSurfaces/Surface.h"
#include "Identifier/Identifier.h"
#include "MuonReadoutGeometry/MuonReadoutElement.h"
#include "TrkMeasurementBase/MeasurementBase.h"
#include "TrkRIO_OnTrack/RIO_OnTrack.h"
#include "TrkCompetingRIOsOnTrack/CompetingRIOsOnTrack.h"
#include "VP1Base/VP1Msg.h"//fixme
#include "VP1TrackSystems/VP1TrackSummary.h"
#include "VP1TrackSystems/AscObj_TSOS.h"
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoNode.h>
 
 
 
//____________________________________________________________________
TrackHandle_TrkTrack::TrackHandle_TrkTrack(TrackCollHandleBase* ch, const Trk::Track* trk)
  : TrackHandleBase(ch),
    m_nhits_pixel(0), m_nhits_sct(0), m_nhits_trt(0), m_nhits_muon_phi(0), m_nhits_rpc(0), m_nhits_mdt(0), 
    m_nhits_tgc(0), m_nhits_csc(0), m_nhits_mm(0), m_nhits_stgc(0), m_hitInfoStatus(-1),
    m_trk(trk)
{
}
 
//____________________________________________________________________
TrackHandle_TrkTrack::~TrackHandle_TrkTrack()
{
}
 
//____________________________________________________________________
QStringList TrackHandle_TrkTrack::clicked() const
{
    // Object browser stuff
  QTreeWidget* trkObjBrowser = common()->controller()->trackObjBrowser();
  if (trkObjBrowser){    
    trkObjBrowser->setCurrentItem(browserTreeItem());
    trkObjBrowser->scrollToItem(browserTreeItem());
  }
  QStringList l;
  l << "Trk::Track";
  if (!m_trk) {
    l << "ERROR: This TrackHandle_TrkTrack handle has a NULL track pointer!!";
    return l;
  }
  l << "Author info: " << "  "+QString(m_trk->info().dumpInfo().c_str());
 
  l << TrackHandleBase::baseInfo();
  if (m_trk->fitQuality()) 
    l << "Fit quality [Chi^2, nDoF] = ["+QString::number(m_trk->fitQuality()->chiSquared())+", "+QString::number(m_trk->fitQuality()->doubleNumberDoF())+"]. ";
  if (common()->controller()->printVerboseInfoOnSingleSelection()) {
    l << " ===== dump =====";
    std::ostringstream s;
    s << *m_trk;
    l << QString(s.str().c_str()).split('\n');
  }
  return l;
}
 
//____________________________________________________________________
void TrackHandle_TrkTrack::ensureTouchedMuonChambersInitialised() const
{
  //Fixme: TO BASE!!!
 
  VP1TrackSanity * sanity = common()->trackSanityHelper();
  if (!VP1JobConfigInfo::hasMuonGeometry()||!sanity) {
    VP1Msg::messageVerbose("TrackHandle_TrkTrack WARNING: can't init touched muon chamber list.");
    return;
  }
  Trk::TrackStates::const_iterator tsos_iter = m_trk->trackStateOnSurfaces()->begin();
  Trk::TrackStates::const_iterator tsos_end = m_trk->trackStateOnSurfaces()->end();
  for (; tsos_iter != tsos_end; ++tsos_iter) {
    if (!VP1TrackSanity::isSafe(*tsos_iter)) {
      if (VP1Msg::verbose())
    VP1Msg::messageVerbose("TrackHandle_TrkTrack WARNING: Skipping unsafe TSOS for touched muon chamber determination.");
      continue;
    }
    ensureTouchedMuonChambersInitialiasedFromMeas( (*tsos_iter)->measurementOnTrack() );
  }
}
 
void TrackHandle_TrkTrack::ensureTouchedMuonChambersInitialiasedFromMeas( const Trk::MeasurementBase* meas ) const
{
  if (meas) {
    const Trk::CompetingRIOsOnTrack* crot = dynamic_cast<const Trk::CompetingRIOsOnTrack*>(meas);
 
    // for competing ROTs, it is expected that these are in the same DE. If this turns out not to be the case, need to loop & recursively call this method. EJWM
    if (crot)
      meas=&(crot->rioOnTrack(0));
    if (!VP1TrackSanity::isSafe(meas)) {
      if (VP1Msg::verbose())
        VP1Msg::messageVerbose("TrackHandle_TrkTrack WARNING: Skipping unsafe TSOS for touched muon chamber determination.");
      return;
    }
 
    const Trk::RIO_OnTrack* rio = dynamic_cast<const Trk::RIO_OnTrack*>(meas);
    if (rio) {
      const MuonGM::MuonReadoutElement* muonDetEl = getMuonReadoutElement(*rio);
      if (muonDetEl)
        registerTouchedMuonChamber(muonDetEl->getMaterialGeom()->getParent());
    }
  }
}
 
 
 
//____________________________________________________________________
Amg::Vector3D TrackHandle_TrkTrack::momentum() const
{
  for (const Trk::TrackParameters* param : *m_trk->trackParameters()) {
    if (!common()->trackSanityHelper()->isSafe(param))
      continue;
    return param->momentum();
  }
  return TrackHandleBase::momentum();
}
 
//____________________________________________________________________
void TrackHandle_TrkTrack::visibleStateChanged()
{
  static_cast<TrackCollHandle_TrkTrack*>(collHandle())->visibleStateUpdated(this);
  TrackHandleBase::visibleStateChanged();
}
 
//____________________________________________________________________
void TrackHandle_TrkTrack::currentMaterialChanged()
{
  if (visible())
    static_cast<TrackCollHandle_TrkTrack*>(collHandle())->visibleStateUpdated(this);
}
 
//____________________________________________________________________
void TrackHandle_TrkTrack::ensureInitSubSysHitInfo() const
{
  if (m_hitInfoStatus==-1) 
    m_hitInfoStatus = VP1TrackSummary::countHits( m_trk, m_nhits_pixel, m_nhits_sct, m_nhits_trt, m_nhits_muon_phi, m_nhits_rpc, m_nhits_mdt, m_nhits_tgc, m_nhits_csc, m_nhits_mm, m_nhits_stgc) ? 1 : 0;
}
 
void TrackHandle_TrkTrack::fillObjectBrowser( QList<QTreeWidgetItem *>& listOfItems) 
{
  TrackHandleBase::fillObjectBrowser(listOfItems); // Obligatory!
   
  // Fill sub-data.
  QList<AssociatedObjectHandleBase*> list = getAllAscObjHandles();
  DataVector< const Trk::TrackStateOnSurface >::const_iterator it  = trkTrackPointer()->trackStateOnSurfaces ()->begin(), 
  itE = trkTrackPointer()->trackStateOnSurfaces ()->end();
  unsigned int i=0;
  for (;it!=itE;++it){
//    VP1Msg::messageVerbose("TSOS #"+QString::number(i++));
 
    bool visible=false;
    QTreeWidgetItem* TSOSitem = new QTreeWidgetItem(browserTreeItem());
    
    AscObj_TSOS* asc=nullptr;
    if (i<static_cast<unsigned int>(list.size())) asc = dynamic_cast<AscObj_TSOS*>(list.at(i));
 
    if (asc) {
      asc->setBrowserTreeItem(TSOSitem);
      visible=asc->visible();
    }
    
    if (!visible) {
      TSOSitem->setFlags(Qt::ItemFlag());// not selectable, not enabled
      QFont itemFont = TSOSitem->font(0);
      itemFont.setStrikeOut(true);
      TSOSitem->setFont(0, itemFont);
      TSOSitem->setFont(1, itemFont);
    } 
    TSOSitem->setText(0, QString("Track State "+QString::number( (int)(it - trkTrackPointer()->trackStateOnSurfaces ()->begin() ) ) ) );
    
    QString tsosText;      
    bool first=true;
    const Trk::MeasurementBase* meas = (*it)->measurementOnTrack();
    if (  meas ){
      QString measName(TrkObjToString::name(*meas));
      tsosText+=measName;
      
      QTreeWidgetItem* measItem = new QTreeWidgetItem(TSOSitem);
      measItem->setExpanded(true); // want it opened so subparams seen easily
      measItem->setFlags(Qt::ItemIsEnabled);
      measItem->setText(0, measName);
      // measItem->setText(1, TrkObjToString::shortInfo(*meas) );
      
      QStringList list = TrkObjToString::fullInfo( *((*it)->measurementOnTrack ()) );
      for (int i = 0; i < (list.size()-1); ){
        QTreeWidgetItem* subparamItem = new QTreeWidgetItem(measItem);
        subparamItem->setText(0, list.at(i++) );
        subparamItem->setText(1, list.at(i++) );   
        subparamItem->setFlags(Qt::ItemIsEnabled); 
      }
      
      first=false;
    }
    if ( (*it)->trackParameters () ) {
      if (!first) tsosText.append(" + ");
      tsosText.append("Parameters");
      
      QTreeWidgetItem* paramItem = new QTreeWidgetItem(TSOSitem);
      paramItem->setExpanded(true); // want it opened so subparams seen easily
      paramItem->setFlags(Qt::ItemIsEnabled); 
      paramItem->setText(0, TrkObjToString::name(      *((*it)->trackParameters ()) ) );
      // paramItem->setText(1, TrkObjToString::shortInfo( *((*it)->trackParameters ()) ) );
      
      QStringList list = TrkObjToString::fullInfo( *((*it)->trackParameters ()) );
      for (int i = 0; i < (list.size()-1); ){
        QTreeWidgetItem* subparamItem = new QTreeWidgetItem(paramItem);
        subparamItem->setText(0, list.at(i++) );
        subparamItem->setText(1, list.at(i++) ); 
        subparamItem->setFlags(Qt::ItemIsEnabled);   
      }
      
      first=false;
    }
    if ( (*it)->materialEffectsOnTrack () ){
      if (!first) tsosText.append(" + ");
      tsosText.append("MaterialEffectsOnTrack"); 
      QTreeWidgetItem* meItem = new QTreeWidgetItem(TSOSitem);
      meItem->setExpanded(true); // want it opened so subparams seen easily
      meItem->setFlags(Qt::ItemIsEnabled);
      
      meItem->setText(0, TrkObjToString::name(      *((*it)->materialEffectsOnTrack ()) ) );
      meItem->setText(1, TrkObjToString::shortInfo( *((*it)->materialEffectsOnTrack ()) ) );
      
      first=false;
    }
    if ( (*it)->fitQualityOnSurface () ){ 
      if (!first) tsosText.append(" + ");
      tsosText.append("FitQuality");
      QTreeWidgetItem* fqItem = new QTreeWidgetItem(TSOSitem);
      fqItem->setExpanded(true); // want it opened so subparams seen easily
      fqItem->setFlags(Qt::ItemIsEnabled);
      fqItem->setText(0,       QString("FitQuality") );
      fqItem->setText(1, TrkObjToString::shortInfo( (*it)->fitQualityOnSurface () ) );
      
      first=false;
    }
    // FIXME - add information about chamber for Muon systems?
    
    if ( (*it)->type(Trk::TrackStateOnSurface::Outlier) ){ 
      if (!first) tsosText.append(" + ");
      tsosText.append("Outlier"); 
    }
    
    if ( (*it)->type(Trk::TrackStateOnSurface::InertMaterial) ){ 
      if (!first) tsosText.append(" + ");
      tsosText.append("InertMaterial"); 
    }
    
    if ( (*it)->type(Trk::TrackStateOnSurface::BremPoint) ){ 
      if (!first) tsosText.append(" + ");
      tsosText.append("BremPoint"); 
    }
    
    if ( (*it)->type(Trk::TrackStateOnSurface::Perigee) ){ 
      if (!first) tsosText.append(" + ");
      tsosText.append("Perigee"); 
    }
    
    if ( (*it)->type(Trk::TrackStateOnSurface::Hole) ){ 
      if (!first) tsosText.append(" + ");
      tsosText.append("Hole"); 
    }
    TSOSitem->setText(1, tsosText );
  }
  // listOfItems << browserTreeItem();
}
 
SoNode* TrackHandle_TrkTrack::zoomToTSOS(unsigned int index)
{
  if (trkTrackPointer() && (index<trkTrackPointer()->trackStateOnSurfaces()->size() )){
    const Trk::TrackStateOnSurface* tsos = (*trkTrackPointer()->trackStateOnSurfaces())[index];
    // now find matching AscObj_TSOS
    QList<AssociatedObjectHandleBase*> list = getAllAscObjHandles();
    for (int i = 0; i < list.size(); ++i) {
      // VP1Msg::messageVerbose("TrackSystemController::objectBrowserClicked: checking ASC "+QString::number(i));
      
      AscObj_TSOS* asc = dynamic_cast<AscObj_TSOS*>(list.at(i));
      if (asc) {
        if (asc && asc->trackStateOnSurface()==tsos) {
           VP1Msg::messageVerbose("TrackSystemController::objectBrowserClicked: this ASC matches "+QString::number(i));
          //asc->zoomView();
          return asc->shapeDetailed();
        }
      }
    }
  }
  return nullptr;
}
 
QString TrackHandle_TrkTrack::shortInfo() const
{
  // get the track's momentum
  Amg::Vector3D mom = momentum();
  mom /= CLHEP::GeV;
  
  // format info string 
  QString l;
  l += "|Pt|="+VP1Msg::str(mom.perp())+" [GeV], ";
  l += "|P|="+VP1Msg::str(mom.mag())+" [GeV], ";
  l += "Pix["+QString::number(getNPixelHits())+"], SCT["+QString::number(getNSCTHits())+"], TRT["+QString::number(getNTRTHits())
   +"], MDT["+QString::number(getNMDTHits())+"], RPC["+QString::number(getNRPCHits())+"], TGC["+QString::number(getNTGCHits())+"], CSC["+QString::number(getNCSCHits())+"], MM["+QString::number(getNMMHits())+"], sTGC["+QString::number(getNsTGCHits());
  return l;
}
 
 
void TrackHandle_TrkTrack::updateObjectBrowser(){
  
  if ( !browserTreeItem()) {
    VP1Msg::messageVerbose("updateObjectBrowser: No m_objBrowseTree!");
    return;
  }
  
  if (!visible()) {
    browserTreeItem()->setFlags(Qt::ItemFlag()); // not selectable, not enabled
  } else {
    browserTreeItem()->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled); //  selectable,  enabled
  }
  QFont font= browserTreeItem()->font(0);
  font.setStrikeOut(!visible());
  browserTreeItem()->setFont(0, font );
  browserTreeItem()->setFont(1, font );
 
  
  // FIXME! Only do if necessary i.e. if something affecting this TSOS has changed.
  
  QList<AssociatedObjectHandleBase*> list = getAllAscObjHandles();
  
  if (list.empty()) {
    VP1Msg::message("No ASC objects associated with this track - no track components visible yet?");
    return;
  }
    
  DataVector< const Trk::TrackStateOnSurface >::const_iterator it  = trkTrackPointer()->trackStateOnSurfaces ()->begin(), 
  itE = trkTrackPointer()->trackStateOnSurfaces ()->end();
  unsigned int numOfTSOS=0;
  for (;it!=itE;++it,++numOfTSOS){
    AscObj_TSOS* asc = dynamic_cast<AscObj_TSOS*>(list.at(numOfTSOS));
    if (!(asc && asc->trackStateOnSurface()==*it && !list.empty()) ) {
      // Fallback.
      VP1Msg::message("TSOS#"+QString::number(numOfTSOS)+" does not seem to match AscObj_TSOS in list, which has size="+QString::number(list.size())+" Will try fallback.");
      for (int i = 0; i < list.size(); ++i) {          
        AscObj_TSOS* asc = dynamic_cast<AscObj_TSOS*>(list.at(i));
        if (asc && asc->trackStateOnSurface()==*it) {
          VP1Msg::message("-> this ASC matches "+QString::number(i));
        } 
      }      
    }
    if (!asc) {
      VP1Msg::message("Could not find matching Asc in list of size "+QString::number(list.size()));
      continue;
    }
    
    if (!asc->browserTreeItem()){
      // not set yet - so need to do this now. Can we just use the index?
      asc->setBrowserTreeItem(browserTreeItem()->child(numOfTSOS));
    }
    
    if (!asc->browserTreeItem()){
      VP1Msg::message("Could not find matching browserTreeItem");
      continue;
    }
    
    if (!asc->visible()) {
      asc->browserTreeItem()->setFlags(Qt::ItemFlag()); // not selectable, not enabled
    } else {
      asc->browserTreeItem()->setFlags(Qt::ItemIsSelectable | Qt::ItemIsEnabled); //  selectable,  enabled
    }    
    QFont itemFont = asc->browserTreeItem()->font(0);
    itemFont.setStrikeOut(!asc->visible());
    asc->browserTreeItem()->setFont(0, itemFont);
    asc->browserTreeItem()->setFont(1, itemFont);
  }
}
 
const Trk::FitQuality* TrackHandle_TrkTrack::getFitQuality() const {
  return m_trk ? m_trk->fitQuality ():nullptr;
}
 
bool TrackHandle_TrkTrack::containsDetElement(const QString &id) const
{
  VP1Msg::messageVerbose("TrackHandle_TrkTrack::containsDetElement looking for " + id);
  Identifier::value_type tmpInt = id.toLong(nullptr,10);//base 10
  Identifier::value_type tmpInt2 = id.toLong(nullptr,16);//base 16...why?
 
  VP1Msg::messageVerbose("TrackHandle_TrkTrack::looping over TSOS ");
 
  Trk::TrackStates::const_iterator it = trkTrackPointer()->trackStateOnSurfaces()->begin(),
                                                             itE = trkTrackPointer()->trackStateOnSurfaces()->end();
  for (; it != itE; ++it)
  {
    // Still debugging, so leaving this in for now...
    // std::cout<<(*it)->surface().associatedDetectorElementIdentifier()<<std::endl;      
    if ((*it)->surface().associatedDetectorElementIdentifier()==tmpInt) {
      VP1Msg::messageVerbose("TrackHandle_TrkTrack::containsDetElement FOUND " + id + "!");
      return true;  
    }
    if ((*it)->surface().associatedDetectorElementIdentifier()==tmpInt2) {
      VP1Msg::messageVerbose("TrackHandle_TrkTrack::containsDetElement FOUND 2 " + id + "!");
      return true;  
    }
  }
  return false;
}