TRTRetriever.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#include "TRTRetriever.h"
#include "JiveXML/DataType.h"
 
#include "TRT_ReadoutGeometry/TRT_DetectorManager.h"
#include "TRT_ReadoutGeometry/TRT_BaseElement.h"
#include "InDetIdentifier/TRT_ID.h"
#include "TrkEventPrimitives/ParamDefs.h"
 
// ReadHandle
#include "StoreGate/ReadHandle.h"
 
namespace JiveXML {

  TRTRetriever::TRTRetriever(const std::string& type,const std::string& name,const IInterface* parent):
    AthAlgTool(type,name,parent)
  {
    //Declare the interface
    declareInterface<IDataRetriever>(this);
 
    //And properties
    declareProperty("TRTTruthMap" , m_TRTTruthMapKey = "PRD_MultiTruthTRT");
  }
 
  StatusCode TRTRetriever::initialize() {
    ATH_CHECK( m_geo.retrieve() );
    ATH_CHECK( m_TRTDriftCircleCollKey.initialize() );
    m_useTRTTruthMap = !m_TRTTruthMapKey.key().empty();
    ATH_CHECK( m_TRTTruthMapKey.initialize(m_useTRTTruthMap) );
    return StatusCode::SUCCESS;
  }
 
  StatusCode TRTRetriever::retrieve(ToolHandle<IFormatTool> &FormatTool) {
    //be verbose
    ATH_MSG_DEBUG( "Retrieving " << dataTypeName() ); 
  
    //First try to retrieve the DriftCircleContainer
    SG::ReadHandle<InDet::TRT_DriftCircleContainer> DriftCircleContainer( m_TRTDriftCircleCollKey );
    if ( !DriftCircleContainer.isValid() ) {
      ATH_MSG_DEBUG( "Unable to retrieve TRT_DriftCircleContainer with name " << m_TRTDriftCircleCollKey.key() );
      return StatusCode::RECOVERABLE;
    }
 
    //Also try to obtain the truth container
    SG::ReadHandle<PRD_MultiTruthCollection> TRTMultiTruthMap;
    if ( m_useTRTTruthMap ) {
      TRTMultiTruthMap = SG::makeHandle(m_TRTTruthMapKey);
      if ( !TRTMultiTruthMap.isValid() ){
        //Only warn if this container is not available
        ATH_MSG_DEBUG( "Unable to retrieve PRD_MultiTruthCollection with name " << m_TRTTruthMapKey.key() );
      }
    }
 
    //Get total size of all all drift circles in all collections
    unsigned long NDriftCircleTotal = 0;
    //Loop over collections in container
    for (const auto DriftCircleColl : *DriftCircleContainer)
      NDriftCircleTotal += DriftCircleColl->size();
 
    //be verbose
    ATH_MSG_VERBOSE( "Reserving space for " << NDriftCircleTotal << " entries" );
    
    //Rerserve space in the map
    DataVect rhoz; rhoz.reserve(NDriftCircleTotal);
    DataVect phi; phi.reserve(NDriftCircleTotal);
    DataVect driftR; driftR.reserve(NDriftCircleTotal);
    DataVect threshold; threshold.reserve(NDriftCircleTotal);
    DataVect ident; ident.reserve(NDriftCircleTotal);
    DataVect sub; sub.reserve(NDriftCircleTotal);
    DataVect noise; noise.reserve(NDriftCircleTotal);
    DataVect timeOverThreshold; timeOverThreshold.reserve(NDriftCircleTotal);
    DataVect bitPattern; bitPattern.reserve(NDriftCircleTotal); 
    DataVect numBarcodes; numBarcodes.reserve(NDriftCircleTotal);
    DataVect barcodes; barcodes.reserve(NDriftCircleTotal); //< on average less than one, so this should be enough
 
    //Now loop over container to retrieve the data
    for (const auto DriftCircleColl : *DriftCircleContainer) {
      
      for (const auto driftcircle : *DriftCircleColl){
 
        //Get the drift cirlce itself and its unique identifier
 
        //In verbose mode, print out drift circle information
        ATH_MSG_VERBOSE( "Retrieving information from " << (*driftcircle) );
 
        Identifier id = driftcircle->identify();
 
        //Check if it is valid
        if (! id.is_valid()) {
          ATH_MSG_DEBUG( "Ignoring TRT_DriftCircle with invalid identifier " << id );
          continue;
        }
 
        //Store the identifier
        ident.push_back(DataType(id.get_compact()));

        const InDetDD::TRT_BaseElement* element = m_geo->TRTGeoManager()->getElement(m_geo->TRTIDHelper()->layer_id(id));
 
        //get global coord of straw
          Amg::Vector3D global  = element->strawTransform(m_geo->TRTIDHelper()->straw(id))*Amg::Vector3D(0.,0.,0.);
        
        //store the phi value
        phi.push_back(DataType( (global.phi()<0) ? global.phi() + 2*M_PI : global.phi()));
        
        //store rho for barrel and z for endcap
        if (element->type()==InDetDD::TRT_BaseElement::BARREL)
          rhoz.push_back(DataType(global.perp()*CLHEP::mm/CLHEP::cm));
        else if (element->type()==InDetDD::TRT_BaseElement::ENDCAP)
          rhoz.push_back(DataType(global.z()*CLHEP::mm/CLHEP::cm)); 
        else 
          ATH_MSG_VERBOSE( "Unknown TRT base element of type " << element->type() );
 
        //Store local position parameters
        driftR.push_back(DataType((driftcircle->localPosition())[Trk::driftRadius]*CLHEP::mm/CLHEP::cm));
 
        //Get subdetector number
        switch ( m_geo->TRTIDHelper()->barrel_ec(id) ) {
          case -2 : sub.push_back(DataType( 0 )); break;
          case -1 : sub.push_back(DataType( 1 )); break;
          case  1 : sub.push_back(DataType( 2 )); break;
          case  2 : sub.push_back(DataType( 3 )); break;
          default : sub.push_back(DataType(-1 ));
        }
        
        //Store threshold related parameters
        threshold.push_back(DataType(driftcircle->highLevel()));
        timeOverThreshold.push_back(DataType(driftcircle->timeOverThreshold())); 
        noise.push_back(DataType(driftcircle->isNoise()));
        bitPattern.push_back(DataType(driftcircle->getWord()));

        if ( !m_useTRTTruthMap || !TRTMultiTruthMap.isValid() ) continue;
 
        //Count number of barcodes we get
        int NBarcodes = 0;
        //Loop over associated truth tracks with same id
        using iter = PRD_MultiTruthCollection::const_iterator;
        std::pair<iter,iter> equalIDRange = TRTMultiTruthMap->equal_range(id);
        for ( iter TRTMultiTruthMapItr = equalIDRange.first; TRTMultiTruthMapItr != equalIDRange.second; ++TRTMultiTruthMapItr){
          NBarcodes++;
          barcodes.push_back(DataType(TRTMultiTruthMapItr->second.barcode()));
        }
        numBarcodes.push_back(DataType(NBarcodes));
      } //loop over collection
    }//loop over container
        
    //Add everything to our data map
    DataMap dataMap;
    dataMap["rhoz"]= rhoz;
    dataMap["phi"]= std::move(phi);
    dataMap["driftR"]= std::move(driftR);
    dataMap["threshold"]= std::move(threshold);
    dataMap["id"]= std::move(ident);
    dataMap["sub"]= std::move(sub);
    dataMap["noise"]= std::move(noise);
    dataMap["timeOverThreshold"]= std::move(timeOverThreshold);
    dataMap["bitPattern"]= std::move(bitPattern);
 
    //Only write truth association tags if we processed truth
    if ( numBarcodes.size() > 0 ){
      //Add barcodes counter
      dataMap["numBarcodes"]= numBarcodes;
      // Compute the "multiple" for barcodes and put the vector in the map.
      std::string bctag = "barcodes multiple=\""+DataType(barcodes.size()/double(numBarcodes.size())).toString()+"\"";
      dataMap[bctag]= std::move(barcodes);
    }
      
    //be verbose
    ATH_MSG_DEBUG( dataTypeName() << ": " << rhoz.size() );  
 
    //forward data to formating tool and return
    return FormatTool->AddToEvent(dataTypeName(), "", &dataMap);  
  }
}