Hit pattern of the VXD within a track. More...

#include <HitPatternVXD.h>

Public Types
enum class	PXDMode : unsigned short { normal = static_cast<unsigned short>(0) , gated = 1 }
	PXD modes. More...

Public Member Functions
	HitPatternVXD ()
	Create empty pattern.

	HitPatternVXD (const unsigned int initValue)
	Initialize the pattern with an integer.

unsigned int	getInteger () const
	Getter for the underlying integer.

unsigned short	getNdf () const
	Get degrees of freedom in PXD and SVD.

unsigned short	getNVXDLayers (const PXDMode &pxdmode=PXDMode::normal) const
	Return the total number of activated layers in the VXD depending on the mode of the PXD.

void	setSVDLayer (const unsigned short layerId, unsigned short uHits, unsigned short vHits)
	Set the number of hits in a specific layer of the SVD.

std::pair< const unsigned short, const unsigned short >	getSVDLayer (const unsigned short layerId) const
	Get the number of hits in a specific layer of the SVD.

void	resetSVDLayer (const unsigned short layerId)
	Reset the number of hits in a specific layer of the SVD.

unsigned short	getNSVDHits () const
	Get total number of hits in the SVD.

unsigned short	getNSVDLayers () const
	Returns the total number of activated layers of the SVD.

short	getFirstSVDLayer () const
	Get the first activated SVD layer index.

short	getLastSVDLayer () const
	Get the last activated SVD layer index.

void	setPXDLayer (const unsigned short layerId, unsigned short nHits, const PXDMode &mode=PXDMode::normal)
	Set the number of hits in a specific layer of the PXD.

unsigned short	getPXDLayer (const unsigned short layerId, const PXDMode &mode=PXDMode::normal) const
	Get the number of hits in a specific layer of the PXD.

void	resetPXDLayer (const unsigned short layerId, const PXDMode &mode=PXDMode::normal)
	Reset the number of hits in a specific layer of the PXD.

unsigned short	getNPXDHits () const
	Get total number of hits in the PXD.

unsigned short	getNPXDLayers (const PXDMode &mode=PXDMode::normal) const
	Returns the total number of activated layers of the PXD.

short	getFirstPXDLayer (const PXDMode &mode=PXDMode::normal) const
	Returns the first activated layer of the PXD depending on the mode.

short	getLastPXDLayer (const PXDMode &mode=PXDMode::normal) const
	Returns the last activated layer of the PXD depending on the mode.

void	setInnermostHitShareStatus (const unsigned short innermostHitShareStatus)
	Set the innermost hit share flags for V0 daughters.

unsigned short	getInnermostHitShareStatus () const
	Get the innermost hit share flags for V0 daughters.

void	resetInnermostHitShareStatus ()
	Reset the innermost hit share flags for V0 daughters.

std::string	__str__ () const
	String for printing in python.

Private Member Functions
std::bitset< 32 >	getBitset () const
	Getter for underlying bitset.

std::bitset< 32 >	getLayerMask (const unsigned short layerId) const
	Getter for the proper layer masks.

Private Attributes
std::bitset< 32 >	m_pattern
	Storing of actual hit pattern.

Static Private Attributes
static const std::bitset< 32 >	s_LayerMasks [6]
	Masks to zero out all bits from other layers.

static const std::bitset< 32 >	s_PXDModeMasks [2]
	Mask to zero out all bits from other layers.

static const std::bitset< 32 >	s_SVDuvMasks [2]
	Mask to zero out all bits from other layers.

static const std::bitset< 32 >	s_V0DaughterMask
	Mask to zero out all bits from other layers.

static const std::bitset< 32 >	s_infoLayerMask
	Mask to zero out all bits from other layers.

static const std::list< unsigned short >	s_PXDLayerNumbers = {1, 2}
	For iterating through layers.

static const std::list< unsigned short >	s_SVDLayerNumbers = {3, 4, 5, 6}
	For iterating through layers.

static const unsigned int	s_svdUshift = 8
	for internal shifting to the SVD bits.

static const unsigned int	s_svdVshift = 10
	for internal shifting to the SVD bits.

Friends
class	HitPatternVXDTest_General_Test

class	HitPatternVXDTest_NumberingScheme_Test

class	HitPatternVXDTest_SVDSetterAndGetter_Test

class	HitPatternVXDTest_PXDSetterAndGetter_Test

Detailed Description

Hit pattern of the VXD within a track.

The pattern is stored using a std::bitset. This allows to use the STL, which is very efficiently programmed.

Only hits from the outgoing arm are stored. For each layer there are two bits. The layer counting is:

PXD: layers 1 and 2;
SVD: layers 3, 4, 5 and 6.

The numbering scheme in this class is equivalent to the one defined in the note BELLE2-NOTE-TE-2015-010: https://docs.belle2.org/record/243

See also: HitPatternCDC

32 Bits are reserved. 4 Bits for each layer: 2 Bits for each PXD normal/gated-mode, 2 Bits for each SVD U/V-side. In total 24 Bits are used to represent hit patterns. Remaining upper 8 Bits are resevered for information. Lowest 2 Bits for V0 daughters (innermost hit share status), assigned in V0Finder. 0x1(0x2) bit represents V/z(U/r-phi)-hit share.

Definition at line 37 of file HitPatternVXD.h.

Member Enumeration Documentation

◆ PXDMode

enum class PXDMode : unsigned short

strong

PXD modes.

Definition at line 46 of file HitPatternVXD.h.

46: unsigned short { normal = static_cast<unsigned short>(0), gated = 1 };

Constructor & Destructor Documentation

◆ HitPatternVXD() [1/2]

HitPatternVXD ( )

inline

Create empty pattern.

Definition at line 49 of file HitPatternVXD.h.

49: m_pattern(0) {}

Belle2::HitPatternVXD::m_pattern

std::bitset< 32 > m_pattern

Storing of actual hit pattern.

Definition: HitPatternVXD.h:218

◆ HitPatternVXD() [2/2]

HitPatternVXD ( const unsigned int initValue )

inlineexplicit

Initialize the pattern with an integer.

Definition at line 52 of file HitPatternVXD.h.

52: m_pattern(initValue) {}

Member Function Documentation

◆ str()

std::string __str__ ( ) const

String for printing in python.

Definition at line 205 of file HitPatternVXD.cc.

{
  return m_pattern.to_string();
}

◆ getBitset()

std::bitset< 32 > getBitset ( ) const

inlineprivate

Getter for underlying bitset.

Definition at line 233 of file HitPatternVXD.h.

233{ return m_pattern; }

◆ getFirstPXDLayer()

short getFirstPXDLayer ( const PXDMode & mode = PXDMode::normal ) const

Returns the first activated layer of the PXD depending on the mode.

If there is no hit in the PXD pattern, -1 is returned.

Parameters

mode	normal or gated

See also: HitPatternVXD::PXDMode

Returns: Index of first layer.

Definition at line 166 of file HitPatternVXD.cc.

{
  for (const auto layerId : s_PXDLayerNumbers) {
    if (getPXDLayer(layerId, mode) > 0) return layerId;
  }
  return -1;
}

◆ getFirstSVDLayer()

short getFirstSVDLayer ( ) const

Get the first activated SVD layer index.

If there is no hit in the SVD pattern, -1 is returned.

Returns: Index of first layer.

Definition at line 103 of file HitPatternVXD.cc.

{
  for (const auto layerId : s_SVDLayerNumbers) {
    std::pair<const unsigned short, const unsigned short> hits(getSVDLayer(layerId));
    if ((hits.first + hits.second) > 0) return layerId;
  }
  return -1;
}

◆ getInnermostHitShareStatus()

unsigned short getInnermostHitShareStatus ( ) const

Get the innermost hit share flags for V0 daughters.

Returns: Innermost hit share status flags.

Definition at line 194 of file HitPatternVXD.cc.

{
  std::bitset<32> hits(m_pattern & s_V0DaughterMask);
  return (hits >> (4 * 6)).to_ulong();
}

◆ getInteger()

unsigned int getInteger ( ) const

inline

Getter for the underlying integer.

Returns: Hit pattern encoded as integer.

Definition at line 58 of file HitPatternVXD.h.

58{ return m_pattern.to_ulong(); }

◆ getLastPXDLayer()

short getLastPXDLayer ( const PXDMode & mode = PXDMode::normal ) const

Returns the last activated layer of the PXD depending on the mode.

If there is no hit in the PXD pattern, -1 is returned.

Parameters

mode	normal or gated

See also: HitPatternVXD::PXDMode

Returns: Index of last layer.

Definition at line 174 of file HitPatternVXD.cc.

{
  for (auto rit = s_PXDLayerNumbers.rbegin(); rit != s_PXDLayerNumbers.rend(); ++rit) {
    const auto layerId = *rit;
    if (getPXDLayer(layerId, mode) > 0) return layerId;
  }
  return -1;
}

◆ getLastSVDLayer()

short getLastSVDLayer ( ) const

Get the last activated SVD layer index.

If there is no hit in the SVD pattern, -1 is returned.

Returns: Index of last layer.

Definition at line 112 of file HitPatternVXD.cc.

{
  for (auto rit = s_SVDLayerNumbers.rbegin(); rit != s_SVDLayerNumbers.rend(); ++rit) {
    const auto layerId = *rit;
    std::pair<const unsigned short, const unsigned short> hits(getSVDLayer(layerId));
    if ((hits.first + hits.second) > 0) return layerId;
  }
  return -1;
}

◆ getLayerMask()

std::bitset< 32 > getLayerMask ( const unsigned short layerId ) const

inlineprivate

Getter for the proper layer masks.

Makes index handling more easy.

Definition at line 236 of file HitPatternVXD.h.

236{ return HitPatternVXD::s_LayerMasks[layerId - 1]; }

Belle2::HitPatternVXD::s_LayerMasks

static const std::bitset< 32 > s_LayerMasks[6]

Masks to zero out all bits from other layers.

Definition: HitPatternVXD.h:220

◆ getNdf()

unsigned short getNdf ( ) const

Get degrees of freedom in PXD and SVD.

Nota Bene: Only for the outgoing arm.

Returns: Degrees of freedom.

Definition at line 41 of file HitPatternVXD.cc.

{
  return 2 * getNPXDHits() + getNSVDHits();
}

◆ getNPXDHits()

unsigned short getNPXDHits ( ) const

Get total number of hits in the PXD.

Returns: Total number of hits in the PXD.

Definition at line 147 of file HitPatternVXD.cc.

{
  unsigned short pxdHits = 0;
  for (const auto layerId : s_PXDLayerNumbers) {
    pxdHits += getPXDLayer(layerId, PXDMode::normal);
    pxdHits += getPXDLayer(layerId, PXDMode::gated);
  }
  return pxdHits;
}

◆ getNPXDLayers()

unsigned short getNPXDLayers ( const PXDMode & mode = PXDMode::normal ) const

Returns the total number of activated layers of the PXD.

Parameters

mode	normal or gated

See also: HitPatternVXD::PXDMode

Returns: Total number of activated PXD layers.

Definition at line 157 of file HitPatternVXD.cc.

{
  unsigned short nPXD = 0;
  for (const auto layerId : s_PXDLayerNumbers) {
    if (getPXDLayer(layerId, mode) > 0) ++nPXD;
  }
  return nPXD;
}

◆ getNSVDHits()

unsigned short getNSVDHits ( ) const

Get total number of hits in the SVD.

Returns: Total number of hits in the SVD.

Definition at line 83 of file HitPatternVXD.cc.

{
  unsigned short svdHits = 0;
  for (const auto layerId : s_SVDLayerNumbers) {
    std::pair<const unsigned short, const unsigned short> svdHitPair = getSVDLayer(layerId);
    svdHits += svdHitPair.first + svdHitPair.second;
  }
  return svdHits;
}

◆ getNSVDLayers()

unsigned short getNSVDLayers ( ) const

Returns the total number of activated layers of the SVD.

Returns: Number of activated SVD layers.

Definition at line 93 of file HitPatternVXD.cc.

{
  unsigned short nSVD = 0;
  for (const auto layerId : s_SVDLayerNumbers) {
    std::pair<const unsigned short, const unsigned short> hits(getSVDLayer(layerId));
    if ((hits.first + hits.second) > 0) ++nSVD;
  }
  return nSVD;
}

◆ getNVXDLayers()

unsigned short getNVXDLayers ( const PXDMode & pxdmode = PXDMode::normal ) const

Return the total number of activated layers in the VXD depending on the mode of the PXD.

Parameters

pxdmode normal or gated

See also: HitPatternVXD::PXDMode

Returns: Number of activated layers.

Definition at line 46 of file HitPatternVXD.cc.

{
  return getNPXDLayers(pxdmode) + getNSVDLayers();
}

◆ getPXDLayer()

unsigned short getPXDLayer	(	const unsigned short	layerId,
		const PXDMode &	mode = `PXDMode::normal`
	)		const

Get the number of hits in a specific layer of the PXD.

Parameters

layerId	PXD layer index.
mode	normal or gated

See also: HitPatternVXD::PXDMode

Returns: Number of hits in the PXD layer.

Definition at line 133 of file HitPatternVXD.cc.

{
  B2ASSERT("PXD layer is out of range.", layerId == 1 or layerId == 2);
  const unsigned short arrayId = layerId - 1;
  std::bitset<32> hits(m_pattern & (getLayerMask(layerId) & s_PXDModeMasks[static_cast<unsigned short>(mode)]));
  return (hits >> (4 * arrayId + 2 * static_cast<unsigned short>(mode))).to_ulong();
}

◆ getSVDLayer()

std::pair< const unsigned short, const unsigned short > getSVDLayer ( const unsigned short layerId ) const

Get the number of hits in a specific layer of the SVD.

Parameters

layerId SVD layer index.

Returns: Pair of (u, v) hits in the SVD layer.

Definition at line 65 of file HitPatternVXD.cc.

{
  B2ASSERT("SVD layer is out of range.", 3 <= layerId and layerId <= 6);
  std::bitset<32> uHitsPattern(m_pattern & (getLayerMask(layerId) & s_SVDuvMasks[0]));
  std::bitset<32> vHitsPattern(m_pattern & (getLayerMask(layerId) & s_SVDuvMasks[1]));
  const unsigned short arrayId = layerId - 3;
  const unsigned short uHits = (uHitsPattern >> (s_svdUshift + 4 * arrayId)).to_ulong();
  const unsigned short vHits = (vHitsPattern >> (s_svdVshift + 4 * arrayId)).to_ulong();
  return std::make_pair(uHits, vHits);
}

◆ resetInnermostHitShareStatus()

void resetInnermostHitShareStatus ( )

Reset the innermost hit share flags for V0 daughters.

Definition at line 200 of file HitPatternVXD.cc.

{
  m_pattern &= ~(s_V0DaughterMask);
}

◆ resetPXDLayer()

void resetPXDLayer	(	const unsigned short	layerId,
		const PXDMode &	mode = `PXDMode::normal`
	)

Reset the number of hits in a specific layer of the PXD.

Parameters

layerId	PXD layer index.
mode	normal or gated

See also: HitPatternVXD::PXDMode

Definition at line 141 of file HitPatternVXD.cc.

{
  B2ASSERT("PXD layer is out of range.", layerId == 1 or layerId == 2);
  m_pattern &= ~(getLayerMask(layerId) & s_PXDModeMasks[static_cast<unsigned short>(mode)]);
}

◆ resetSVDLayer()

void resetSVDLayer ( const unsigned short layerId )

Reset the number of hits in a specific layer of the SVD.

Parameters

layerId SVD layer index.

Definition at line 76 of file HitPatternVXD.cc.

{
  B2ASSERT("SVD layer is out of range.", 3 <= layerId and layerId <= 6);
  m_pattern &= ~getLayerMask(layerId);
  return;
}

◆ setInnermostHitShareStatus()

void setInnermostHitShareStatus ( const unsigned short innermostHitShareStatus )

Set the innermost hit share flags for V0 daughters.

Parameters

innermostHitShareStatus Innermost hit share status flags.

Definition at line 183 of file HitPatternVXD.cc.

{
  B2ASSERT("Information is out of range. Information: " << innermostHitShareStatus << ", range: " << (s_V0DaughterMask >>
           (4 * 6)).to_ulong(),
           innermostHitShareStatus <= (s_V0DaughterMask >> (4 * 6)).to_ulong());
  resetInnermostHitShareStatus();
  std::bitset<32> hits(innermostHitShareStatus);
  hits <<= 4 * 6;
  m_pattern |= hits;
}

◆ setPXDLayer()

void setPXDLayer	(	const unsigned short	layerId,
		unsigned short	nHits,
		const PXDMode &	mode = `PXDMode::normal`
	)

Set the number of hits in a specific layer of the PXD.

Parameters

layerId	PXD layer index.
nHits	0-3 hits possible
mode	normal or gated

See also: HitPatternVXD::PXDMode

Definition at line 122 of file HitPatternVXD.cc.

{
  B2ASSERT("PXD layer is out of range.", layerId == 1 or layerId == 2);
  resetPXDLayer(layerId, mode);
  if (nHits > 3) nHits = 3;  // A Maximum of 3 can be stored in 2 bits.
  std::bitset<32> hits(nHits);
  const unsigned short arrayId = layerId - 1;
  hits <<= 4 * arrayId + 2 * static_cast<unsigned short>(mode);
  m_pattern |= hits;
}

◆ setSVDLayer()

void setSVDLayer	(	const unsigned short	layerId,
		unsigned short	uHits,
		unsigned short	vHits
	)

Set the number of hits in a specific layer of the SVD.

Parameters

layerId	SVD layer index.
uHits
vHits

Definition at line 51 of file HitPatternVXD.cc.

{
  B2ASSERT("SVD layer is out of range.", 3 <= layerId and layerId <= 6);
  resetSVDLayer(layerId);
  if (uHits > 3) uHits = 3;
  if (vHits > 3) vHits = 3;
  const unsigned short arrayId = layerId - 3;
  std::bitset<32> uHitPattern(uHits);
  uHitPattern <<= s_svdUshift + 4 * arrayId;
  std::bitset<32> vHitPattern(vHits);
  vHitPattern <<= s_svdVshift + 4 * arrayId;
  m_pattern |= (uHitPattern | vHitPattern);
}

Friends And Related Function Documentation

◆ HitPatternVXDTest_General_Test

friend class HitPatternVXDTest_General_Test

friend

Definition at line 38 of file HitPatternVXD.h.

◆ HitPatternVXDTest_NumberingScheme_Test

friend class HitPatternVXDTest_NumberingScheme_Test

friend

Definition at line 39 of file HitPatternVXD.h.

◆ HitPatternVXDTest_PXDSetterAndGetter_Test

friend class HitPatternVXDTest_PXDSetterAndGetter_Test

friend

Definition at line 41 of file HitPatternVXD.h.

◆ HitPatternVXDTest_SVDSetterAndGetter_Test

friend class HitPatternVXDTest_SVDSetterAndGetter_Test

friend

Definition at line 40 of file HitPatternVXD.h.

Member Data Documentation

◆ m_pattern

std::bitset<32> m_pattern

private

Storing of actual hit pattern.

PXD and SVD layer get 4 bits each. PXD has in each layer 4 bits where respectively two bits are used to store normal and gated mode hits separately. SVD has in each layer 4 bits where respectively two bits are used to store hits in u and v layer separately.

Definition at line 218 of file HitPatternVXD.h.

◆ s_infoLayerMask

const std::bitset< 32 > s_infoLayerMask

staticprivate

Mask to zero out all bits from other layers.

Definition at line 224 of file HitPatternVXD.h.

◆ s_LayerMasks

const std::bitset< 32 > s_LayerMasks

staticprivate

Initial value:

= {
  std::bitset<32>(static_cast<std::string>("00000000000000000000000000001111")),  
  std::bitset<32>(static_cast<std::string>("00000000000000000000000011110000")),  
  std::bitset<32>(static_cast<std::string>("00000000000000000000111100000000")),  
  std::bitset<32>(static_cast<std::string>("00000000000000001111000000000000")),  
  std::bitset<32>(static_cast<std::string>("00000000000011110000000000000000")),  
  std::bitset<32>(static_cast<std::string>("00000000111100000000000000000000"))   
}

Masks to zero out all bits from other layers.

Definition at line 220 of file HitPatternVXD.h.

◆ s_PXDLayerNumbers

const std::list< unsigned short > s_PXDLayerNumbers = {1, 2}

staticprivate

For iterating through layers.

Definition at line 226 of file HitPatternVXD.h.

◆ s_PXDModeMasks

const std::bitset< 32 > s_PXDModeMasks

staticprivate

Initial value:

= {
  std::bitset<32>(static_cast<std::string>("00000000000000000000000000110011")),  
  std::bitset<32>(static_cast<std::string>("00000000000000000000000011001100"))   
}

Mask to zero out all bits from other layers.

Definition at line 221 of file HitPatternVXD.h.

◆ s_SVDLayerNumbers

const std::list< unsigned short > s_SVDLayerNumbers = {3, 4, 5, 6}

staticprivate

For iterating through layers.

Definition at line 227 of file HitPatternVXD.h.

◆ s_svdUshift

const unsigned int s_svdUshift = 8

staticprivate

for internal shifting to the SVD bits.

Definition at line 229 of file HitPatternVXD.h.

◆ s_SVDuvMasks

const std::bitset< 32 > s_SVDuvMasks

staticprivate

Initial value:

= {
  std::bitset<32>(static_cast<std::string>("00000000001100110011001100000000")),  
  std::bitset<32>(static_cast<std::string>("00000000110011001100110000000000"))   
}

Mask to zero out all bits from other layers.

Definition at line 222 of file HitPatternVXD.h.

◆ s_svdVshift

const unsigned int s_svdVshift = 10

staticprivate

for internal shifting to the SVD bits.

Definition at line 230 of file HitPatternVXD.h.

◆ s_V0DaughterMask

const std::bitset< 32 > s_V0DaughterMask

staticprivate

Mask to zero out all bits from other layers.

Definition at line 223 of file HitPatternVXD.h.

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

mdst/dataobjects/include/HitPatternVXD.h
mdst/dataobjects/src/HitPatternVXD.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ PXDMode

Constructor & Destructor Documentation

◆ HitPatternVXD() [1/2]

◆ HitPatternVXD() [2/2]

Member Function Documentation

◆ __str__()

◆ getBitset()

◆ getFirstPXDLayer()

◆ getFirstSVDLayer()

◆ getInnermostHitShareStatus()

◆ getInteger()

◆ getLastPXDLayer()

◆ getLastSVDLayer()

◆ getLayerMask()

◆ getNdf()

◆ getNPXDHits()

◆ getNPXDLayers()

◆ getNSVDHits()

◆ getNSVDLayers()

◆ getNVXDLayers()

◆ getPXDLayer()

◆ getSVDLayer()

◆ resetInnermostHitShareStatus()

◆ resetPXDLayer()

◆ resetSVDLayer()

◆ setInnermostHitShareStatus()

◆ setPXDLayer()

◆ setSVDLayer()

Friends And Related Function Documentation

◆ HitPatternVXDTest_General_Test

◆ HitPatternVXDTest_NumberingScheme_Test

◆ HitPatternVXDTest_PXDSetterAndGetter_Test

◆ HitPatternVXDTest_SVDSetterAndGetter_Test

Member Data Documentation

◆ m_pattern

◆ s_infoLayerMask

◆ s_LayerMasks

◆ s_PXDLayerNumbers

◆ s_PXDModeMasks

◆ s_SVDLayerNumbers

◆ s_svdUshift

◆ s_SVDuvMasks

◆ s_svdVshift

◆ s_V0DaughterMask

◆ str()