Helper class to gather hit summary information for e.g. More...

#include <HitSummaryDataUtils.h>

Collaboration diagram for ActsTrk::detail::HitSummaryData:

Public Types
enum	DetectorRegion { pixelBarrelFlat = 0 , pixelBarrelInclined = 1 , pixelEndcap = 2 , stripBarrel = 3 , stripEndcap = 4 , unknown = 5 , pixelBarrel = 6 , pixelTotal = 7 , stripTotal = 8 , hgtdTotal = 9 , unknownTotal = 10 , Total = 11 }
	Regions for which hit counts are computed. More...
enum class	CountType { Hit , Outlier , SharedHit , SplitHit , NCountTypes }
enum	EHitSelection { HitFlag = 1 , OutlierFlag = 2 , HitAndOutlierFlag = 3 , SharedHitFlag = 4 , SplitHitFlag = 8 }

Public Member Functions
void	reset ()
	reset all summary counters to zero.
bool	addHit (xAOD::UncalibMeasType det_type, const InDetDD::SolidStateDetectorElementBase *detEl, EHitSelection hit_selection)
	update summaries to take the given hit into account.
void	computeSummaries ()
	Compute the varius summaries.
uint8_t	contributingLayers (DetectorRegion region) const
	return the number of layers contributing to the hit collection in the given detector region.
uint8_t	contributingHits (DetectorRegion region, CountType hit_type=CountType::Hit) const
	return the number of hits in a certain detector region.
uint8_t	contributingOutlierHits (DetectorRegion region) const
	return the number of outliers in a certain detector region.
uint8_t	contributingSharedHits (DetectorRegion region) const
	return the number of shared hits in a certain detector region.
template<unsigned short HIT_SELECTION>
uint8_t	sum (DetectorRegion region, uint8_t layer) const
	return the total number of hits, outliers, shared hits and/or split hits in the given detector region and layer.
std::array< uint8_t, 4 >	sumPerCountType (DetectorRegion region, uint8_t layer) const
	return the total number of hits, outliers, shared hits and split hits in the given detector region and layer.
unsigned int	layerPattern (DetectorRegion region, bool include_outlier) const
	Get a bit pattern with one bit set per layer which is set if the layer has a hit or optionally an outlier.

Static Public Member Functions
static constexpr unsigned short	makeKey (unsigned short region, unsigned short layer, int eta_mod)
	Compute a counter key for the given region, layer and module eta module index.
static constexpr unsigned short	makeKey (unsigned short region)
static constexpr DetectorRegion	regionFromKey (unsigned short key)
	extract the region index from the given key.
static constexpr uint8_t	layerFromKey (unsigned short key)
	extract the layer index from the given key.

Static Public Attributes
static constexpr unsigned short	LAYER_REGION_MASK = 0xFF
static constexpr unsigned short	REGION_BITS = 4
static constexpr unsigned short	REGION_MASK = 0xF
static constexpr unsigned short	LAYER_BITS = 4
static constexpr unsigned short	LAYER_MASK = 0xF
static constexpr unsigned short	SIGNED_ETA_MOD_BITS = 7
static constexpr unsigned short	SIGNED_ETA_MOD_MASK = 0x7F

Private Attributes
std::vector< std::tuple< unsigned short, uint8_t, uint8_t, uint8_t, uint8_t > >	m_stat
std::array< std::array< uint8_t, Total+1 >, static_cast< unsigned int >(CountType::NCountTypes)>	m_hits {}
std::array< uint8_t, Total+1 >	m_layers {}

Static Private Attributes
static constexpr std::array< uint8_t, unknown+1 >	s_type { pixelTotal, pixelTotal, pixelTotal, stripTotal, stripTotal, unknownTotal}

Detailed Description

Helper class to gather hit summary information for e.g.

tracks.

Definition at line 28 of file HitSummaryDataUtils.h.

Member Enumeration Documentation

◆ CountType

enum class ActsTrk::detail::HitSummaryData::CountType

strong

Enumerator
Hit
Outlier
SharedHit
SplitHit
NCountTypes

Definition at line 47 of file HitSummaryDataUtils.h.

                          {
         Hit,
         Outlier,
         SharedHit,
         SplitHit,
         NCountTypes
      };

◆ DetectorRegion

enum ActsTrk::detail::HitSummaryData::DetectorRegion

Regions for which hit counts are computed.

Enumerator
pixelBarrelFlat
pixelBarrelInclined
pixelEndcap
stripBarrel
stripEndcap
unknown
pixelBarrel
pixelTotal
stripTotal
hgtdTotal
unknownTotal
Total

Definition at line 32 of file HitSummaryDataUtils.h.

                          {
         pixelBarrelFlat     = 0,
         pixelBarrelInclined = 1,
         pixelEndcap         = 2,
         stripBarrel         = 3,
         stripEndcap         = 4,
         unknown             = 5,
         pixelBarrel         = 6,
         pixelTotal          = 7,
         stripTotal          = 8,
         hgtdTotal           = 9,
         unknownTotal        = 10,
         Total               = 11
      };

◆ EHitSelection

enum ActsTrk::detail::HitSummaryData::EHitSelection

Enumerator
HitFlag
OutlierFlag
HitAndOutlierFlag
SharedHitFlag
SplitHitFlag

Definition at line 99 of file HitSummaryDataUtils.h.

                         {
         HitFlag = 1,
         OutlierFlag = 2,
         HitAndOutlierFlag = 3,
         SharedHitFlag = 4,
         SplitHitFlag = 8
      };

Member Function Documentation

◆ addHit()

bool ActsTrk::detail::HitSummaryData::addHit	(	xAOD::UncalibMeasType	det_type,
		const InDetDD::SolidStateDetectorElementBase *	detEl,
		EHitSelection	hit_selection )

inline

update summaries to take the given hit into account.

Parameters

det_type.
detector_elements	detector element collection relevant for the given hit.
hit_selection	should be set to bit mask for Hit, Outlier, SharedHit.

Returns: returns false in case the hit was not considered. The hit is not considered if the given id_hash is not valid for the given detector element collectio.

Definition at line 124 of file HitSummaryDataUtils.h.

                                               {
         DetectorRegion region = unknown;
         uint8_t layer  = 255;
         int eta_module = 0;
         Identifier id(detEl ? detEl->identify() : Identifier() );
         switch (det_type) {
         case xAOD::UncalibMeasType::PixelClusterType: {
            if (!detEl) { return false; }
            assert(detEl ->getIdHelper()->is_pixel(id));
            InDetDD::DetectorType type = detEl->design().type();
            if(type==InDetDD::PixelInclined)  region = pixelBarrelInclined;
            else if(type==InDetDD::PixelBarrel) region = pixelBarrelFlat;
            else region = pixelEndcap;
 
            const PixelID* pixel_id = static_cast<const PixelID *>(detEl->getIdHelper());
            layer = pixel_id->layer_disk(detEl->identify());
            eta_module = pixel_id->eta_module(detEl->identify());
            break;
         }
         case xAOD::UncalibMeasType::StripClusterType: {
            if (!detEl) { return false; }
            assert(detEl ->getIdHelper()->is_sct(id));
            const SCT_ID* sct_id = static_cast<const SCT_ID *>(detEl->getIdHelper());
            region =  (sct_id->barrel_ec(id)==0 ?  stripBarrel : stripEndcap);
 
            layer = sct_id->layer_disk(detEl->identify());
            eta_module = sct_id->eta_module(detEl->identify());
            break;
         }
         case xAOD::UncalibMeasType::HGTDClusterType: {
            if (!detEl) { return false; }
            assert(detEl ->getIdHelper()->is_hgtd(id));
            const HGTD_ID* hgtd_id = static_cast<const HGTD_ID *>(detEl->getIdHelper());
            region=hgtdTotal;
            layer=hgtd_id->layer(id);
            break;
         }
         default: {
            return false;
         }
         }
 
         unsigned short key = makeKey(region, layer, eta_module);
         for (auto &[stat_key, stat_hits, stat_outlier_hits, stat_shared_hits, stat_split_hits] : m_stat) {
            if (stat_key == key) {
               stat_hits         += ((hit_selection & HitSummaryData::HitFlag)!=0);
               stat_outlier_hits += ((hit_selection & HitSummaryData::OutlierFlag)!=0);
               stat_shared_hits  += ((hit_selection & HitSummaryData::SharedHitFlag)!=0);
               stat_split_hits   += ((hit_selection & HitSummaryData::SplitHitFlag)!=0);
               return true;
            }
         }
         m_stat.emplace_back( std::make_tuple(key,
                                              ((hit_selection & HitSummaryData::HitFlag)!=0),
                                              ((hit_selection & HitSummaryData::OutlierFlag)!=0),
                                              ((hit_selection & HitSummaryData::SharedHitFlag)!=0),
                                              ((hit_selection & HitSummaryData::SplitHitFlag)!=0) ));
         return true;
      }

◆ computeSummaries()

void ActsTrk::detail::HitSummaryData::computeSummaries ( )

inline

Compute the varius summaries.

Must be called only after all hits have been gathered, and must not be called more than once.

Definition at line 189 of file HitSummaryDataUtils.h.

                              {
         for (const auto &[stat_key, stat_hits, stat_outlier_hits, stat_shared_hits, stat_split_hits] : m_stat) {
            unsigned short region=regionFromKey(stat_key);
            m_hits[static_cast<unsigned int>(CountType::Hit)].at(region) += stat_hits;
            m_hits[static_cast<unsigned int>(CountType::Outlier)].at(region) += stat_outlier_hits;
            m_hits[static_cast<unsigned int>(CountType::SharedHit)].at(region) += stat_shared_hits;
            m_hits[static_cast<unsigned int>(CountType::SplitHit)].at(region) += stat_split_hits;
            ++m_layers.at(region);
         }
         for (unsigned int region_i=0; region_i<unknown+1; ++region_i) {
            for (unsigned int count_type_i=0; count_type_i<static_cast<unsigned int>(CountType::NCountTypes);++count_type_i) {
               m_hits[count_type_i].at(s_type.at(region_i)) += m_hits[count_type_i][region_i];
               m_hits[count_type_i].at(Total) += m_hits[count_type_i][region_i];
            }
            m_layers.at(s_type.at(region_i)) += m_layers[region_i];
            m_layers.at(Total) += m_layers[region_i];
         }
         m_layers.at(pixelBarrel) += m_layers.at(pixelBarrelFlat) + m_layers.at(pixelBarrelInclined);
         for (unsigned int count_type_i=0; count_type_i<static_cast<unsigned int>(CountType::NCountTypes);++count_type_i) {
            assert( pixelBarrelFlat < m_hits[count_type_i].size() && pixelBarrelInclined < m_hits[count_type_i].size());
            m_hits[count_type_i].at(pixelBarrel) = m_hits[count_type_i][pixelBarrelFlat]+m_hits[count_type_i][pixelBarrelInclined];
         }
      }

◆ contributingHits()

uint8_t ActsTrk::detail::HitSummaryData::contributingHits	(	DetectorRegion	region,
		CountType	hit_type = CountType::Hit ) const

inline

return the number of hits in a certain detector region.

Parameters

region the detector region. Only meaningful after computeSummaries was called.

Definition at line 225 of file HitSummaryDataUtils.h.

                                                                                           {
         assert( static_cast<unsigned int>(hit_type) < static_cast<unsigned int>(CountType::NCountTypes));
         return m_hits[static_cast<unsigned int>(hit_type)].at(region);
      }

◆ contributingLayers()

uint8_t ActsTrk::detail::HitSummaryData::contributingLayers ( DetectorRegion region ) const

inline

return the number of layers contributing to the hit collection in the given detector region.

Parameters

region the detector region. Only meaningful after computeSummaries was called.

Definition at line 217 of file HitSummaryDataUtils.h.

                                                              {
         return m_layers.at(region);
      }

◆ contributingOutlierHits()

uint8_t ActsTrk::detail::HitSummaryData::contributingOutlierHits ( DetectorRegion region ) const

inline

return the number of outliers in a certain detector region.

Parameters

region the detector region. Only meaningful after computeSummaries was called.

Definition at line 234 of file HitSummaryDataUtils.h.

                                                                   {
         return contributingHits(region, CountType::Outlier);
      }

◆ contributingSharedHits()

uint8_t ActsTrk::detail::HitSummaryData::contributingSharedHits ( DetectorRegion region ) const

inline

return the number of shared hits in a certain detector region.

Parameters

region the detector region. Only meaningful after computeSummaries was called.

Definition at line 242 of file HitSummaryDataUtils.h.

                                                                  {
         return contributingHits(region, CountType::SharedHit);
      }

◆ layerFromKey()

constexpr uint8_t ActsTrk::detail::HitSummaryData::layerFromKey ( unsigned short key )

inlinestaticconstexpr

extract the layer index from the given key.

Definition at line 94 of file HitSummaryDataUtils.h.

                                                                {
         return (key>>REGION_BITS) & LAYER_MASK;                // bits 3-8
      }

◆ layerPattern()

unsigned int ActsTrk::detail::HitSummaryData::layerPattern	(	DetectorRegion	region,
		bool	include_outlier ) const

inline

Get a bit pattern with one bit set per layer which is set if the layer has a hit or optionally an outlier.

Parameters

region	selector
include_outlier	if true also set the corresponding bit if the layer contains an outlier only.

Returns: a bit pattern, where each bit corresponds to one detector and the bit is set if the layer contains a hit (or outlier).

Definition at line 296 of file HitSummaryDataUtils.h.

                                                                                   {
         unsigned int layer_pattern=0u;
         unsigned short key = makeKey(region);
         std::array<uint8_t,2> stat_mask{ 0xff, static_cast<uint8_t>(include_outlier ? 0xff : 0) };
         for (const auto &[stat_key, stat_hits, stat_outlier_hits, stat_shared_hits, stat_split_hits] : m_stat) {
            if ((stat_key & REGION_MASK) == key) {
               if ((stat_hits & stat_mask[0])+(stat_outlier_hits & stat_mask[1]) >0u) {
                  layer_pattern |= 1u<<layerFromKey(stat_key);
               }
            }
         }
         return layer_pattern;
      }

◆ makeKey() [1/2]

constexpr unsigned short ActsTrk::detail::HitSummaryData::makeKey ( unsigned short region )

inlinestaticconstexpr

Definition at line 81 of file HitSummaryDataUtils.h.

                                                                     {
         assert(region < (1<<REGION_BITS) );
         return static_cast<uint8_t>(region);
      }

◆ makeKey() [2/2]

constexpr unsigned short ActsTrk::detail::HitSummaryData::makeKey	(	unsigned short	region,
		unsigned short	layer,
		int	eta_mod )

inlinestaticconstexpr

Compute a counter key for the given region, layer and module eta module index.

Parameters

region	the detector region index (0..9).
layer	the layer index (0..15).
the	signed eta module index (-63..63).

Definition at line 68 of file HitSummaryDataUtils.h.

                                                                                                        {
         //   3 bits region  :    0-7   : pixelBarrelFlat - unknown
         //   6 bits layer   :    0-63
         // 1+6 bits eta_mod : +- 0-63
         // @TODO endcap side A/C ?
         assert(region < (1<<REGION_BITS) );
         assert(layer  < (1<<LAYER_BITS));
         assert( std::abs(eta_mod) < (1<<(SIGNED_ETA_MOD_BITS-1)) );
         if (region != stripBarrel &&  region != pixelBarrelFlat) {
            layer |= (static_cast<uint8_t>(eta_mod) & SIGNED_ETA_MOD_MASK) << LAYER_BITS ;
         }
         return static_cast<uint8_t>(region) | (layer<<REGION_BITS);
      }

◆ regionFromKey()

constexpr DetectorRegion ActsTrk::detail::HitSummaryData::regionFromKey ( unsigned short key )

inlinestaticconstexpr

extract the region index from the given key.

Definition at line 88 of file HitSummaryDataUtils.h.

                                                                        {
         return static_cast<DetectorRegion>(key & REGION_MASK); // bits 0-2
      }

◆ reset()

void ActsTrk::detail::HitSummaryData::reset ( )

inline

reset all summary counters to zero.

Definition at line 109 of file HitSummaryDataUtils.h.

                   {
         m_stat.clear();
         for(unsigned int i=0;i<static_cast<unsigned int>(CountType::NCountTypes); ++i) {
            std::fill(m_hits[i].begin(),m_hits[i].end(), 0u);
         }
         std::fill(m_layers.begin(),m_layers.end(), 0u);
      }

◆ sum()

template<unsigned short HIT_SELECTION>

uint8_t ActsTrk::detail::HitSummaryData::sum	(	DetectorRegion	region,
		uint8_t	layer ) const

inline

return the total number of hits, outliers, shared hits and/or split hits in the given detector region and layer.

Parameters

region	the detector region.
layer	the detector layer.

Definition at line 252 of file HitSummaryDataUtils.h.

                                                              {
         uint8_t total=0u;
         unsigned short key = makeKey(region, layer, 0);
         for (const auto &[stat_key, stat_hits, stat_outlier_hits, stat_shared_hits, stat_split_hits] : m_stat) {
            if ((stat_key & LAYER_REGION_MASK) == key) {
               if constexpr(HIT_SELECTION & HitSummaryData::HitFlag) {
                  total +=  stat_hits;
               }
               if constexpr(HIT_SELECTION & HitSummaryData::OutlierFlag) {
                  total +=  stat_outlier_hits;
               }
               if constexpr(HIT_SELECTION & HitSummaryData::SharedHitFlag) {
                  total +=  stat_shared_hits;
               }
               if constexpr(HIT_SELECTION & HitSummaryData::SplitHitFlag) {
                  total +=  stat_split_hits;
               }
            }
         }
         return total;
      }

◆ sumPerCountType()

std::array< uint8_t, 4 > ActsTrk::detail::HitSummaryData::sumPerCountType	(	DetectorRegion	region,
		uint8_t	layer ) const

inline

return the total number of hits, outliers, shared hits and split hits in the given detector region and layer.

Parameters

region	the detector region.
layer	the detector layer.

Definition at line 277 of file HitSummaryDataUtils.h.

                                                                                      {
         std::array<uint8_t,4> total{};
         unsigned short key = makeKey(region, layer, 0);
         for (const auto &[stat_key, stat_hits, stat_outlier_hits, stat_shared_hits, stat_split_hits] : m_stat) {
            if ((stat_key & LAYER_REGION_MASK) == key) {
               total[static_cast<unsigned int>(CountType::Hit)]       +=  stat_hits;
               total[static_cast<unsigned int>(CountType::Outlier)]   +=  stat_outlier_hits;
               total[static_cast<unsigned int>(CountType::SharedHit)] +=  stat_shared_hits;
               total[static_cast<unsigned int>(CountType::SplitHit)]  +=  stat_split_hits;
            }
         }
         return total;
      }

Member Data Documentation

◆ LAYER_BITS

unsigned short ActsTrk::detail::HitSummaryData::LAYER_BITS = 4

staticconstexpr

Definition at line 58 of file HitSummaryDataUtils.h.

◆ LAYER_MASK

unsigned short ActsTrk::detail::HitSummaryData::LAYER_MASK = 0xF

staticconstexpr

Definition at line 59 of file HitSummaryDataUtils.h.

◆ LAYER_REGION_MASK

unsigned short ActsTrk::detail::HitSummaryData::LAYER_REGION_MASK = 0xFF

staticconstexpr

Definition at line 55 of file HitSummaryDataUtils.h.

◆ m_hits

std::array<std::array<uint8_t, Total+1>,static_cast<unsigned int>(CountType::NCountTypes)> ActsTrk::detail::HitSummaryData::m_hits {}

private

Definition at line 312 of file HitSummaryDataUtils.h.

312{};

◆ m_layers

std::array<uint8_t, Total+1> ActsTrk::detail::HitSummaryData::m_layers {}

private

Definition at line 313 of file HitSummaryDataUtils.h.

313{};

◆ m_stat

std::vector< std::tuple<unsigned short, uint8_t, uint8_t, uint8_t, uint8_t> > ActsTrk::detail::HitSummaryData::m_stat

private

Definition at line 311 of file HitSummaryDataUtils.h.

◆ REGION_BITS

unsigned short ActsTrk::detail::HitSummaryData::REGION_BITS = 4

staticconstexpr

Definition at line 56 of file HitSummaryDataUtils.h.

◆ REGION_MASK

unsigned short ActsTrk::detail::HitSummaryData::REGION_MASK = 0xF

staticconstexpr

Definition at line 57 of file HitSummaryDataUtils.h.

◆ s_type

std::array<uint8_t, unknown+1> ActsTrk::detail::HitSummaryData::s_type { pixelTotal, pixelTotal, pixelTotal, stripTotal, stripTotal, unknownTotal}

staticconstexprprivate

Definition at line 314 of file HitSummaryDataUtils.h.

315{ pixelTotal, pixelTotal, pixelTotal, stripTotal, stripTotal, unknownTotal};

◆ SIGNED_ETA_MOD_BITS

unsigned short ActsTrk::detail::HitSummaryData::SIGNED_ETA_MOD_BITS = 7

staticconstexpr

Definition at line 60 of file HitSummaryDataUtils.h.

◆ SIGNED_ETA_MOD_MASK

unsigned short ActsTrk::detail::HitSummaryData::SIGNED_ETA_MOD_MASK = 0x7F

staticconstexpr

Definition at line 61 of file HitSummaryDataUtils.h.

The documentation for this class was generated from the following file:

HitSummaryDataUtils.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CountType

◆ DetectorRegion

◆ EHitSelection

Member Function Documentation

◆ addHit()

◆ computeSummaries()

◆ contributingHits()

◆ contributingLayers()

◆ contributingOutlierHits()

◆ contributingSharedHits()

◆ layerFromKey()

◆ layerPattern()

◆ makeKey() [1/2]

◆ makeKey() [2/2]

◆ regionFromKey()

◆ reset()

◆ sum()

◆ sumPerCountType()

Member Data Documentation

◆ LAYER_BITS

◆ LAYER_MASK

◆ LAYER_REGION_MASK

◆ m_hits

◆ m_layers

◆ m_stat

◆ REGION_BITS

◆ REGION_MASK

◆ s_type

◆ SIGNED_ETA_MOD_BITS

◆ SIGNED_ETA_MOD_MASK