ATLAS Offline Software
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
InDet::EmulatedDefects< T_ModuleHelper > Class Template Reference

Data structure do mark e.g. More...

#include <EmulatedDefects.h>

Inheritance diagram for InDet::EmulatedDefects< T_ModuleHelper >:
Collaboration diagram for InDet::EmulatedDefects< T_ModuleHelper >:

Classes

class  greater
 Special greater operator which ignores the column group flag in the comparison. More...
 

Public Types

using KEY_TYPE = typename T_ModuleHelper::KEY_TYPE
 

Public Member Functions

 EmulatedDefects (const InDetDD::SiDetectorElementCollection &detector_elements)
 
std::pair< typename std::vector< KEY_TYPE >::const_iterator, typename std::vector< KEY_TYPE >::const_iterator > lower_bound (unsigned int id_hash, KEY_TYPE key) const
 Convenience method to find the preceding defect. More...
 
bool isDefect (const T_ModuleHelper &helper, unsigned int id_hash, KEY_TYPE key) const
 Test whether a pixel or strip on a certain module is marked as defect. More...
 
bool isDefect (const T_ModuleHelper &helper, unsigned int id_hash, unsigned int row_idx_aka_phi, unsigned int col_idx_aka_eta) const
 Test whether a pixel on a certain module is marked as defect. More...
 
bool isModuleDefect (unsigned int id_hash) const
 Return true if the module defined by the given ID hash is defect. More...
 
void setModuleDefect (unsigned int id_hash)
 Mark the specified module as defect. More...
 
const InDetDD::SiDetectorElement & getDetectorElement (unsigned int id_hash) const
 Return the detector element for the given ID hash. More...
 
const InDetDD::SiDetectorElementCollection & getDetectorElementCollection () const
 Return the detector element collection. More...
 

Static Public Member Functions

static std::pair< typename std::vector< KEY_TYPE >::iterator, typename std::vector< KEY_TYPE >::iterator > lower_bound (std::vector< KEY_TYPE > &module_defects, KEY_TYPE key)
 Convenience method to find the preceding defect. More...
 

Public Attributes

T elements
 STL member. More...
 

Static Public Attributes

static constexpr unsigned int MASK_FOR_COMPARISON = T_ModuleHelper::CHIP_MASK | T_ModuleHelper::ROW_MASK | T_ModuleHelper::COL_MASK
 
static constexpr bool s_needMasking = T_ModuleHelper::N_MASKS>0
 

Protected Member Functions

void resize (std::size_t n_modules)
 Resize data structures for this number of modules. More...
 

Protected Attributes

std::vector< bool > m_moduleIsDefect
 
const InDetDD::SiDetectorElementCollection * m_detectorElements
 

Detailed Description

template<class T_ModuleHelper>
class InDet::EmulatedDefects< T_ModuleHelper >

Data structure do mark e.g.

pixel defects for a list of modules. Contains a list of ordered hardware coordinates marking defect "pixels" for each module identified by an ID hash (consecutive integer). Defects can be either individual pixel defects or column group defects (group of 8 consecutive columns). The defects are expected to be ordered in descending order (excluding the column group flag), such that std::lower_bound together with the supplied greater comparator will yield the defect which is either identical, has a smaller column address or smaller row address. If the elements are in a different order the results will be undefined.

Definition at line 24 of file EmulatedDefects.h.

Member Typedef Documentation

◆ KEY_TYPE

template<class T_ModuleHelper >
using InDet::EmulatedDefects< T_ModuleHelper >::KEY_TYPE = typename T_ModuleHelper::KEY_TYPE

Definition at line 29 of file EmulatedDefects.h.

Constructor & Destructor Documentation

◆ EmulatedDefects()

template<class T_ModuleHelper >
InDet::EmulatedDefects< T_ModuleHelper >::EmulatedDefects ( const InDetDD::SiDetectorElementCollection &  detector_elements)
inline

Definition at line 31 of file EmulatedDefects.h.

32  : m_detectorElements(&detector_elements)
33  {
34  resize( m_detectorElements->size() );
35  }

Member Function Documentation

◆ getDetectorElement()

template<class T_ModuleHelper >
const InDetDD::SiDetectorElement& InDet::EmulatedDefects< T_ModuleHelper >::getDetectorElement ( unsigned int  id_hash) const
inline

Return the detector element for the given ID hash.

will throw a range_error if the ID hash is invalid.

Definition at line 120 of file EmulatedDefects.h.

120  {
121  return *(m_detectorElements->at(id_hash));
122  }

◆ getDetectorElementCollection()

template<class T_ModuleHelper >
const InDetDD::SiDetectorElementCollection& InDet::EmulatedDefects< T_ModuleHelper >::getDetectorElementCollection ( ) const
inline

Return the detector element collection.

Definition at line 125 of file EmulatedDefects.h.

125  {
126  return *m_detectorElements;
127  }

◆ isDefect() [1/2]

template<class T_ModuleHelper >
bool InDet::EmulatedDefects< T_ModuleHelper >::isDefect ( const T_ModuleHelper &  helper,
unsigned int  id_hash,
KEY_TYPE  key 
) const
inline

Test whether a pixel or strip on a certain module is marked as defect.

Parameters
helperutility matching this defect data to check whether a defect overlaps with pixel coordinates.
id_hasha valid ID hash
keypacked hardware coordinates of the pixel to be tested.
Returns
true if this data structure contains a defect for this module which overlaps with the given pixel coordinates. Will throw a range_error if the ID hash is invalid.

Definition at line 87 of file EmulatedDefects.h.

87  {
88  auto [defect_iter, end_iter] =lower_bound(id_hash, key);
89  return (defect_iter != end_iter && helper.isMatchingDefect( *defect_iter, key) );
90  }

◆ isDefect() [2/2]

template<class T_ModuleHelper >
bool InDet::EmulatedDefects< T_ModuleHelper >::isDefect ( const T_ModuleHelper &  helper,
unsigned int  id_hash,
unsigned int  row_idx_aka_phi,
unsigned int  col_idx_aka_eta 
) const
inline

Test whether a pixel on a certain module is marked as defect.

Parameters
helperutility matching this defect data to check whether a defect overlaps with pixel coordinates.
id_hasha valid ID hash
row_idx_aka_phithe offline row aka phi index of a pixel
col_idx_aka_etathe offline column aka eta index of a pixel
Returns
true if this data structure contains a defect for this module which overlaps with the given pixel coordinates Will throw a range_error if the ID hash is invalid.

Definition at line 100 of file EmulatedDefects.h.

100  {
101  return isDefect(helper, id_hash, helper.hardwareCoordinates(row_idx_aka_phi, col_idx_aka_eta) );
102  }

◆ isModuleDefect()

template<class T_ModuleHelper >
bool InDet::EmulatedDefects< T_ModuleHelper >::isModuleDefect ( unsigned int  id_hash) const
inline

Return true if the module defined by the given ID hash is defect.

Will throw a range_error if ID hash is invalid.

Definition at line 107 of file EmulatedDefects.h.

107  {
108  return m_moduleIsDefect.at(id_hash);
109  }

◆ lower_bound() [1/2]

template<class T_ModuleHelper >
static std::pair< typename std::vector<KEY_TYPE>::iterator, typename std::vector<KEY_TYPE>::iterator> InDet::EmulatedDefects< T_ModuleHelper >::lower_bound ( std::vector< KEY_TYPE > &  module_defects,
KEY_TYPE  key 
)
inlinestatic

Convenience method to find the preceding defect.

Parameters
module_defectsthe defect list of a particular module
keypacked hardware coordinates addressing a single pixel or column group defect.
Returns
pair of the iterator of the preceding element and the end iterator If there is no preceding defect then both returned iterators will be the end iterator

Definition at line 60 of file EmulatedDefects.h.

61  {
62  return std::make_pair( std::lower_bound( module_defects.begin(),module_defects.end(), key, greater()),
63  module_defects.end());
64  }

◆ lower_bound() [2/2]

template<class T_ModuleHelper >
std::pair< typename std::vector<KEY_TYPE>::const_iterator, typename std::vector<KEY_TYPE>::const_iterator> InDet::EmulatedDefects< T_ModuleHelper >::lower_bound ( unsigned int  id_hash,
KEY_TYPE  key 
) const
inline

Convenience method to find the preceding defect.

Parameters
id_hasha valid ID hash of a module.
keypacked hardware coordinates addressing a single pixel or column group defect.
Returns
pair of the iterator of the preceding element and the end iterator of the corresponding module If there is no preceding defect then both returned iterators will be the end iterator. Will throw a range_error if the ID hash is invalid.

Definition at line 74 of file EmulatedDefects.h.

74  {
75  const std::vector<KEY_TYPE> &module_defects = this->at(id_hash);
76  return std::make_pair( std::lower_bound( module_defects.begin(),module_defects.end(), key, greater()),
77  module_defects.end());
78  }

◆ resize()

template<class T_ModuleHelper >
void InDet::EmulatedDefects< T_ModuleHelper >::resize ( std::size_t  n_modules)
inlineprotected

Resize data structures for this number of modules.

Definition at line 131 of file EmulatedDefects.h.

131  {
132  std::vector<std::vector< typename T_ModuleHelper::KEY_TYPE> >::resize(n_modules);
133  m_moduleIsDefect.resize(n_modules,false);
134  }

◆ setModuleDefect()

template<class T_ModuleHelper >
void InDet::EmulatedDefects< T_ModuleHelper >::setModuleDefect ( unsigned int  id_hash)
inline

Mark the specified module as defect.

Definition at line 113 of file EmulatedDefects.h.

113  {
114  m_moduleIsDefect.at(id_hash)=true;
115  }

Member Data Documentation

◆ elements

T std::vector< T >::elements
inherited

STL member.

◆ m_detectorElements

template<class T_ModuleHelper >
const InDetDD::SiDetectorElementCollection* InDet::EmulatedDefects< T_ModuleHelper >::m_detectorElements
protected

Definition at line 136 of file EmulatedDefects.h.

◆ m_moduleIsDefect

template<class T_ModuleHelper >
std::vector<bool> InDet::EmulatedDefects< T_ModuleHelper >::m_moduleIsDefect
protected

Definition at line 135 of file EmulatedDefects.h.

◆ MASK_FOR_COMPARISON

template<class T_ModuleHelper >
constexpr unsigned int InDet::EmulatedDefects< T_ModuleHelper >::MASK_FOR_COMPARISON = T_ModuleHelper::CHIP_MASK | T_ModuleHelper::ROW_MASK | T_ModuleHelper::COL_MASK
staticconstexpr

Definition at line 27 of file EmulatedDefects.h.

◆ s_needMasking

template<class T_ModuleHelper >
constexpr bool InDet::EmulatedDefects< T_ModuleHelper >::s_needMasking = T_ModuleHelper::N_MASKS>0
staticconstexpr

Definition at line 28 of file EmulatedDefects.h.

The documentation for this class was generated from the following file:
CxxUtils::fpcompare::greater
bool greater(double a, double b)
Compare two FP numbers, working around x87 precision issues.
Definition: fpcompare.h:140
runBeamSpotCalibration.helper
helper
Definition: runBeamSpotCalibration.py:115
InDet::EmulatedDefects::resize
void resize(std::size_t n_modules)
Resize data structures for this number of modules.
Definition: EmulatedDefects.h:131
InDet::EmulatedDefects::lower_bound
static std::pair< typename std::vector< KEY_TYPE >::iterator, typename std::vector< KEY_TYPE >::iterator > lower_bound(std::vector< KEY_TYPE > &module_defects, KEY_TYPE key)
Convenience method to find the preceding defect.
Definition: EmulatedDefects.h:60
InDet::EmulatedDefects::m_detectorElements
const InDetDD::SiDetectorElementCollection * m_detectorElements
Definition: EmulatedDefects.h:136
InDet::EmulatedDefects::isDefect
bool isDefect(const T_ModuleHelper &helper, unsigned int id_hash, KEY_TYPE key) const
Test whether a pixel or strip on a certain module is marked as defect.
Definition: EmulatedDefects.h:87
DataVector::at
const T * at(size_type n) const
Access an element, as an rvalue.
DataVector::size
size_type size() const noexcept
Returns the number of elements in the collection.
InDet::EmulatedDefects::m_moduleIsDefect
std::vector< bool > m_moduleIsDefect
Definition: EmulatedDefects.h:135
mapkey::key
key
Definition: TElectronEfficiencyCorrectionTool.cxx:37
Generated on Sun Aug 31 2025 22:00:24 for ATLAS Offline Software by   doxygen 1.8.18