#include <ITkStripsRodDecoder.h>

Inheritance diagram for ITkStripsRodDecoder:

Collaboration diagram for ITkStripsRodDecoder:

Classes
struct	CacheHelper
	Temp object to help with trigger caching. More...
struct	SharedData
	Struct to hold data shared in methods used in fillCollection method. More...

Public Member Functions
virtual	~ITkStripsRodDecoder ()=default
	Destructor.
virtual StatusCode	initialize () override
	Initialize.
virtual StatusCode	fillCollection (const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment &robFrag, SCT_RDO_Container &rdoIDCont, IDCInDetBSErrContainer &errs, DataPool< SCT3_RawData > dataItemsPool, const EventContext &ctx, const std::vector< IdentifierHash > vecHash=nullptr) const override
	Fill SCT RDO Collection with decoded ROB data.

Private Types
enum	ITk_DecoderNumbers { N_SIDES = 2 , N_CHIPS_PER_SIDE = 6 , N_STRIPS_PER_CHIP = 128 , N_STRIPS_PER_SIDE = 9999 }
	Define frequently used magic numbers. More...

Private Member Functions
int	makeRDO (SharedData &data, CacheHelper &cache, DataPool< SCT3_RawData > *dataItemsPool) const
	Builds RawData RDO and adds to RDO container.
StatusCode	addRODError (uint32_t rodID, SCT_ByteStreamErrors::ErrorType error, SCT_RodDecoderErrorsHelper &errs, const std::unordered_set< IdentifierHash > *foundHashes=nullptr) const
	Add an error for each wafer in the problematic ROD.
StatusCode	addSingleError (const IdentifierHash &hashID, SCT_ByteStreamErrors::ErrorType error, SCT_RodDecoderErrorsHelper &errs) const
	Add single eror.
StatusCode	processHeader (const uint16_t inData, const uint32_t robID, SharedData &data, SCT_RDO_Container &rdoIDCont, DataPool< SCT3_RawData > *dataItemsPool, CacheHelper &cache, SCT_RodDecoderErrorsHelper &errs, bool &hasError, bool &breakNow, const EventContext &ctx) const
	Process header word.
StatusCode	processHccHeader (const uint16_t inData, const uint8_t data8, uint8_t &isHCCHeader, const uint32_t robID, SharedData &data, SCT_RDO_Container &rdoIDCont, DataPool< SCT3_RawData > *dataItemsPool, CacheHelper &cache, SCT_RodDecoderErrorsHelper &errs, bool &hasError, bool &breakNow, const EventContext &ctx) const
	Process header word.
StatusCode	processHits (const uint16_t inData, const uint32_t robID, SharedData &data, SCT_RDO_Container &rdoIDCont, DataPool< SCT3_RawData > *dataItemsPool, CacheHelper &cache, SCT_RodDecoderErrorsHelper &errs, bool &hasError, const EventContext &ctx) const
	Process raw data word.

Private Attributes
const SCT_ID *	m_itkStripsID {nullptr}
	Identifier helper class for the SCT subdetector that creates compact Identifier objects and IdentifierHash or hash IDs.
IdContext	m_contextITk
	"Context" of an expanded identifier (ExpandedIdentifier) for compact or hash versions (Identifier32 or IdentifierHash)
ToolHandle< IITkStripCablingTool >	m_cabling
	Providing mappings of online and offline identifiers and also serial numbers.
ToolHandle< ISCT_ConfigurationConditionsTool >	m_configTool
	Service that keeps track of configuration conditions.
std::atomic_uint	m_singleCondHitNumber {0}
	Total number of single strips with hit decoded in condensed mode.
std::atomic_uint	m_pairedCondHitNumber {0}
	Total number of paired strips with hit decoded in condensed mode.
std::atomic_uint	m_firstExpHitNumber {0}
	Total number of first strips with hit decoded in expanded mode.
std::atomic_uint	m_evenExpHitNumber {0}
	Total number of consecutive paired strips with hit decoded in expanded mode.
std::atomic_uint	m_lastExpHitNumber {0}
	Total number of last consecutive strips with hit decoded in expanded mode.
std::atomic_uint	m_headNumber {0}
	Total number of decoded header data.
std::atomic_uint	m_trailerNumber {0}
	Total number of decoded trailer data.
std::atomic_uint	m_headErrorBCID {0}
	Total number of BCID errors in the header data.
std::atomic_uint	m_headErrorLvl1ID {0}
	Total number of Lvl1ID errors in the header data.
std::atomic_uint	m_headErrorTimeout {0}
	Total number of timeout errors in the header data.
std::atomic_uint	m_headErrorFormatter {0}
	Total number of formatter errors in the header data.
std::atomic_uint	m_headErrorPreamble {0}
	Total number of preamble errors in the header data.
std::atomic_uint	m_trailerErrorOverflow {0}
	Total number of overflow errors in the trailer data.
std::atomic_uint	m_trailerErrorLimit {0}
	Total number of header trailer limit errors in the trailer data.
std::atomic_uint	m_trailerErrorBit {0}
	Total number of trailer bit errors.
std::atomic_uint	m_configDataBit {0}
	Total number of configuration data for raw data.
std::atomic_uint	m_flagErrorBit {0}
	Total number of flag error data.
std::atomic_uint	m_condHit1Error {0}
	Total number of first hit data errors.
std::atomic_uint	m_condHit2Error {0}
	Total number second hit data errors.
std::atomic_uint	m_chipNumberError {0}
	Total number of chip number errors.
std::atomic_uint	m_unknownDataFormat {0}
	Total number of unknown data formats.
std::atomic_uint	m_nHits {0}
	Total number of SCT hits in ByteStream.
std::atomic_uint	m_nRDOs {0}
	Total number of SCT RDOs created.
std::atomic_uint	m_maskedLinkNumber {0}
	Total number of masked links in the header data.
std::atomic_uint	m_maskedRODNumber {0}
	Total number of masked RDOs.
std::atomic_uint	m_rodClockErrorNumber {0}
	Total number of ROD clock errors.
std::atomic_uint	m_truncatedRODNumber {0}
	Total number of truncated ROBFragments.
std::atomic_uint	m_numMissingLinkHeader {0}
	Total number of missing link headers.
std::vector< bool >	m_swapPhiReadoutDirection {}
	Swap phi readout direction.

Detailed Description

Definition at line 73 of file ITkStripsRodDecoder.h.

Member Enumeration Documentation

◆ ITk_DecoderNumbers

enum ITkStripsRodDecoder::ITk_DecoderNumbers

private

Define frequently used magic numbers.

Enumerator
N_SIDES
N_CHIPS_PER_SIDE
N_STRIPS_PER_CHIP
N_STRIPS_PER_SIDE

Definition at line 115 of file ITkStripsRodDecoder.h.

                          { N_SIDES = 2,
                            N_CHIPS_PER_SIDE = 6,
                            N_STRIPS_PER_CHIP = 128,
                            N_STRIPS_PER_SIDE = 9999,
  }; //Check this numbers

Constructor & Destructor Documentation

◆ ~ITkStripsRodDecoder()

virtual ITkStripsRodDecoder::~ITkStripsRodDecoder ( )

virtualdefault

Destructor.

Member Function Documentation

◆ addRODError()

StatusCode ITkStripsRodDecoder::addRODError	(	uint32_t	rodID,
		SCT_ByteStreamErrors::ErrorType	error,
		SCT_RodDecoderErrorsHelper &	errs,
		const std::unordered_set< IdentifierHash > *	foundHashes = nullptr ) const

private

Add an error for each wafer in the problematic ROD.

Parameters

rodID	Identifer of ROD.
errorType	Error type info.
errs	Byte stream error container.
foundHashes	FE-links whose headers are found. Used only for MissingLinkHeaderError.

Definition at line 253 of file ITkStripsRodDecoder.cxx.

{
  return StatusCode::SUCCESS;
}

◆ addSingleError()

StatusCode ITkStripsRodDecoder::addSingleError	(	const IdentifierHash &	hashID,
		SCT_ByteStreamErrors::ErrorType	error,
		SCT_RodDecoderErrorsHelper &	errs ) const

private

Add single eror.

Parameters

hashID	Identifier for hash.
bsErrorType	Byte Stream error type info.
errs	Byte stream error container.

Definition at line 262 of file ITkStripsRodDecoder.cxx.

{
  return StatusCode::SUCCESS;
}

◆ fillCollection()

StatusCode ITkStripsRodDecoder::fillCollection	(	const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment &	robFrag,
		SCT_RDO_Container &	rdoIDCont,
		IDCInDetBSErrContainer &	errs,
		DataPool< SCT3_RawData > *	dataItemsPool,
		const EventContext &	ctx,
		const std::vector< IdentifierHash > *	vecHash = nullptr ) const

overridevirtual

Fill SCT RDO Collection with decoded ROB data.

Decode the rob data fragment and fill the collection SCT_RDO_Collection with the RDO built by the makeRDO(..) method. rdoIdc, and errs are updated based on robFrag and vecHash.

Parameters

robFrag	ROB fragment.
rdoIDCont	RDO ID Container to be filled.
errs	Byte stream error container.
vecHash	Vector of hashes.

Definition at line 43 of file ITkStripsRodDecoder.cxx.

{
  SCT_RodDecoderErrorsHelper errs = errorsIDC; // on destruction will fill the IDC
 
  const uint32_t robID=robFrag.rod_source_id();
 
  StatusCode sc = StatusCode::SUCCESS;
 
  SharedData data;
  data.reset();
 
  CacheHelper cache; // For the trigger
  cache.vecHash = vecHash;  
 
  OFFLINE_FRAGMENTS_NAMESPACE::PointerType vecROBData;
  const unsigned long int vecROBDataSize{robFrag.rod_ndata()};
  if (vecROBDataSize >   robFrag.payload_size_word()) {
     ATH_MSG_WARNING("The ROB data does not seem to fit in the payload. Rejecting fragment (ndata size  " << vecROBDataSize << " !< payload size " << robFrag.payload_size_word()
                     << " header size: " <<  robFrag.rod_header_size_word()
                     << " trailer size: " << robFrag.rod_trailer_size_word()
                     << " fragment size: " << robFrag.rod_fragment_size_word()
                     << ")");
     return StatusCode::RECOVERABLE;
  }  
  robFrag.rod_data(vecROBData);
  
  ATH_MSG_DEBUG("vecROBDataSize: " << vecROBDataSize);
  
  // Loop over header, hit element, flagged ABCD error, raw data, trailer words
  for (uint32_t i=0; i<vecROBDataSize; i++) {
    // The data is 16-bits wide packed to a 32-bit word (rob_it1). So we unpack it here.
    ATH_MSG_DEBUG("ROB: "<< std::bitset<32>(vecROBData[i]));
  }
  
  const uint8_t* vecROBData_8bits = reinterpret_cast<const uint8_t*>(vecROBData);
  const size_t total_bytes = vecROBDataSize * sizeof(uint32_t);
 
  uint32_t nclusters = 0;
  uint8_t isHCCHeader   = 0;
  int nPacket       = 0;
  uint16_t hccword1 = 0;
  uint8_t word8     = 0;
  uint8_t HccHeadFound = 0;
  uint16_t packetSize = 0;
  bool noClusterTag = false;
  
  for (size_t i=0; i < total_bytes; i+=2) {
    //Read Header
    bool hasError   = false;
    bool breakNow   = false;
    uint16_t psize=packetSize/4;    
    uint16_t word16 = (vecROBData_8bits[i] << 8) | vecROBData_8bits[i + 1];
    ATH_MSG_DEBUG(" 16-bit word: " << std::bitset<16>(word16) << " " << (uint32_t)i << " " << total_bytes );
    
    if(i==total_bytes-2) ATH_MSG_DEBUG("nClusters found (this): " << (uint32_t)nclusters);
    
    ATH_MSG_DEBUG("Check: " << nPacket << " Packets: " << packetSize/4 << " isHCCHeader: " << (uint32_t)isHCCHeader << " " << nPacket);
    
    if(psize != 0 && nPacket != 0){
      ATH_MSG_DEBUG("check: " << (nPacket+1) % (packetSize/2));
      if((nPacket+1) % (packetSize/2)==0) nPacket=-1;
    }
 
    if(word16 == 0 && noClusterTag && nPacket != 0){
      ATH_MSG_DEBUG("Skip empty end of packet 16-bit word: ");
      nPacket++;
    }else if((vecROBData_8bits[i] == 0 || isHCCHeader == 1) && HccHeadFound == 0 && nPacket<2){
      //HCC header found
      ATH_MSG_DEBUG("HCC header found, will decode the next three 8-bit words: " <<(uint32_t)isHCCHeader);
      if(isHCCHeader == 0){
        hccword1 = (vecROBData_8bits[i + 1] << 8) | vecROBData_8bits[i+2];
        ATH_MSG_DEBUG("HCC header: "<<std::bitset<16>(hccword1));        
      } else if(isHCCHeader == 1){
        word8 = vecROBData_8bits[i + 1];
        ATH_MSG_DEBUG("HCC header: "<<std::bitset<8>(word8));        
      }      
      ATH_CHECK(processHccHeader(hccword1, word8, isHCCHeader, robID, data, rdoIDCont, dataItemsPool, cache, errs, hasError, breakNow,ctx));
      if(isHCCHeader==0) HccHeadFound = 1;
      nPacket++;
      noClusterTag=false;
    }else if((HccHeadFound==1 && vecROBData_8bits[i] == 0) || HccHeadFound==2){      
      if(HccHeadFound==1) HccHeadFound=2;
      else if(HccHeadFound==2){
        packetSize = word16;
        ATH_MSG_DEBUG("Packet size is: " << packetSize );
        HccHeadFound=0;
      }
      nPacket++;
    }else if(packetSize!=0 && ((vecROBData_8bits[i] & 0xF8) == 0x18) && (((nPacket+1) % (packetSize/2)) == 5)){
      nPacket++;      
      ATH_MSG_DEBUG("Header found: " << std::bitset<16>(word16));
      nclusters=0;      
      ATH_CHECK(processHeader(word16, robID, data, rdoIDCont, dataItemsPool, cache, errs, hasError, breakNow,ctx));
    }else{
      nPacket++;
      if(word16 == 0xed6f){
        ATH_MSG_DEBUG("No more clusters found");
        noClusterTag=true;
        continue;
      }else{
        nclusters+=1;
        ATH_CHECK(processHits(word16, robID, data, rdoIDCont, dataItemsPool, cache, errs, hasError, ctx));
      }
    }
  }
 
  // Create the last RDO of the last link of the event
  if (data.isStripValid()) {
     if (not data.isSaved()) {
        ATH_MSG_DEBUG("Strip is not saved");
        const int rdoMade{makeRDO(data, cache, dataItemsPool)};
        if (rdoMade == -1) {
           sc = StatusCode::RECOVERABLE;
           ATH_CHECK(addSingleError(data.linkIDHash, SCT_ByteStreamErrors::ByteStreamParseError, errs));
        }
        else {
           data.setSaved(rdoMade);
        }
     }
  }
 
  for (auto& [hash, rdoColl] : data.rdoCollMap) {
    if (rdoColl==nullptr) continue; // nullptr means the collection is already filled.
 
    if (rdoColl->empty()) { // Empty collection is not filled.
      rdoColl.reset();
      errs.removeIfEmpty(hash); // To get the same result as before. Not sure whether we need this.
      continue;
    }
 
    ATH_CHECK(data.writeHandleMap[hash].addOrDelete(std::move(rdoColl)));
  }
 
  if (sc.isFailure()) ATH_MSG_DEBUG("One or more ByteStream errors found ");
  return sc;
}

◆ initialize()

StatusCode ITkStripsRodDecoder::initialize ( )

overridevirtual

Initialize.

Definition at line 20 of file ITkStripsRodDecoder.cxx.

{
 
  // Retrieve cabling tool
  ATH_CHECK(m_cabling.retrieve());
  ATH_MSG_DEBUG("Retrieved tool " << m_cabling);
  ATH_CHECK(detStore()->retrieve(m_itkStripsID,"SCT_ID"));
  m_contextITk = m_itkStripsID->wafer_context();
  m_swapPhiReadoutDirection.resize(m_itkStripsID->wafer_hash_max(), false);
  ATH_CHECK(m_configTool.retrieve());
  const InDetDD::SCT_DetectorManager* itkStripsDetManager{nullptr};
  ATH_CHECK(detStore()->retrieve(itkStripsDetManager, "ITkStrip"));
  const InDetDD::SiDetectorElementCollection* sctDetElementColl{itkStripsDetManager->getDetectorElementCollection()};
  for (const InDetDD::SiDetectorElement* element: *sctDetElementColl) {
    if (element->swapPhiReadoutDirection()) {
      m_swapPhiReadoutDirection[element->identifyHash()] = true;
    }
  }
  ATH_MSG_DEBUG("Initialization was successful");
  return StatusCode::SUCCESS;
}

◆ makeRDO()

int ITkStripsRodDecoder::makeRDO	(	SharedData &	data,
		CacheHelper &	cache,
		DataPool< SCT3_RawData > *	dataItemsPool ) const

private

Builds RawData RDO and adds to RDO container.

Method that builds the RawData RDO and add it to the collection rdoIdc and cache are updated based on other arguments.

Returns: Method has 3 possible return values: 1 if RDO was successfully created 0 if collection was deliberately skipped (for trigger) -1 if there was an error in the decoding - will be passed on as StatusCode::RECOVERABLE by fillCollection()

Parameters

data	Struct to hold data shared in methods used in fillCollection method
cache	Cache.

Definition at line 187 of file ITkStripsRodDecoder.cxx.

{
  // If the link is already decoded, RDO will not be created.
  SCT_RDO_Collection* rdoColl{data.rdoCollMap[data.linkIDHash].get()};
  if (rdoColl==nullptr) {
    ATH_MSG_WARNING("Null rdoCollection pointer found for linkIDHash: " << (uint32_t)data.linkIDHash);
    return 0;
  }
 
  int strip = data.strip;
  if (((strip & 0x7F) + (data.groupSize-1) >= 9999) or (strip<0) or (strip>=9999)) {
    ATH_MSG_WARNING("Cluster with " << data.groupSize << " strips, starting at strip " << strip
                    << " in collection " << data.linkIDHash << " out of range. Will not make RDO");
    return -1;
  }
 
  // This option is for the trigger, if there is a vecHash* given, test it!
  if (cache.vecHash) {
    if (data.linkIDHash == cache.skipHash) {
      ATH_MSG_VERBOSE("Collection for Hash not to be decoded, skip");
      return 0;
    }
    else if (data.linkIDHash != cache.lastHash) {
      cache.lastHash = data.linkIDHash;
      // Maybe the new hash is not in the list, so test it
      std::vector<IdentifierHash>::const_iterator hashIDIterator{find(cache.vecHash->begin(),
                                                                      cache.vecHash->end(),
                                                                      data.linkIDHash)};
      if (hashIDIterator == cache.vecHash->end()) {
        ATH_MSG_VERBOSE("Collection for Hash not to be decoded, skip");
        // Remember this one, so that we do not find(...) forever
        cache.skipHash = data.linkIDHash;
        return 0;
      }
    }
  }
 
  // Get identifier from the hash, this is not nice
  const Identifier digitID{m_itkStripsID->strip_id(data.collID, strip)};
  if (not m_itkStripsID->is_sct(digitID)) {
    ATH_MSG_WARNING("Cluster with invalid Identifier. Will not make RDO");
    return -1;
  }
 
  const unsigned int rawDataWord{static_cast<unsigned int>(data.groupSize | (strip << 11) | (data.timeBin <<22) | (data.errors << 25))};
 
  ATH_MSG_DEBUG("Output Raw Data " << std::hex << " Coll " << data.collID.getString()
                << ":-> " << m_itkStripsID->print_to_string(digitID) << std::dec);
 
  // Now the Collection is there for sure. Create RDO and push it into Collection.
  m_nRDOs++;
 
  if(dataItemsPool){
    SCT3_RawData* sct_rdo = dataItemsPool->nextElementPtr();
    (*sct_rdo) = SCT3_RawData(digitID, rawDataWord, &(data.errorHit));
    rdoColl->push_back(sct_rdo);
  }else{
    rdoColl->push_back(std::make_unique<SCT3_RawData>(digitID, rawDataWord, &(data.errorHit)));
  }
  return 1;
}

◆ processHccHeader()

StatusCode ITkStripsRodDecoder::processHccHeader	(	const uint16_t	inData,
		const uint8_t	data8,
		uint8_t &	isHCCHeader,
		const uint32_t	robID,
		SharedData &	data,
		SCT_RDO_Container &	rdoIDCont,
		DataPool< SCT3_RawData > *	dataItemsPool,
		CacheHelper &	cache,
		SCT_RodDecoderErrorsHelper &	errs,
		bool &	hasError,
		bool &	breakNow,
		const EventContext &	ctx ) const

private

Process header word.

Parameters

inData	input 16 bit data word for header
robID	ROB ID
data	Struct to hold data shared in methods used in fillCollection method
rdoIDCont	RDO ID Container to be filled.
cache	Cache.
errs	SCT_RodDecoderErrorsHelper to fill IDCInDetBSErrContainer
hasError	false means no error, true means at least one error
breakNow	to tell if need to break after this method execution.

Definition at line 270 of file ITkStripsRodDecoder.cxx.

{
 
  StatusCode sc{StatusCode::SUCCESS};
  
  if(isHCCHeader == 1){
    isHCCHeader = 0;
    ATH_MSG_DEBUG("Decoding HCC bits");
    /*24 bits in total
    bits from 24-8 are in hccword1
    Last 8bits are in word8
    */
    uint8_t barrel = ((hccword1 >> 8) & 0x80);
    ATH_MSG_DEBUG("is barrel: " << std::bitset<16>(hccword1 >> 8) << " " << std::bitset<8>(barrel));
    uint8_t side   = ((hccword1 >> 5) & 0x80);
    ATH_MSG_DEBUG("side     : " << std::bitset<16>(hccword1 >> 5) << " " << std::bitset<8>(side));
    uint8_t disk   = ((hccword1 >> 9) & 0x7);
    ATH_MSG_DEBUG("disk     : " << std::bitset<16>((hccword1 >> 9) & 0x7) << " " << std::bitset<8>(disk));
    uint8_t inout  = ((hccword1 >> 8) & 0x1);
    ATH_MSG_DEBUG("inout    : " << std::bitset<16>((hccword1 >> 8) & 0x1) << " " << std::bitset<8>(inout));
    uint8_t petal  = ((hccword1 >> 7) & 0x1);
    ATH_MSG_DEBUG("petal    : " << std::bitset<16>((hccword1 >> 7) & 0x1) << " " << std::bitset<8>(petal));        
    uint8_t phimod = hccword1 & 0x7F;
    ATH_MSG_DEBUG("phimod   : " << std::bitset<16>(hccword1 & 0x7F) << " " << std::bitset<8>(phimod));
    uint8_t hccnum = word8 & 0x80;
    ATH_MSG_DEBUG("hccnum   : " << std::bitset<16>(word8 & 0x80) << " " << std::bitset<8>(hccnum));
    uint8_t etamod = word8 & 0x3F;
    ATH_MSG_DEBUG("etamod   : " << std::bitset<16>(word8 & 0x3F) << " " << std::bitset<8>(etamod));        
 
    bool isbarrel = (barrel != 0x0);
    bool issideA  = (side   != 0x0);
    bool isinout  = (inout  == 0x1);
    bool ispetal  = (petal  == 0x1);
    uint8_t hccN  = (hccnum == 0x80) ? 2 : 1;
 
    ATH_MSG_DEBUG("isBarrel: " << isbarrel << " isSideA: " << issideA << " disk: " << (uint32_t)disk);
    ATH_MSG_DEBUG("isInOut: " << isinout << " isPetal: " << ispetal << " phimod: " << (uint32_t)phimod);
    ATH_MSG_DEBUG("HCCNum: " << (uint32_t)hccN << " etamod: " << (uint32_t)etamod);
 
    int barrel_ec = isbarrel ? 0 : (issideA ? 2 : -2);
 
    const Identifier waferID = m_itkStripsID -> wafer_id(barrel_ec, disk, phimod, etamod, inout);
    const IdentifierHash offlinehash = m_itkStripsID -> wafer_hash(waferID);
    data.setCollection(m_itkStripsID, offlinehash, rdoIDCont, dataItemsPool, errs);
 
    data.side = inout;
    ATH_MSG_DEBUG("hccheader " << isbarrel << " " << issideA << " " << (uint32_t)disk << " " << (uint32_t)inout << " " << (uint32_t)phimod << " " << (uint32_t)etamod << " " << (uint32_t)hccN );
  }  
  else isHCCHeader++;
 
  return sc;
}

◆ processHeader()

StatusCode ITkStripsRodDecoder::processHeader	(	const uint16_t	inData,
		const uint32_t	robID,
		SharedData &	data,
		SCT_RDO_Container &	rdoIDCont,
		DataPool< SCT3_RawData > *	dataItemsPool,
		CacheHelper &	cache,
		SCT_RodDecoderErrorsHelper &	errs,
		bool &	hasError,
		bool &	breakNow,
		const EventContext &	ctx ) const

private

Process header word.

Parameters

inData	input 16 bit data word for header
robID	ROB ID
data	Struct to hold data shared in methods used in fillCollection method
rdoIDCont	RDO ID Container to be filled.
cache	Cache.
errs	SCT_RodDecoderErrorsHelper to fill IDCInDetBSErrContainer
hasError	false means no error, true means at least one error
breakNow	to tell if need to break after this method execution.

Definition at line 335 of file ITkStripsRodDecoder.cxx.

{
  StatusCode sc = StatusCode::SUCCESS;
 
  data.foundHeader = true;
  m_headNumber++;
 
  uint8_t type      = (word16 >> 12) & 0xF;   // bits [15:12]
  // Useful information
  uint8_t l0tag     = (word16 >> 4)  & 0x7F;  // bits [10:4]
  uint8_t bcid_low  = (word16 >> 1)  & 0x7;   // bits [3:1]
  uint8_t bcid_xor  = word16 & 0x1;           // bits [0]
 
  ATH_MSG_DEBUG("l0tag: " << (uint32_t)l0tag << " bcid_low: " << (uint32_t)bcid_low << " bcid_xor: " << (uint32_t)bcid_xor << " type: " << (uint32_t)type << " word16: " << std::bitset<16>(word16));
  
  if (type == 0x01) {  // PR Header
    constexpr bool breakHere{false};
    ATH_MSG_DEBUG("PR Packet Found");
    if (hasError) sc = StatusCode::RECOVERABLE;
    if (breakHere) return sc;
  } else {
    ATH_MSG_WARNING("Unexpected packet type (not PR): 0x" << std::hex << int(type));
    return sc;
  }        
 
  // Create the last RDO of the previous link if any
  if (data.isStripValid()) {
     if (not data.isSaved()) {
 
        const int rdoMade{makeRDO(data, cache, dataItemsPool)};
        if (rdoMade == -1) {
           hasError = true;
           ATH_CHECK(addSingleError(data.linkIDHash, SCT_ByteStreamErrors::ByteStreamParseError, errs));
        }
        else {
           data.setSaved(rdoMade);
        }
     }
  }
 
  // Everything is set to default for a new hunt of RDO
  data.reset();
 
  // Link Number (or stream) in the ROD fragment
  const int rodlinkNumber{static_cast<int>(word16 & 0x7F)};
 
  // This is the real calculation for the offline
  data.linkNumber = (((rodlinkNumber >>4)&0x7)*12+(rodlinkNumber &0xF));
  const uint32_t onlineID{(robID & 0xFFFFFF) | (data.linkNumber << 24)};
  ATH_MSG_DEBUG("OnlineID: " << (uint32_t)onlineID << " Link number: " << data.linkNumber);
  IdentifierHash hash;
  if ((onlineID ==0) or (data.linkNumber > 95)) {
    ATH_CHECK(addSingleError(data.linkIDHash, SCT_ByteStreamErrors::ByteStreamParseError, errs));
    hasError = true;
    ATH_MSG_DEBUG("Header: xxx Link number out of range (skipping following data)"
                  << std::dec << data.linkNumber);
    breakNow = true;
    return sc;
  }
  else {
    hash = m_cabling->getHashFromOnlineId(onlineID, ctx);
    if (hash.is_valid()) {
       ATH_MSG_DEBUG("setCollectionCall");
       //data.setCollection(m_itkStripsID, hash, rdoIDCont, dataItemsPool, errs);
    }
    else {
       std::stringstream msg;
       msg <<std::hex << onlineID;
       ATH_MSG_WARNING("Rob fragment (rob=" << robID << ") with invalid onlineID  " << msg.str() << " -> " << hash  << ".");
    }
  }
  if (!hasError and not hash.is_valid())  {
    std::stringstream msg;
    msg <<std::hex << onlineID;
    ATH_MSG_WARNING("Rob fragment (rob=" << robID << ") with invalid onlineID  " << msg.str() << " -> " << hash  << ".");
    hasError = true;
  }
 
  data.condensedMode = static_cast<bool>(word16 & 0x100);
 
  return sc;
}

◆ processHits()

StatusCode ITkStripsRodDecoder::processHits	(	const uint16_t	inData,
		const uint32_t	robID,
		SharedData &	data,
		SCT_RDO_Container &	rdoIDCont,
		DataPool< SCT3_RawData > *	dataItemsPool,
		CacheHelper &	cache,
		SCT_RodDecoderErrorsHelper &	errs,
		bool &	hasError,
		const EventContext &	ctx ) const

private

Process raw data word.

Parameters

inData	input 16 bit data word for header
robID	ROB ID
data	Struct to hold data shared in methods used in fillCollection method
errs	SCT_RodDecoderErrorsHelper to fill IDCInDetBSErrContainer
hasError	false means no error, true means at least one error

Definition at line 427 of file ITkStripsRodDecoder.cxx.

{
  StatusCode sc = StatusCode::SUCCESS;
 
  uint nchip = (word16 >> 11) & 0xF;
  bool isSecondRow = (word16 >> 10) & 0x01; // Near/Far Strip selector (0 = Near, 1 = Far)
  uint8_t address = (word16 >> 3) & 0x7F; // Strip local address in the selected row [0,127]
 
  //Get the next three strips in the cluster
  uint8_t firsthit = (word16 >> 2) & 0x1;
  uint8_t secondhit   = (word16 >> 1) & 0x1;
  uint8_t thirdhit   = (word16) & 0x1;
 
  ATH_MSG_DEBUG("First hit: " << std::bitset<16>(firsthit));
  ATH_MSG_DEBUG("Second hit: " << std::bitset<16>(secondhit));
  ATH_MSG_DEBUG("Third hit: " << std::bitset<16>(thirdhit));
 
  uint8_t stripN1 = 0,stripN2 = 0,stripN3=0;
  uint8_t addr    = 0;
 
  if(firsthit) {
    addr = address+1;
    stripN1 = 2*addr + (isSecondRow ? 1 : 0);
  }
  if(secondhit) {
    addr = address+2;
    stripN2 = 2*addr + (isSecondRow ? 1 : 0);
  }
  if(thirdhit) {
    addr = address+3;
    stripN3 = 2*addr + (isSecondRow ? 1 : 0);
  }
 
  //int strip_logical_channel = 2*address + (isSecondRow ? 1 : 0); // May be needed later
  data.strip = nchip * 128 + address;
 
  ATH_MSG_DEBUG("abcclusters " << (uint32_t)nchip << " " << (uint32_t)data.strip << " " << (uint32_t)(stripN1) << " " << (uint32_t)(stripN2) << " " << (uint32_t)(stripN3)); 
 
  data.groupSize = 1;
  if (thirdhit) data.groupSize = 4;
  else if (secondhit) data.groupSize = 3;
  else if (firsthit) data.groupSize = 2;
 
  const int rdoMade = makeRDO(data, cache, dataItemsPool);
  if (rdoMade == -1) {
      hasError = true;
      ATH_CHECK(addSingleError(data.linkIDHash, SCT_ByteStreamErrors::ByteStreamParseError, errs));
  } else {
    data.setSaved(rdoMade);
  }
  return sc;
}

Member Data Documentation

◆ m_cabling

ToolHandle<IITkStripCablingTool> ITkStripsRodDecoder::m_cabling

private

Initial value:

{this, 
                                         "ITkStripCablingTool", 
                                         "ITkStripCablingTool", 
                                         "Tool to retrieve ITkStrip Cabling"}

Providing mappings of online and offline identifiers and also serial numbers.

Definition at line 321 of file ITkStripsRodDecoder.h.

                                            {this, 
                                         "ITkStripCablingTool", 
                                         "ITkStripCablingTool", 
                                         "Tool to retrieve ITkStrip Cabling"};

◆ m_chipNumberError

std::atomic_uint ITkStripsRodDecoder::m_chipNumberError {0}

mutableprivate

Total number of chip number errors.

Definition at line 390 of file ITkStripsRodDecoder.h.

390{0};

◆ m_condHit1Error

std::atomic_uint ITkStripsRodDecoder::m_condHit1Error {0}

mutableprivate

Total number of first hit data errors.

Definition at line 384 of file ITkStripsRodDecoder.h.

384{0};

◆ m_condHit2Error

std::atomic_uint ITkStripsRodDecoder::m_condHit2Error {0}

mutableprivate

Total number second hit data errors.

Definition at line 387 of file ITkStripsRodDecoder.h.

387{0};

◆ m_configDataBit

std::atomic_uint ITkStripsRodDecoder::m_configDataBit {0}

mutableprivate

Total number of configuration data for raw data.

Definition at line 378 of file ITkStripsRodDecoder.h.

378{0};

◆ m_configTool

ToolHandle<ISCT_ConfigurationConditionsTool> ITkStripsRodDecoder::m_configTool

private

Initial value:

{this, 
                                                            "ConfigTool",
                                                            "SCT_ConfigurationConditionsTool/InDetSCT_ConfigurationConditionsTool", 
                                                            "Tool to retrieve SCT Configuration Tool"}

Service that keeps track of configuration conditions.

Definition at line 327 of file ITkStripsRodDecoder.h.

                                                           {this, 
                                                            "ConfigTool",
                                                            "SCT_ConfigurationConditionsTool/InDetSCT_ConfigurationConditionsTool", 
                                                            "Tool to retrieve SCT Configuration Tool"};

◆ m_contextITk

IdContext ITkStripsRodDecoder::m_contextITk

private

"Context" of an expanded identifier (ExpandedIdentifier) for compact or hash versions (Identifier32 or IdentifierHash)

Definition at line 318 of file ITkStripsRodDecoder.h.

◆ m_evenExpHitNumber

std::atomic_uint ITkStripsRodDecoder::m_evenExpHitNumber {0}

mutableprivate

Total number of consecutive paired strips with hit decoded in expanded mode.

Definition at line 342 of file ITkStripsRodDecoder.h.

342{0};

◆ m_firstExpHitNumber

std::atomic_uint ITkStripsRodDecoder::m_firstExpHitNumber {0}

mutableprivate

Total number of first strips with hit decoded in expanded mode.

Definition at line 339 of file ITkStripsRodDecoder.h.

339{0};

◆ m_flagErrorBit

std::atomic_uint ITkStripsRodDecoder::m_flagErrorBit {0}

mutableprivate

Total number of flag error data.

Definition at line 381 of file ITkStripsRodDecoder.h.

381{0};

◆ m_headErrorBCID

std::atomic_uint ITkStripsRodDecoder::m_headErrorBCID {0}

mutableprivate

Total number of BCID errors in the header data.

Definition at line 354 of file ITkStripsRodDecoder.h.

354{0};

◆ m_headErrorFormatter

std::atomic_uint ITkStripsRodDecoder::m_headErrorFormatter {0}

mutableprivate

Total number of formatter errors in the header data.

Definition at line 363 of file ITkStripsRodDecoder.h.

363{0};

◆ m_headErrorLvl1ID

std::atomic_uint ITkStripsRodDecoder::m_headErrorLvl1ID {0}

mutableprivate

Total number of Lvl1ID errors in the header data.

Definition at line 357 of file ITkStripsRodDecoder.h.

357{0};

◆ m_headErrorPreamble

std::atomic_uint ITkStripsRodDecoder::m_headErrorPreamble {0}

mutableprivate

Total number of preamble errors in the header data.

Definition at line 366 of file ITkStripsRodDecoder.h.

366{0};

◆ m_headErrorTimeout

std::atomic_uint ITkStripsRodDecoder::m_headErrorTimeout {0}

mutableprivate

Total number of timeout errors in the header data.

Definition at line 360 of file ITkStripsRodDecoder.h.

360{0};

◆ m_headNumber

std::atomic_uint ITkStripsRodDecoder::m_headNumber {0}

mutableprivate

Total number of decoded header data.

Definition at line 348 of file ITkStripsRodDecoder.h.

348{0};

◆ m_itkStripsID

const SCT_ID* ITkStripsRodDecoder::m_itkStripsID {nullptr}

private

Identifier helper class for the SCT subdetector that creates compact Identifier objects and IdentifierHash or hash IDs.

Also allows decoding of these IDs.

Definition at line 314 of file ITkStripsRodDecoder.h.

314{nullptr};

◆ m_lastExpHitNumber

std::atomic_uint ITkStripsRodDecoder::m_lastExpHitNumber {0}

mutableprivate

Total number of last consecutive strips with hit decoded in expanded mode.

Definition at line 345 of file ITkStripsRodDecoder.h.

345{0};

◆ m_maskedLinkNumber

std::atomic_uint ITkStripsRodDecoder::m_maskedLinkNumber {0}

mutableprivate

Total number of masked links in the header data.

Definition at line 402 of file ITkStripsRodDecoder.h.

402{0};

◆ m_maskedRODNumber

std::atomic_uint ITkStripsRodDecoder::m_maskedRODNumber {0}

mutableprivate

Total number of masked RDOs.

Definition at line 405 of file ITkStripsRodDecoder.h.

405{0};

◆ m_nHits

std::atomic_uint ITkStripsRodDecoder::m_nHits {0}

mutableprivate

Total number of SCT hits in ByteStream.

Definition at line 396 of file ITkStripsRodDecoder.h.

396{0};

◆ m_nRDOs

std::atomic_uint ITkStripsRodDecoder::m_nRDOs {0}

mutableprivate

Total number of SCT RDOs created.

Definition at line 399 of file ITkStripsRodDecoder.h.

399{0};

◆ m_numMissingLinkHeader

std::atomic_uint ITkStripsRodDecoder::m_numMissingLinkHeader {0}

mutableprivate

Total number of missing link headers.

Definition at line 414 of file ITkStripsRodDecoder.h.

414{0};

◆ m_pairedCondHitNumber

std::atomic_uint ITkStripsRodDecoder::m_pairedCondHitNumber {0}

mutableprivate

Total number of paired strips with hit decoded in condensed mode.

Definition at line 336 of file ITkStripsRodDecoder.h.

336{0};

◆ m_rodClockErrorNumber

std::atomic_uint ITkStripsRodDecoder::m_rodClockErrorNumber {0}

mutableprivate

Total number of ROD clock errors.

Definition at line 408 of file ITkStripsRodDecoder.h.

408{0};

◆ m_singleCondHitNumber

std::atomic_uint ITkStripsRodDecoder::m_singleCondHitNumber {0}

mutableprivate

Total number of single strips with hit decoded in condensed mode.

Definition at line 333 of file ITkStripsRodDecoder.h.

333{0};

◆ m_swapPhiReadoutDirection

std::vector<bool> ITkStripsRodDecoder::m_swapPhiReadoutDirection {}

private

Swap phi readout direction.

Definition at line 417 of file ITkStripsRodDecoder.h.

417{};

◆ m_trailerErrorBit

std::atomic_uint ITkStripsRodDecoder::m_trailerErrorBit {0}

mutableprivate

Total number of trailer bit errors.

Definition at line 375 of file ITkStripsRodDecoder.h.

375{0};

◆ m_trailerErrorLimit

std::atomic_uint ITkStripsRodDecoder::m_trailerErrorLimit {0}

mutableprivate

Total number of header trailer limit errors in the trailer data.

Definition at line 372 of file ITkStripsRodDecoder.h.

372{0};

◆ m_trailerErrorOverflow

std::atomic_uint ITkStripsRodDecoder::m_trailerErrorOverflow {0}

mutableprivate

Total number of overflow errors in the trailer data.

Definition at line 369 of file ITkStripsRodDecoder.h.

369{0};

◆ m_trailerNumber

std::atomic_uint ITkStripsRodDecoder::m_trailerNumber {0}

mutableprivate

Total number of decoded trailer data.

Definition at line 351 of file ITkStripsRodDecoder.h.

351{0};

◆ m_truncatedRODNumber

std::atomic_uint ITkStripsRodDecoder::m_truncatedRODNumber {0}

mutableprivate

Total number of truncated ROBFragments.

Definition at line 411 of file ITkStripsRodDecoder.h.

411{0};

◆ m_unknownDataFormat

std::atomic_uint ITkStripsRodDecoder::m_unknownDataFormat {0}

mutableprivate

Total number of unknown data formats.

Definition at line 393 of file ITkStripsRodDecoder.h.

393{0};

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

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ITk_DecoderNumbers

Constructor & Destructor Documentation

◆ ~ITkStripsRodDecoder()

Member Function Documentation

◆ addRODError()

◆ addSingleError()

◆ fillCollection()

◆ initialize()

◆ makeRDO()

◆ processHccHeader()

◆ processHeader()

◆ processHits()

Member Data Documentation

◆ m_cabling

◆ m_chipNumberError

◆ m_condHit1Error

◆ m_condHit2Error

◆ m_configDataBit

◆ m_configTool

◆ m_contextITk

◆ m_evenExpHitNumber

◆ m_firstExpHitNumber

◆ m_flagErrorBit

◆ m_headErrorBCID

◆ m_headErrorFormatter

◆ m_headErrorLvl1ID

◆ m_headErrorPreamble

◆ m_headErrorTimeout

◆ m_headNumber

◆ m_itkStripsID

◆ m_lastExpHitNumber

◆ m_maskedLinkNumber

◆ m_maskedRODNumber

◆ m_nHits

◆ m_nRDOs

◆ m_numMissingLinkHeader

◆ m_pairedCondHitNumber

◆ m_rodClockErrorNumber

◆ m_singleCondHitNumber

◆ m_swapPhiReadoutDirection

◆ m_trailerErrorBit

◆ m_trailerErrorLimit

◆ m_trailerErrorOverflow

◆ m_trailerNumber

◆ m_truncatedRODNumber

◆ m_unknownDataFormat