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

#include <HitSummaryDataUtils.h>

Collaboration diagram for ActsTrk::HitSummaryData:

Public Types
enum	DetectorRegion { pixelBarrelFlat = 0, pixelBarrelInclined = 1, pixelEndcap = 2, stripBarrel = 3, stripEndcap = 4, unknown = 5, pixelTotal = 6, stripTotal = 7, unknownTotal = 8, Total = 9 }
	Regions for which hit counts are computed. More...

enum	EHitSelection { Hit = 1, Outlier = 2, HitAndOutlier = 3 }

Public Member Functions
void	reset ()
	reset all summary counters to zero. More...

bool	addHit (const InDetDD::SiDetectorElementCollection *detector_elements, unsigned int id_hash, EHitSelection hit_selection)
	update summaries to take the given hit into account. More...

void	computeSummaries ()
	Compute the varius summaries. More...

uint8_t	contributingLayers (DetectorRegion region) const
	return the number of layers contributing to the hit collection in the given detector region. More...

uint8_t	contributingHits (DetectorRegion region) const
	return the number of hits in a certain detector region. More...

uint8_t	contributingOutlierHits (DetectorRegion region) const
	return the number of outliers in a certain detector region. More...

template<unsigned short HIT_SELECTION>
uint8_t	sum (DetectorRegion region, uint8_t layer) const
	return the total number of hits, outliers or hits+outliers in the givrn detector region and layer. More...

Static Public Member Functions
constexpr static 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. More...

constexpr static DetectorRegion	regionFromKey (unsigned short key)
	extract the region index from the given key. More...

constexpr static uint8_t	layerFromKey (unsigned short key)
	extract the layer index from the given key. More...

Static Public Attributes
constexpr static unsigned short	LAYER_REGION_MASK = 0x1FF

constexpr static unsigned short	REGION_BITS = 3

constexpr static unsigned short	REGION_MASK = 0x7

constexpr static unsigned short	LAYER_BITS = 6

constexpr static unsigned short	LAYER_MASK = 0x3F

constexpr static unsigned short	SIGNED_ETA_MOD_BITS = 7

constexpr static unsigned short	SIGNED_ETA_MOD_MASK = 0x7F

Private Attributes
std::vector< std::tuple< unsigned short, uint8_t, uint8_t > >	m_stat

std::array< uint8_t, Total+1 >	m_hits

std::array< uint8_t, Total+1 >	m_outlierHits

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 38 of file HitSummaryDataUtils.h.

Member Enumeration Documentation

◆ DetectorRegion

enum ActsTrk::HitSummaryData::DetectorRegion

Regions for which hit counts are computed.

Enumerator
pixelBarrelFlat
pixelBarrelInclined
pixelEndcap
stripBarrel
stripEndcap
unknown
pixelTotal
stripTotal
unknownTotal
Total

Definition at line 42 of file HitSummaryDataUtils.h.

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

◆ EHitSelection

enum ActsTrk::HitSummaryData::EHitSelection

Enumerator
Hit
Outlier
HitAndOutlier

Definition at line 95 of file HitSummaryDataUtils.h.

                          {
          Hit = 1,
          Outlier = 2,
          HitAndOutlier = 3
       };

Member Function Documentation

◆ addHit()

bool ActsTrk::HitSummaryData::addHit	(	const InDetDD::SiDetectorElementCollection *	detector_elements,
		unsigned int	id_hash,
		EHitSelection	hit_selection
	)

inline

update summaries to take the given hit into account.

Parameters

detector_elements	detector element collection relevant for the given hit.
id_hash	the id_hash of the hit
hit_selection	should be set to either Hit, or Outlier.
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 117 of file HitSummaryDataUtils.h.

                                                                                                                                   {
          if (!detector_elements ||  id_hash>=detector_elements->size() || !(*detector_elements)[id_hash]) {
             return false;
          }
          const InDetDD::SiDetectorElement *detEl=(*detector_elements)[id_hash];
          DetectorRegion region = unknown;
          uint8_t layer  = 255;
          int eta_module = 0;
          if (detEl->isPixel()) {
             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());
          }
          else if (detEl->isSCT()) {
             region =  (detEl->isBarrel() ?  stripBarrel : stripEndcap);
  
             const SCT_ID* sct_id = static_cast<const SCT_ID *>(detEl->getIdHelper());
             layer = sct_id->layer_disk(detEl->identify());
             eta_module = sct_id->eta_module(detEl->identify());
          }
  
          unsigned short key = makeKey(region, layer, eta_module);
          for (auto &[stat_key, stat_hits, stat_outlier_hits] : m_stat) {
             if (stat_key == key) {
                stat_hits         += ((hit_selection & HitSummaryData::Hit)!=0);
                stat_outlier_hits += ((hit_selection & HitSummaryData::Outlier)!=0);
                return true;
             }
          }
          m_stat.emplace_back( std::make_tuple(key,
                                               ((hit_selection & HitSummaryData::Hit)!=0),
                                               ((hit_selection & HitSummaryData::Outlier)!=0)) );
          return true;
       }

◆ computeSummaries()

void ActsTrk::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 160 of file HitSummaryDataUtils.h.

                               {
          for (const auto &[stat_key, stat_hits, stat_outlier_hits] : m_stat) {
             unsigned short region=regionFromKey(stat_key);
             m_hits.at(region) += stat_hits;
             m_outlierHits.at(region) += stat_outlier_hits;
             ++m_layers.at(region);
          }
          for (unsigned int region_i=0; region_i<unknown+1; ++region_i) {
             m_hits.at(s_type.at(region_i)) += m_hits[region_i];
             m_outlierHits.at(s_type.at(region_i)) += m_outlierHits[region_i];
             m_layers.at(s_type.at(region_i)) += m_layers[region_i];
             m_hits.at(Total) += m_hits[region_i];
             m_outlierHits.at(Total) += m_outlierHits[region_i];
             m_layers.at(Total) += m_layers[region_i];
          }
       }

◆ contributingHits()

uint8_t ActsTrk::HitSummaryData::contributingHits ( DetectorRegion region ) 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 189 of file HitSummaryDataUtils.h.

                                                             {
          return m_hits.at(region);
       }

◆ contributingLayers()

uint8_t ActsTrk::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 181 of file HitSummaryDataUtils.h.

                                                               {
          return m_layers.at(region);
       }

◆ contributingOutlierHits()

uint8_t ActsTrk::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 197 of file HitSummaryDataUtils.h.

                                                                    {
          return m_outlierHits.at(region);
       }

◆ layerFromKey()

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

inlinestaticconstexpr

extract the layer index from the given key.

Definition at line 90 of file HitSummaryDataUtils.h.

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

◆ makeKey()

constexpr static unsigned short ActsTrk::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..7).
layer	the layer index (0..63).
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 static DetectorRegion ActsTrk::HitSummaryData::regionFromKey ( unsigned short key )

inlinestaticconstexpr

extract the region index from the given key.

Definition at line 84 of file HitSummaryDataUtils.h.

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

◆ reset()

void ActsTrk::HitSummaryData::reset ( )

inline

reset all summary counters to zero.

Definition at line 103 of file HitSummaryDataUtils.h.

                    {
          m_stat.clear();
          std::fill(m_hits.begin(),m_hits.end(), 0u);
          std::fill(m_outlierHits.begin(),m_outlierHits.end(), 0u);
          std::fill(m_layers.begin(),m_layers.end(), 0u);
       }

◆ sum()

template<unsigned short HIT_SELECTION>

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

inline

return the total number of hits, outliers or hits+outliers in the givrn detector region and layer.

Parameters

region	the detector region.
layer	the detector layer.

Definition at line 207 of file HitSummaryDataUtils.h.

                                                               {
          uint8_t total=0u;
          unsigned short key = makeKey(region, layer, 0);
          for (auto &[stat_key, stat_hits, stat_outlier_hits] : m_stat) {
             if ((stat_key & LAYER_REGION_MASK) == key) {
                if constexpr(HIT_SELECTION & HitSummaryData::Hit) {
                   total +=  stat_hits;
                }
                if constexpr(HIT_SELECTION & HitSummaryData::Outlier) {
                   total +=  stat_outlier_hits;
                }
             }
          }
          return total;
       }

Member Data Documentation

◆ LAYER_BITS

constexpr static unsigned short ActsTrk::HitSummaryData::LAYER_BITS = 6

staticconstexpr

Definition at line 58 of file HitSummaryDataUtils.h.

◆ LAYER_MASK

constexpr static unsigned short ActsTrk::HitSummaryData::LAYER_MASK = 0x3F

staticconstexpr

Definition at line 59 of file HitSummaryDataUtils.h.

◆ LAYER_REGION_MASK

constexpr static unsigned short ActsTrk::HitSummaryData::LAYER_REGION_MASK = 0x1FF

staticconstexpr

Definition at line 55 of file HitSummaryDataUtils.h.

◆ m_hits

std::array<uint8_t, Total+1> ActsTrk::HitSummaryData::m_hits

private

Definition at line 225 of file HitSummaryDataUtils.h.

◆ m_layers

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

private

Definition at line 227 of file HitSummaryDataUtils.h.

◆ m_outlierHits

std::array<uint8_t, Total+1> ActsTrk::HitSummaryData::m_outlierHits

private

Definition at line 226 of file HitSummaryDataUtils.h.

◆ m_stat

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

private

Definition at line 224 of file HitSummaryDataUtils.h.

◆ REGION_BITS

constexpr static unsigned short ActsTrk::HitSummaryData::REGION_BITS = 3

staticconstexpr

Definition at line 56 of file HitSummaryDataUtils.h.

◆ REGION_MASK

constexpr static unsigned short ActsTrk::HitSummaryData::REGION_MASK = 0x7

staticconstexpr

Definition at line 57 of file HitSummaryDataUtils.h.

◆ s_type

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

staticconstexprprivate

Definition at line 228 of file HitSummaryDataUtils.h.

◆ SIGNED_ETA_MOD_BITS

constexpr static unsigned short ActsTrk::HitSummaryData::SIGNED_ETA_MOD_BITS = 7

staticconstexpr

Definition at line 60 of file HitSummaryDataUtils.h.

◆ SIGNED_ETA_MOD_MASK

constexpr static unsigned short ActsTrk::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

◆ DetectorRegion

◆ EHitSelection

Member Function Documentation

◆ addHit()

◆ computeSummaries()

◆ contributingHits()

◆ contributingLayers()

◆ contributingOutlierHits()

◆ layerFromKey()

◆ makeKey()

◆ regionFromKey()

◆ reset()

◆ sum()

Member Data Documentation

◆ LAYER_BITS

◆ LAYER_MASK

◆ LAYER_REGION_MASK

◆ m_hits

◆ m_layers

◆ m_outlierHits

◆ m_stat

◆ REGION_BITS

◆ REGION_MASK

◆ s_type

◆ SIGNED_ETA_MOD_BITS

◆ SIGNED_ETA_MOD_MASK