TRT_DriftCircleTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
//   Implementation file for class TRT_DriftCircleTool
// (c) ATLAS Detector software
// AlgTool used for TRT RDI collection production
// Version 1.0 18/02/2003 I.Gavrilenko
 
#include "GaudiKernel/ISvcLocator.h"
#include "GaudiKernel/DataSvc.h"
#include "GaudiKernel/SmartDataPtr.h"
#include "TRT_DriftCircleTool/TRT_DriftCircleTool.h"
#include "InDetPrepRawData/TRT_DriftCircle.h"
#include "InDetPrepRawData/TRT_DriftCircleCollection.h"
#include "InDetRawData/TRT_RDORawData.h"
 
#include "TRT_DriftFunctionTool/ITRT_DriftFunctionTool.h"
#include "InDetIdentifier/TRT_ID.h"
#include "TRT_ConditionsServices/ITRT_StrawStatusSummaryTool.h"
 
#include "GeoPrimitives/GeoPrimitives.h"
#include "EventPrimitives/EventPrimitives.h"
#include "xAODEventInfo/EventInfo.h"
 
#include "StoreGate/ReadCondHandle.h"
// Constructior
 
InDet::TRT_DriftCircleTool::TRT_DriftCircleTool(const std::string& t, 
                        const std::string& n,
                        const IInterface*  p ):
  AthAlgTool(t,n,p),
  m_driftFunctionTool("TRT_DriftFunctionTool"),
  m_ConditionsSummary("TRT_StrawStatusSummaryTool",this),
  m_useConditionsStatus(false),
  m_useConditionsHTStatus(false),
  m_useToTCorrection(false),
  m_useHTCorrection(false),
  m_trtid(nullptr),
  m_reject_if_first_bit(false),
  m_reject_if_first_bit_argon(true),
  m_min_trailing_edge(11.0*CLHEP::ns),
  m_min_trailing_edge_argon(11.0*CLHEP::ns),
  m_max_drift_time(60*CLHEP::ns),
  m_max_drift_time_argon(60*CLHEP::ns),
  m_out_of_time_supression(false),
  m_out_of_time_supression_argon(false),
  m_validity_gate_suppression(false),
  m_validity_gate_suppression_argon(false),
  m_low_gate(18.0*CLHEP::ns),
  m_low_gate_argon(18.0*CLHEP::ns),
  m_high_gate(38.0*CLHEP::ns),
  m_high_gate_argon(38.0*CLHEP::ns)
{
  declareInterface<ITRT_DriftCircleTool>(this);
  declareProperty("TRTDriftFunctionTool", m_driftFunctionTool);
  declareProperty("ConditionsSummaryTool",m_ConditionsSummary);
  declareProperty("UseConditionsStatus",m_useConditionsStatus);
  declareProperty("UseConditionsHTStatus",m_useConditionsHTStatus);
  declareProperty("useDriftTimeToTCorrection",m_useToTCorrection);
  declareProperty("useDriftTimeHTCorrection",m_useHTCorrection);
  declareProperty("RejectIfFirstBit",m_reject_if_first_bit);
  declareProperty("RejectIfFirstBitArgon",m_reject_if_first_bit_argon);
  declareProperty("MinTrailingEdge",m_min_trailing_edge);
  declareProperty("MinTrailingEdgeArgon",m_min_trailing_edge_argon);
  declareProperty("MaxDriftTime",m_max_drift_time);
  declareProperty("MaxDriftTimeArgon",m_max_drift_time_argon);
  declareProperty("SimpleOutOfTimePileupSupression",m_out_of_time_supression);
  declareProperty("SimpleOutOfTimePileupSupressionArgon",m_out_of_time_supression_argon);
  declareProperty("ValidityGateSuppression",m_validity_gate_suppression);
  declareProperty("ValidityGateSuppressionArgon",m_validity_gate_suppression_argon);
  declareProperty("LowGate",m_low_gate);
  declareProperty("LowGateArgon",m_low_gate_argon);
  declareProperty("HighGate",m_high_gate);
  declareProperty("HighGateArgon",m_high_gate_argon);
}
 
// Destructor  
 
InDet::TRT_DriftCircleTool::~TRT_DriftCircleTool()= default;
 
// Initialisation
 
StatusCode InDet::TRT_DriftCircleTool::initialize()
{
 
  StatusCode sc = AthAlgTool::initialize(); 
 
  // Get DriftFunction tool servise
  //
  if ( m_driftFunctionTool.retrieve().isFailure() ) {
    ATH_MSG_FATAL(  m_driftFunctionTool.propertyName() << ": Failed to retrieve tool " << m_driftFunctionTool.type() );
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG(  m_driftFunctionTool.propertyName() << ": Retrieved tool " << m_driftFunctionTool.type() );
 
  if(m_useConditionsStatus || m_useConditionsHTStatus){
    if ( m_ConditionsSummary.retrieve().isFailure() ) {
    ATH_MSG_FATAL( "Failed to retrieve "<< m_ConditionsSummary);
      return StatusCode::FAILURE;
    }
    ATH_MSG_DEBUG( "Retrieved tool " << m_ConditionsSummary);
  }
 
  // Get TRT ID helper
  sc = detStore()->retrieve(m_trtid,"TRT_ID");
  if ( sc.isFailure() ) {
    ATH_MSG_FATAL( "Could not retrieve TRT ID helper." );
    return sc;
  }
 
  ATH_CHECK(m_lumiDataKey.initialize ( !m_lumiDataKey.key().empty() ));
  if (m_lumiDataKey.key().empty()) {
     ATH_MSG_DEBUG("Luminosity conditions data key not set. No mu correction." );
  }
 
  // Initialize readCondHandle key
  ATH_CHECK(m_trtDetEleContKey.initialize());
 
  return sc;
}
 
// Finalize
 
StatusCode InDet::TRT_DriftCircleTool::finalize()
{
   StatusCode sc = AthAlgTool::finalize(); return sc;
}
 
// Test validity gate
bool InDet::TRT_DriftCircleTool::passValidityGate(unsigned int word, float lowGate, float highGate, float t0) const
{
  bool foundInterval = false;
  unsigned  mask = 0x02000000;
  int i = 0;
  while ( !foundInterval && (i < 24) ) {
    if (word & mask) {
      float thisTime = ((0.5+i)*3.125)-t0;
      if (thisTime >= lowGate && thisTime <= highGate) foundInterval = true;
    }
    mask >>= 1;
    if (i == 7 || i == 15) 
      mask >>= 1;
    i++;
  }
  return foundInterval;
}
 
 
// Trk::TRT_DriftCircles collection production
 
InDet::TRT_DriftCircleCollection*
InDet::TRT_DriftCircleTool::convert(
  int Mode,
  const InDetRawDataCollection<TRT_RDORawData>* rdo,
  const EventContext& ctx,
  DataPool<TRT_DriftCircle>* dataItemsPool,
  const bool getTRTBadChannel) const
{
 
  //Initialise a new TRT_DriftCircleCollection
  InDet::TRT_DriftCircleCollection* rio = nullptr;
 
  if (!rdo) {
    ATH_MSG_ERROR("empty TRT raw data collection");
    return rio;
  }
 
  SG::ReadCondHandle<InDetDD::TRT_DetElementContainer> trtDetEleHandle(m_trtDetEleContKey, ctx);
  const InDetDD::TRT_DetElementCollection* elements(trtDetEleHandle->getElements());
  if (not trtDetEleHandle.isValid() or elements==nullptr) {
    ATH_MSG_FATAL(m_trtDetEleContKey.fullKey() << " is not available.");
    return rio;
  }
 
  float mu = 0;
  if (!m_lumiDataKey.empty()) {
     SG::ReadCondHandle<LuminosityCondData> lumiData (m_lumiDataKey, ctx);
     mu = lumiData->lbAverageInteractionsPerCrossing();
  }
 
  DataVector<TRT_RDORawData>::const_iterator r,rb=rdo->begin(),re=rdo->end(); 
 
    //Get the BaseElement and initialize the RIO collection
    IdentifierHash IHc                 = rdo      ->identifyHash();
    const InDetDD::TRT_BaseElement* pE = elements->getDetectorElement(IHc);
    rio                                = new InDet::TRT_DriftCircleCollection(IHc);
    rio->setIdentifier(rdo->identify());
    rio->reserve( std::distance(rb, re) );
    //DataPool will own them if there.
    if (dataItemsPool) {
     rio->clear(SG::VIEW_ELEMENTS);
    }
 
    bool isArgonStraw = false;
    bool isGasSet = false;
 
    // Loop through all RDOs in the collection
    //
    for(r=rb; r!=re; ++r) {
 
      // raw data
      Identifier       id  = (*r)->identify();
      int            LTbin = (*r)->driftTimeBin(); 
      bool  isOK           =true;
      double t0            =0.;
      double rawTime       = m_driftFunctionTool->rawTime(LTbin);
      unsigned int word    = (*r)->getWord(); 
 
      // Gas status - assumed same for all rdo's in the collection
      if (m_useConditionsHTStatus && !isGasSet) {
         if (m_ConditionsSummary->getStatusHT(id, ctx) == TRTCond::StrawStatus::Argon ||
             m_ConditionsSummary->getStatusHT(id, ctx) == TRTCond::StrawStatus::Dead) {
            isArgonStraw = true;
         }
         isGasSet = true;
      }
 
 
      // ToT and HT Corrections            
      if (m_useToTCorrection) {
        rawTime -= m_driftFunctionTool->driftTimeToTCorrection((*r)->timeOverThreshold(), id, isArgonStraw);     
      }  
      if (m_useHTCorrection && (*r)->highLevel()) {
         rawTime += m_driftFunctionTool->driftTimeHTCorrection(id, isArgonStraw);           
      }
 
      // calibrated data
      double radius    = 0.;
      double driftTime = 0.;
      if( LTbin==0 || LTbin==24) {
        isOK=false;
      } else {
        bool dummy=false;
        radius    = m_driftFunctionTool->driftRadius(rawTime,id,t0,dummy,word);
        driftTime = rawTime-t0;
      }
      if(!isOK) word &= 0xF7FFFFFF;
      else word |= 0x08000000;
 
      // test validity gate
      rawTime = (0.5+LTbin)*3.125;  //redefine rawTime in order to keep Tier0 frozen
      if (!isArgonStraw) {
         if (m_out_of_time_supression) {
            // reject if first bit true 
            if ((word & 0x02000000) && m_reject_if_first_bit) continue;
            // or if trailing edge (which is drift time + ToT) is less than min trailing edge
            if ((rawTime + (*r)->timeOverThreshold()) < m_min_trailing_edge) continue;
            // if leading edge is too large
            if (rawTime > m_max_drift_time) continue;
         }
           
         if (m_validity_gate_suppression) {
        if(!passValidityGate(word, m_low_gate, m_high_gate, t0)) continue;
         }
      } else { // is argon straw, in case we want to do anything different for argon straws
         if (m_out_of_time_supression_argon) {
           // reject if first bit true 
           if ((word & 0x02000000) && m_reject_if_first_bit_argon) continue;
           // or if trailing edge (which is drift time + ToT) is less than min trailing edge
           if ((rawTime + (*r)->timeOverThreshold()) < m_min_trailing_edge_argon) continue;
           // or if leading edge is too large
           if (rawTime > m_max_drift_time_argon) continue;
         }
 
         if (m_validity_gate_suppression_argon) {
           if (!passValidityGate(word, m_low_gate_argon, m_high_gate_argon, t0))
             continue;
         }
      }
 
      // Require good straw status
      if (m_useConditionsStatus && getTRTBadChannel) {
        if (m_ConditionsSummary->getStatus(id,ctx) != TRTCond::StrawStatus::Good)
          continue;
      }
 
      // Error on Drift Radius
      double error = 0;
      // LE out of range. Make tube hit.
      if (!isOK || Mode > 1) {
        ATH_MSG_VERBOSE(" Making tube hit.");
        radius = 0.;
        error = 4. / sqrt(12.);
      } else {
        error =
          m_driftFunctionTool->errorOfDriftRadius(driftTime, id, mu, word);
      }
 
      // Fill the RIO collection with TRT_DriftCircle's
      auto errmat = Amg::MatrixX(1,1);
      errmat(0,0) = error*error;
      Amg::Vector2D loc(radius, 0.);
 
      InDet::TRT_DriftCircle* tdc = nullptr;
      //
      if (dataItemsPool) {
        tdc = dataItemsPool->nextElementPtr();
        (*tdc) = InDet::TRT_DriftCircle(id, loc, std::move(errmat), pE, word);
      } else {
        tdc = new InDet::TRT_DriftCircle(id, loc, std::move(errmat), pE, word);
      }
      //
      if (tdc) {
        tdc->setHashAndIndex(rio->identifyHash(), rio->size());
        rio->push_back(tdc);
 
        ATH_MSG_VERBOSE(
          " accept hit id "
          << m_trtid->barrel_ec(id) << " " << m_trtid->layer_or_wheel(id) << " "
          << m_trtid->phi_module(id) << " " << m_trtid->straw_layer(id) << " "
          << m_trtid->straw(id) << " data word " << MSG::hex << tdc->getWord()
          << MSG::dec << " data word raw " << MSG::hex << (*r)->getWord()
          << MSG::dec << " radius " << radius << " err " << error);
 
        ATH_MSG_VERBOSE(" driftTime " << tdc->rawDriftTime() << " t0 " << t0
                                      << " raw time " << (0.5 + LTbin) * 3.125
                                      << " ToT " << tdc->timeOverThreshold()
                                      << " OK? " << isOK << " Noise? "
                                      << tdc->isNoise() << " isArgon? "
                                      << isArgonStraw);
      } else {
        ATH_MSG_ERROR("Could not create InDet::TRT_DriftCircle object !");
      }
    } // end loop over rdo's in the rdo collection
 
  return rio;
}