Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TrkrDefs.h File Reference

Namespace with Trkr key types and utility functions. More...

#include <cstdint>
#include <iostream>
+ Include dependency graph for TrkrDefs.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  TrkrDefs
 Define a namespace for Trkr typedefs.
 

Typedefs

typedef uint32_t TrkrDefs::hitkey
 Key types.
 
typedef uint32_t TrkrDefs::hitsetkey
 
typedef uint64_t TrkrDefs::cluskey
 
typedef uint32_t TrkrDefs::clushitkey
 
typedef uint16_t TrkrDefs::subsurfkey
 

Enumerations

enum  TrkrDefs::TrkrId {
  TrkrDefs::mvtxId = 0, TrkrDefs::inttId = 1, TrkrDefs::tpcId = 2, TrkrDefs::micromegasId = 3,
  TrkrDefs::ttl = 4
}
 Enumeration for tracker id to easily maintain consistency. More...
 

Functions

static double EdepScaleFactor TrkrDefs::__attribute__ ((unused)) = 5.0e8
 Max values for keys (used as defaults or invalid values)
 
void TrkrDefs::printBits (const TrkrDefs::hitsetkey key, std::ostream &os=std::cout)
 Print the bits for each key type.
 
void TrkrDefs::printBits (const TrkrDefs::cluskey key, std::ostream &os=std::cout)
 
uint8_t TrkrDefs::getTrkrId (const TrkrDefs::hitsetkey key)
 Get the tracker ID from either key type.
 
uint8_t TrkrDefs::getTrkrId (const TrkrDefs::cluskey key)
 
uint8_t TrkrDefs::getLayer (const TrkrDefs::hitsetkey key)
 Get the layer number from either key type.
 
uint8_t TrkrDefs::getLayer (const TrkrDefs::cluskey key)
 
uint32_t TrkrDefs::getClusIndex (const TrkrDefs::cluskey key)
 Get the lower 32 bits for cluster keys only.
 
TrkrDefs::hitsetkey TrkrDefs::genHitSetKey (const TrkrDefs::TrkrId trkrId, const uint8_t lyr)
 generate the common upper 16 bits for hitsetkey
 
TrkrDefs::cluskey TrkrDefs::genClusKey (const TrkrDefs::hitsetkey hskey, const uint32_t clusid)
 generate cluster key from hitset key and cluster index
 
uint32_t TrkrDefs::getHitSetKeyFromClusKey (const TrkrDefs::cluskey key)
 Get the upper 32 bits from cluster keys.
 
TrkrDefs::hitsetkey TrkrDefs::getHitSetKeyLo (const TrkrDefs::TrkrId trkrId)
 Get a valid low / hi range for hitsetkey given tracker id & layer.
 
TrkrDefs::hitsetkey TrkrDefs::getHitSetKeyHi (const TrkrDefs::TrkrId trkrId)
 
TrkrDefs::hitsetkey TrkrDefs::getHitSetKeyLo (const TrkrDefs::TrkrId trkrId, const uint8_t lyr)
 
TrkrDefs::hitsetkey TrkrDefs::getHitSetKeyHi (const TrkrDefs::TrkrId trkrId, const uint8_t lyr)
 
TrkrDefs::cluskey TrkrDefs::getClusKeyLo (const TrkrDefs::TrkrId trkrId)
 Get a valid low / hi range for cluskey given tracker id & layer.
 
TrkrDefs::cluskey TrkrDefs::getClusKeyHi (const TrkrDefs::TrkrId trkrId)
 
TrkrDefs::cluskey TrkrDefs::getClusKeyLo (const TrkrDefs::TrkrId trkrId, const uint8_t lyr)
 
TrkrDefs::cluskey TrkrDefs::getClusKeyHi (const TrkrDefs::TrkrId trkrId, const uint8_t lyr)
 
uint8_t TrkrDefs::getPhiElement (TrkrDefs::hitsetkey key)
 
uint8_t TrkrDefs::getZElement (TrkrDefs::hitsetkey key)
 
uint8_t TrkrDefs::getPhiElement (TrkrDefs::cluskey key)
 
uint8_t TrkrDefs::getZElement (TrkrDefs::cluskey key)
 

Detailed Description

Namespace with Trkr key types and utility functions.

Author
D. McGlinchey
Date
June 2018

Definition in file TrkrDefs.h.