SiHitIdHelper Class Reference

#include <SiHitIdHelper.h>

Inheritance diagram for SiHitIdHelper:

Collaboration diagram for SiHitIdHelper:

Public Member Functions
bool	isPixel (const int &hid) const
bool	isSCT (const int &hid) const
bool	isHGTD (const int &hid) const
bool	isPLR (const int &hid) const
int	getBarrelEndcap (const int &hid) const
int	getLayerDisk (const int &hid) const
int	getEtaModule (const int &hid) const
int	getPhiModule (const int &hid) const
int	getSide (const int &hid) const
int	buildHitId (const int, const int, const int, const int, const int, const int) const
int	buildHitIdFromStringITk (int part, const std::string &) const
int	buildHitIdFromStringHGTD (int part, const std::string &) const

Static Public Member Functions
static const SiHitIdHelper *	GetHelper ()

Private Member Functions
	SiHitIdHelper ()
void	Initialize ()
void	InitializeField (const std::string &n, int vmn, int vmx)
void	InitializeField (const std::string &n, int nb)
void	SetFieldValue (const std::string &name, int n, HitID &targetID) const
int	GetFieldValue (const std::string &name, HitID targetID) const
void	PrintFields ()

Static Private Member Functions
static void	Print (int id)
static void	SetBit (int &i, int bitpos)
static void	UnsetBit (int &i, int bitpos)
static void	Store (int &id, int value, int first, int field)
static int	Retrieve (int id, int first, int field)

Private Attributes
bool	m_isITkHGTD {}
IdFields	m_IDs
int	m_currentStorage

Detailed Description

Definition at line 25 of file SiHitIdHelper.h.

Constructor & Destructor Documentation

SiHitIdHelper()

SiHitIdHelper::SiHitIdHelper ( )

private

Definition at line 15 of file SiHitIdHelper.cxx.

                             :HitIdHelper() {
  Initialize();
}

Member Function Documentation

buildHitId()

int SiHitIdHelper::buildHitId	(	const int	Part,
		const int	BrlECap,
		const int	LayerDisk,
		const int	etaM,
		const int	phiM,
		const int	side
	)		const

Definition at line 118 of file SiHitIdHelper.cxx.

{
  int theID(0);
  this->SetFieldValue("Part",           Part, theID);
  this->SetFieldValue("BarrelEndcap",   BrlECap, theID);
  this->SetFieldValue("LayerDisk",      LayerDisk, theID);
  this->SetFieldValue("EtaModule",      etaM, theID);
  this->SetFieldValue("PhiModule",      phiM, theID);
  this->SetFieldValue("Side",           side, theID);
  return theID;
}

buildHitIdFromStringHGTD()

int SiHitIdHelper::buildHitIdFromStringHGTD	(	int	part,
		const std::string &	physVolName
	)		const

Definition at line 149 of file SiHitIdHelper.cxx.

{
    int endcap = 0;
    int layer = 0;
    int moduleInLayer = 0;
    //Extract the indices from the name, and write them in to the matching int
    std::map<std::string, int&> fields{{"endcap",endcap},{"layer",layer},{"moduleInLayer",moduleInLayer}};
    for(const auto & field:fields){
        size_t pos1 = (physVolName).find(field.first+"_");
        size_t pos2 = (physVolName).find("_",pos1+field.first.size()+1);//start looking only after end of first delimiter (plus 1 for the "_" appended) ends
        std::string strNew = (physVolName).substr(pos1+field.first.size()+1,pos2-(pos1+field.first.size()+1));
        field.second = std::stoi(strNew);
    }
    return buildHitId(part,endcap,layer,0,moduleInLayer,0);
}

buildHitIdFromStringITk()

int SiHitIdHelper::buildHitIdFromStringITk	(	int	part,
		const std::string &	physVolName
	)		const

Definition at line 131 of file SiHitIdHelper.cxx.

{
    int brlEcap = 0;
    int layerDisk = 0;
    int etaMod = 0;
    int phiMod = 0;
    int side = 0;
    //Extract the indices from the name, and write them in to the matching int
    std::map<std::string, int&> fields{{"barrel_endcap",brlEcap},{"layer_wheel",layerDisk},{"phi_module",phiMod},{"eta_module",etaMod},{"side",side}};
    for(const auto & field:fields){
        size_t pos1 = (physVolName).find(field.first+"_");
        size_t pos2 = (physVolName).find("_",pos1+field.first.size()+1);//start looking only after end of first delimiter (plus 1 for the "_" appended) ends
        std::string strNew = (physVolName).substr(pos1+field.first.size()+1,pos2-(pos1+field.first.size()+1));
        field.second = std::stoi(strNew);
    }
    return buildHitId(part,brlEcap,layerDisk,etaMod,phiMod,side);
}

getBarrelEndcap()

int SiHitIdHelper::getBarrelEndcap

(

const int &

hid

)

const

Definition at line 86 of file SiHitIdHelper.cxx.

{
  return this->GetFieldValue("BarrelEndcap", hid);
}

getEtaModule()

int SiHitIdHelper::getEtaModule

(

const int &

hid

)

const

Definition at line 98 of file SiHitIdHelper.cxx.

{
  return this->GetFieldValue("EtaModule", hid);
}

GetFieldValue()

int HitIdHelper::GetFieldValue ( const std::string &  name, HitID  targetID  ) const

inherited

Definition at line 47 of file HitIdHelper.cxx.

{
  for (unsigned int i=0;i<m_IDs.size();i++)
    {
      if (m_IDs[i].fieldName==name)
        {
          int n=Retrieve(targetID,m_IDs[i].firstBit,m_IDs[i].nBits);
          return n+m_IDs[i].vMin;
        }
    }
  std::cout<<"HitIdHelper: field "<<name<<" not found: returning 0"<<
    std::endl;
  return 0;
}

GetHelper()

const SiHitIdHelper * SiHitIdHelper::GetHelper ( )

static

Definition at line 19 of file SiHitIdHelper.cxx.

                                              {
  static const SiHitIdHelper helper;
  return &helper;
}

getLayerDisk()

int SiHitIdHelper::getLayerDisk

(

const int &

hid

)

const

Definition at line 92 of file SiHitIdHelper.cxx.

{
  return this->GetFieldValue("LayerDisk", hid);
}

getPhiModule()

int SiHitIdHelper::getPhiModule

(

const int &

hid

)

const

Definition at line 104 of file SiHitIdHelper.cxx.

{
  return this->GetFieldValue("PhiModule", hid);
}

getSide()

int SiHitIdHelper::getSide

(

const int &

hid

)

const

Definition at line 110 of file SiHitIdHelper.cxx.

{
  return this->GetFieldValue("Side", hid);
}

Initialize()

void SiHitIdHelper::Initialize ( )

private

Definition at line 24 of file SiHitIdHelper.cxx.

                               {
 
  const PixelID* pix = nullptr;
  ServiceHandle<StoreGateSvc> detStore ("DetectorStore", "SiHitIdHelper");
  if (detStore.retrieve().isSuccess()) {
    if (detStore->retrieve(pix, "PixelID").isFailure()) { pix = nullptr; }
  }
 
  bool isDBM  = (pix != nullptr && pix->dictionaryVersion() == "IBL-DBM");
  // check for ITk and HGTD
  bool isITkHGTD = (pix !=nullptr &&  pix->dictionaryVersion() == "ITkHGTD");
  // we might include PLR as well, then we have to increase endcap range to +/- 4
  bool isITkHGTDPLR = (pix !=nullptr &&  pix->dictionaryVersion() == "ITkHGTDPLR");
  // new identification scheme for HGTD (endcap-layer-moduleinlayer)
  bool isITk_HGTD_NewID_PLR = (pix !=nullptr &&  pix->dictionaryVersion() == "P2-RUN4");
  // cache the HL-LHC decision
  m_isITkHGTD = isITkHGTD || isITkHGTDPLR || isITk_HGTD_NewID_PLR;
 
  if (isITkHGTD) InitializeField("Part",0,2);
  else if (isITkHGTDPLR || isITk_HGTD_NewID_PLR) InitializeField("Part",0,3);
  else InitializeField("Part",0,1);
  if (isDBM || isITkHGTDPLR || isITk_HGTD_NewID_PLR) InitializeField("BarrelEndcap",-4,4);
  else InitializeField("BarrelEndcap",-2,2);
  InitializeField("LayerDisk",0,20);
  if (m_isITkHGTD) InitializeField("EtaModule",-100,100);
  else InitializeField("EtaModule",-20,20);
  if (isITk_HGTD_NewID_PLR) InitializeField("PhiModule",0,1022);
  else InitializeField("PhiModule",0,200);
  InitializeField("Side",0,3);
 
}

InitializeField() [1/2]

void HitIdHelper::InitializeField ( const std::string &  n, int  nb  )

inherited

Definition at line 20 of file HitIdHelper.cxx.

{
  int vmn=0;
  int vmx = (1 << nb) - 1;
  IdField id={n,vmn,vmx,nb,m_currentStorage+1};
  m_IDs.push_back(std::move(id));
  m_currentStorage+=nb;
  assert (m_currentStorage<33);
}

InitializeField() [2/2]

void HitIdHelper::InitializeField ( const std::string &  n, int  vmn, int  vmx  )

inherited

Definition at line 10 of file HitIdHelper.cxx.

{
  int field = vmx - vmn + 1;
  int nb = std::bit_width(static_cast<unsigned>(field - 1));
  IdField id={n,vmn,vmx,nb,m_currentStorage+1};
  m_IDs.push_back(std::move(id));
  m_currentStorage+=nb;
  assert (m_currentStorage<33);
}

isHGTD()

bool SiHitIdHelper::isHGTD

(

const int &

hid

)

const

Definition at line 70 of file SiHitIdHelper.cxx.

{
  int psh = this->GetFieldValue("Part", hid);
  return psh ==2;
}

isPixel()

bool SiHitIdHelper::isPixel

(

const int &

hid

)

const

Definition at line 58 of file SiHitIdHelper.cxx.

{
  int psh = this->GetFieldValue("Part", hid);
  return psh ==0;
}

isPLR()

bool SiHitIdHelper::isPLR

(

const int &

hid

)

const

Definition at line 76 of file SiHitIdHelper.cxx.

{
  if (!m_isITkHGTD) return false;
 
  int psh = this->GetFieldValue("BarrelEndcap", hid);
  return std::abs(psh) == 4;
}

isSCT()

bool SiHitIdHelper::isSCT

(

const int &

hid

)

const

Definition at line 64 of file SiHitIdHelper.cxx.

{
  int psh = this->GetFieldValue("Part", hid);
  return psh ==1;
}

Print()

void HitIdHelper::Print ( int  id )

staticinherited

Definition at line 72 of file HitIdHelper.cxx.

{
  for (unsigned int i=0;i<8*sizeof(int);i++)
    {
      if ((id & (1u<<i))) std::cout<<"1";
      else std::cout<<"0";
    }
  std::cout<<std::endl;
}

PrintFields()

void HitIdHelper::PrintFields ( )

inherited

Definition at line 62 of file HitIdHelper.cxx.

{
  for (unsigned int i=0;i<m_IDs.size();i++)
    {
      std::cout<<"-- Field "<<m_IDs[i].fieldName<<"\t["<<m_IDs[i].vMin
               <<","<<m_IDs[i].vMax<<"]\tnBits "<<m_IDs[i].nBits
               <<"\tfirst Bit "<<m_IDs[i].firstBit<<std::endl;
    }
}

Retrieve()

int HitIdHelper::Retrieve ( int  id, int  first, int  field  )

staticprotectedinherited

Definition at line 105 of file HitIdHelper.cxx.

{
  int j=0;
  for (int i=0;i<field;i++)
    SetBit(j,(i+first));
  int l=id&j;
  return l>>(first-1);
}

SetBit()

void HitIdHelper::SetBit ( int &  i, int  bitpos  )

staticprotectedinherited

Definition at line 82 of file HitIdHelper.cxx.

{
  int l=1;
  l<<=(bitpos-1);
  i|=l;
}

SetFieldValue()

void HitIdHelper::SetFieldValue ( const std::string &  name, int  n, HitID &  targetID  ) const

inherited

Definition at line 30 of file HitIdHelper.cxx.

{
  for (unsigned int i=0;i<m_IDs.size();i++)
    {
      if (m_IDs[i].fieldName==name)
        {
          if (n<m_IDs[i].vMin || n>m_IDs[i].vMax)
            std::cout<<"HitIdHelper: field "<<name<<": supplied value "<<n<<
              " is not within the allowed range ["<<m_IDs[i].vMin<<","<<m_IDs[i].vMax
                     <<"] : the result of this action is unpredictable "<<std::endl;
          n-=m_IDs[i].vMin;
          Store(targetID,n,m_IDs[i].firstBit,m_IDs[i].nBits);
          break;
        }
    }
}

Store()

void HitIdHelper::Store ( int &  id, int  value, int  first, int  field  )

staticprotectedinherited

Definition at line 96 of file HitIdHelper.cxx.

{
  int l=0;
  for (int i=0;i<field;i++)
    UnsetBit(id,i+firstbit);
  l=value<<(firstbit-1);
  id |= l;
}

UnsetBit()

void HitIdHelper::UnsetBit ( int &  i, int  bitpos  )

staticprotectedinherited

Definition at line 88 of file HitIdHelper.cxx.

{
  int l=0;
  SetBit(l,bitpos);
  int k=~l;
  i&=k;
}

Member Data Documentation

m_currentStorage

int HitIdHelper::m_currentStorage

protectedinherited

Definition at line 35 of file HitIdHelper.h.

m_IDs

IdFields HitIdHelper::m_IDs

protectedinherited

Definition at line 34 of file HitIdHelper.h.

m_isITkHGTD

bool SiHitIdHelper::m_isITkHGTD {}

private

Definition at line 69 of file SiHitIdHelper.h.

---

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

• SiHitIdHelper.h
• SiHitIdHelper.cxx