StripDefectsEmulatorAlg.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef InDet_StripDefectsEmulatorAlg_H
#define InDet_StripDefectsEmulatorAlg_H
 
#include "DefectsEmulatorAlg.h"
#include "InDetRawData/SCT_RDO_Container.h"
#include "StripEmulatedDefects.h"
#include "InDetIdentifier/SCT_ID.h"
#include "SCT_ReadoutGeometry/SCT_ModuleSideDesign.h"
 
#include <utility>
 
namespace InDet {
 
   template <>
   struct DefectsEmulatorTraits<SCT_RDO_Container> {
 
      using ID_Helper = const  SCT_ID*;

      struct IDAdapter {
         ID_Helper m_idHelper;
         static const std::vector<int> s_dummyvector;
 
         IDAdapter(ID_Helper helper) : m_idHelper(helper) {}
         int row_index(const Identifier &rdoID) const { return m_idHelper->strip(rdoID); }
         int col_index(const Identifier &rdoID) const { return m_idHelper->row(rdoID); }
         template <typename T_ModuleHelper>
         std::unique_ptr<SCT3_RawData> createNoiseHit(const T_ModuleHelper &helper, const Identifier &identifier, unsigned int cell_idx, unsigned int tot) {
            unsigned int row_aka_phi=cell_idx % helper.rows(); // ->strip
            unsigned int col_aka_eta=cell_idx / helper.rows(); // ->sensor row i.e. 1
            constexpr unsigned int group_size =1u;
            constexpr unsigned int errors=0u;
            return std::make_unique<SCT3_RawData>( m_idHelper->strip_id(identifier,col_aka_eta, row_aka_phi),
                                                   makeStripWord( /*time bin */ tot, /*stripIn11bits*/ row_aka_phi, group_size, errors ),
                                                   &s_dummyvector);
         }
         unsigned int nConsecutiveRows(const SCT_RDORawData &rdo) const {
            return rdo.getGroupSize();
         }

         unsigned int cloneOrRejectHit( const StripModuleHelper &module_helper,
                                        const StripEmulatedDefects &emulated_defects,
                                        unsigned int idHash,
                                        unsigned int row_idx_aka_phi,
                                        unsigned int col_idx_aka_eta,
                                        const SCT_RDORawData &rdo,
                                        InDetRawDataCollection<SCT_RDORawData> &dest) {
            unsigned int n_new=0u;
            assert( rdo.getGroupSize() > 0);
            // search for all defects starting from the last strip in the group (search is performed in descending order)
            StripModuleHelper::KEY_TYPE rdo_end_key = module_helper.hardwareCoordinates(row_idx_aka_phi+rdo.getGroupSize()-1, col_idx_aka_eta);
            auto [defect_iter, end_iter] =emulated_defects.lower_bound(idHash, rdo_end_key);
 
            //  A) 0 defect overlapping with strip group
            //      => lower_bound(strip+group_size()-1) < strip-mask+1     -> clone
            //  B) 1 defect overlapping
            //     => lower_bound(strip+group_size()-1) < strip >= strip-mask+1 -> hit[strip .. defect-1], hit[defect+mask.. strip+group_size-1]
            //        iter++ < strip-mask+1
            //  C) n defects overlapping
            //        => lower_bound(strip+group_size()-1) < strip >= strip-mask+1  -> hit[defect+mask.. strip+group_size-1],
            //                                                                         defect+mast>strip  ?  hit[defect+mask.. last_defect-1] -> loop
            //                                                                                            : hit[strip..last_defect-1] -> end
 
            StripModuleHelper::KEY_TYPE rdo_key = module_helper.hardwareCoordinates(row_idx_aka_phi, col_idx_aka_eta);
            unsigned int strip = module_helper.getRow(rdo_key);
            std::pair<unsigned int, unsigned int> overlap = (defect_iter != end_iter
                                                             ?  getOverlap( module_helper,
                                                                            EmulatedDefects<StripModuleHelper>::getRange(defect_iter),
                                                                            strip,
                                                                            rdo.getGroupSize())
                                                             : std::make_pair(0u,0u));
            if (overlap.second==0) {
               dest.push_back(std::make_unique<SCT3_RawData>(dynamic_cast<const SCT3_RawData &>(rdo)).release() );
               ++n_new;
            }
            else if (static_cast<unsigned int>(rdo.getGroupSize()) != overlap.second) {
               const SCT3_RawData &sct3_rdo = dynamic_cast<const SCT3_RawData &>(rdo);
               Identifier module_id = m_idHelper->module_id(rdo.identify());
 
               unsigned int last_defect_start = strip + rdo.getGroupSize();
               for (;;) {
                  unsigned int start = overlap.first + overlap.second;
                  unsigned int group_size = last_defect_start - start;
                  if (group_size > 0) {
                     dest.push_back(std::make_unique<SCT3_RawData>( m_idHelper->strip_id(module_id,col_idx_aka_eta, start),
                                                                    makeStripWord( sct3_rdo.getTimeBin(), start, group_size, getErrorBits(rdo) ),
                                                                    &s_dummyvector));
                     ++n_new;
                  }
                  if (overlap.first == strip) break;
                  last_defect_start = overlap.first;
 
                  // if it is a range the range end key is already handled
                  // so skip it.
                  ++defect_iter;
                  if (defect_iter != end_iter && StripModuleHelper::isRangeKey(*defect_iter)) {
                     // make sure that last_defect start is not smaller than the first strip in the strip group
                     // otherwise the group size for the next strip group would become negative.
                     last_defect_start = std::max(static_cast<unsigned int>(module_helper.getRow(*defect_iter)),strip);
                     ++defect_iter;
                  }
 
                  if (defect_iter != end_iter) {
                     overlap = getOverlap( module_helper,
                                           EmulatedDefects<StripModuleHelper>::getRange(defect_iter),
                                           strip,
                                           rdo.getGroupSize());
                  }
                  else {
                     overlap.first=strip;
                     overlap.second=0u;
                  }
               }
            }
            return n_new;
         }
 
      protected:
         static inline unsigned int makeStripWord( unsigned int time_bin, unsigned int strip, unsigned int group_size, unsigned int error_bits) {
            assert((group_size & (~0x7FFu)) == 0u);
            assert((strip & (~0x7FFu)) == 0u);
            assert((time_bin & (~0x7u)) == 0u);
            assert((error_bits & (~0x3Fu)) == 0u );
            unsigned int word  = group_size | (strip<<11u) | (time_bin<<22u) | (error_bits <<25u);
            return word;
         }

         static inline unsigned int getErrorBits( const SCT_RDORawData &rdo ) {
            return (rdo.getWord() >>25u) & 0x7u;
         }

         std::pair<unsigned int,unsigned int> getOverlap( const StripModuleHelper &module_helper,
                                                          const std::pair<StripModuleHelper::KEY_TYPE, StripModuleHelper::KEY_TYPE> &defect_range,
                                                          unsigned int strip,
                                                          unsigned int sequence_length) {
            static_assert( StripModuleHelper::CHIP_MASK == StripModuleHelper::KEY_TYPE{});
            static_assert( StripModuleHelper::COL_MASK == StripModuleHelper::KEY_TYPE{});
            unsigned int defect_row_start = module_helper.getRow(defect_range.first);
            unsigned int defect_row_end = module_helper.getRow(defect_range.second)+1;
            unsigned int strip_row = strip;
            if (defect_row_end-defect_row_start>1u) {
               if (defect_row_end >= strip_row && defect_row_start < strip_row+sequence_length) {
                  unsigned int overlap_start = defect_row_start > strip_row ? defect_row_start : strip_row;
                  unsigned int overlap_end = defect_row_end < strip_row+sequence_length ? defect_row_end :  strip_row+sequence_length;
                  return std::make_pair( overlap_start , overlap_end- overlap_start);
               }
            }
            else {
               if (defect_row_start >= strip_row && defect_row_start < strip_row+sequence_length) {
                  return std::make_pair(defect_row_start,1u);
               }
            }
            return std::make_pair(strip,0u);
         }
 
 
      };
 
      using DefectsData = StripEmulatedDefects;
      using RDORawData =  SCT_RDORawData;
      using ModuleHelper = StripModuleHelper;
      using ModuleDesign = InDetDD::SCT_ModuleSideDesign;
      static constexpr ActsTrk::DetectorType DETECTOR_TYPE = ActsTrk::DetectorType::Sct;
   };

   class StripDefectsEmulatorAlg :public DefectsEmulatorAlg<SCT_RDO_Container>
   {
   public:
      using DefectsEmulatorAlg<SCT_RDO_Container>::DefectsEmulatorAlg;
   };
}
#endif