Athena Algorithm Tool that provides conversion from ITkStrips RDO to ROD format Bytestream. More...

#include <ITkStripsRodEncoder.h>

Inheritance diagram for ITkStripsRodEncoder:

Collaboration diagram for ITkStripsRodEncoder:

Public Member Functions
	ITkStripsRodEncoder (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor. More...

virtual	~ITkStripsRodEncoder ()=default
	Destructor. More...

virtual StatusCode	initialize () override
	Initialize. More...

virtual StatusCode	finalize () override
	Finalize. More...

virtual void	fillROD (std::vector< uint32_t > &vec32Data, const uint32_t &robID, const std::vector< const SCT_RDORawData * > &vecRDOs) const override
	Main Convert method. More...

Private Member Functions
void	encodeData (const std::vector< int > &vecTimeBins, std::vector< uint16_t > &vec16Words, const SCT_RDORawData *rdo, const int &groupSize, const int &strip) const
	Method to encode RDO data to vector of 16 bin words. More...

void	packFragments (std::vector< uint16_t > &vec16Words, std::vector< uint32_t > &vec32Words) const
	Method to pack vector of 16 bit words intto a vector of 32 bit words. More...

uint32_t	set32Bits (const unsigned short int arr16Words, const unsigned short int position, const unsigned short int &numWords) const
	@breif Method to set pairs of 16 bit words to a 32 bit word. More...

int	side (const SCT_RDORawData *rdo) const
	Get the side info from the RDO. More...

int	getTimeBin (const SCT_RDORawData *rdo) const
	Get the time bin info from the RDO. More...

int	getStrip (const SCT_RDORawData *rdo) const
	Get the strip number info from the RDO. More...

Identifier	offlineID (const SCT_RDORawData *rdo) const
	Get the offline Identifier from the RDO. More...

uint32_t	onlineID (const SCT_RDORawData *rdo) const
	Get the online Identifier from the RDO. More...

int	getRODLink (const SCT_RDORawData *rdo) const
	Get the ROD link number info in the RDO header data. More...

uint16_t	getHeaderUsingRDO (const SCT_RDORawData *rdo) const
	Get the 16-bit word for a header for a hit. More...

uint16_t	getHeaderUsingHash (const IdentifierHash &linkHash, const int &errorWord) const
	Get the 16-bit word for a header for a link with a ByteStream error. More...

uint16_t	getTrailer (const int &errorWord) const
	Get the 16-bit word for a trailer, with or without ByteStream errors. More...

Private Attributes
ToolHandle< ISCT_CablingTool >	m_cabling
	Providing mappings of online and offline identifiers and also serial numbers. More...

const SCT_ID *	m_itkStripsID {nullptr}
	Identifier helper class for the ITkStrips subdetector that creates compact Identifier objects and IdentifierHash or hash IDs. More...

BooleanProperty	m_condensed {this, "CondensedMode", false, "Condensed mode (true) or Expanded mode (false)"}
	Example Boolean used to determine decoding mode, maybe unused finally. More...

std::set< Identifier >	m_swapModuleID {}
	Swap Module identifier, set by SCTRawContByteStreamTool. More...

Detailed Description

Athena Algorithm Tool that provides conversion from ITkStrips RDO to ROD format Bytestream.

Definition at line 30 of file ITkStripsRodEncoder.h.

Constructor & Destructor Documentation

◆ ITkStripsRodEncoder()

ITkStripsRodEncoder::ITkStripsRodEncoder	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Constructor.

Definition at line 35 of file ITkStripsRodEncoder.cxx.

                                                          : 
   base_class(type, name, parent){
   //nop
 }

◆ ~ITkStripsRodEncoder()

virtual ITkStripsRodEncoder::~ITkStripsRodEncoder ( )

virtualdefault

Destructor.

Member Function Documentation

◆ encodeData()

void ITkStripsRodEncoder::encodeData	(	const std::vector< int > &	vecTimeBins,
		std::vector< uint16_t > &	vec16Words,
		const SCT_RDORawData *	rdo,
		const int &	groupSize,
		const int &	strip
	)		const

private

Method to encode RDO data to vector of 16 bin words.

Methods used by main convert methods fillROD(...).

Parameters

vecTimeBins	Vector of time bins for RDOs.
vec16Words	Vector of 16 bit words to filled from encoded RDO data.
rdo	RDO raw data object to be encoded.
groupSize	Group size info from the RDO.
strip	Strip number info from the RDO.

code to be filled here

Definition at line 76 of file ITkStripsRodEncoder.cxx.

                                                                                            {
   return;
 }

◆ fillROD()

void ITkStripsRodEncoder::fillROD	(	std::vector< uint32_t > &	vec32Data,
		const uint32_t &	robID,
		const std::vector< const SCT_RDORawData * > &	vecRDOs
	)		const

overridevirtual

Main Convert method.

Converts SCT RDO to a vector of 32 bit words. Starts by retrieving and collecting errors, then loops through RDO's and decode them to 16 bit words, and then finally it packs the 16 bit word into 32 bit words vector.

Parameters

vec32Data	Vector of 32 bit words to be filled with encoded RDOs from the SCT.
robID	ID of the current readout buffer (ROB).
vecRDOs	Vector containing the RDOs to be coverted to vector of 32 bit words.

Definition at line 68 of file ITkStripsRodEncoder.cxx.

                                                                               { 
   //code to be filled here
   return;
 }

◆ finalize()

StatusCode ITkStripsRodEncoder::finalize ( )

overridevirtual

Finalize.

Definition at line 63 of file ITkStripsRodEncoder.cxx.

                                          {
   return StatusCode::SUCCESS;
 }

◆ getHeaderUsingHash()

uint16_t ITkStripsRodEncoder::getHeaderUsingHash	(	const IdentifierHash &	linkHash,
		const int &	errorWord
	)		const

private

Get the 16-bit word for a header for a link with a ByteStream error.

Definition at line 167 of file ITkStripsRodEncoder.cxx.

                                                                                                   {
   const int rodLink{rodLinkFromOnlineID(m_cabling->getOnlineIdFromHash(linkHash))};
   const uint16_t linkHeader{static_cast<uint16_t>(0x2000 | errorWord | (m_condensed.value() << 8) | rodLink)};
   return linkHeader;
 }

◆ getHeaderUsingRDO()

uint16_t ITkStripsRodEncoder::getHeaderUsingRDO ( const SCT_RDORawData * rdo ) const

private

Get the 16-bit word for a header for a hit.

Definition at line 160 of file ITkStripsRodEncoder.cxx.

                                                                       {
   const int rodLink{getRODLink(rdo)};
   const uint16_t linkHeader{static_cast<uint16_t>(0x2000 | (m_condensed.value() << 8) | rodLink)};
   return linkHeader;
 }

◆ getRODLink()

int ITkStripsRodEncoder::getRODLink ( const SCT_RDORawData * rdo ) const

private

Get the ROD link number info in the RDO header data.

Definition at line 145 of file ITkStripsRodEncoder.cxx.

                                                                {
   return rodLinkFromOnlineID(onlineID(rdo));
 }

◆ getStrip()

int ITkStripsRodEncoder::getStrip ( const SCT_RDORawData * rdo ) const

private

Get the strip number info from the RDO.

Definition at line 126 of file ITkStripsRodEncoder.cxx.

                                                              {
   const Identifier rdoID{rdo->identify()};
   return m_itkStripsID->strip(rdoID);
 }

◆ getTimeBin()

int ITkStripsRodEncoder::getTimeBin ( const SCT_RDORawData * rdo ) const

private

Get the time bin info from the RDO.

◆ getTrailer()

uint16_t ITkStripsRodEncoder::getTrailer ( const int & errorWord ) const

private

Get the 16-bit word for a trailer, with or without ByteStream errors.

Definition at line 174 of file ITkStripsRodEncoder.cxx.

                                                           {
   const uint16_t linkTrailer{static_cast<uint16_t>(0x4000 | errorWord)};
   return linkTrailer;
 }

◆ initialize()

StatusCode ITkStripsRodEncoder::initialize ( )

overridevirtual

Initialize.

Definition at line 44 of file ITkStripsRodEncoder.cxx.

                                 {
   ATH_MSG_DEBUG("ITkStripsRodEncoder::initialize()");
   
   // Retrieve cabling tool
   ATH_CHECK(m_cabling.retrieve());
   ATH_MSG_DEBUG("Retrieved tool " << m_cabling);
   ATH_CHECK(detStore()->retrieve(m_itkStripsID, "SCT_ID"));
   const InDetDD::SCT_DetectorManager* itkStripsDetManager{nullptr};
   ATH_CHECK(detStore()->retrieve(itkStripsDetManager, "SCT"));
   const InDetDD::SiDetectorElementCollection* sctDetElementColl{itkStripsDetManager->getDetectorElementCollection()};
   for (const InDetDD::SiDetectorElement* sctDetElement : *sctDetElementColl) {
     if (sctDetElement->swapPhiReadoutDirection()) {
       m_swapModuleID.insert(sctDetElement->identify());
     }
   }
   return StatusCode::SUCCESS;
 }

◆ offlineID()

Identifier ITkStripsRodEncoder::offlineID ( const SCT_RDORawData * rdo ) const

private

Get the offline Identifier from the RDO.

Definition at line 132 of file ITkStripsRodEncoder.cxx.

                                                               {
   const Identifier rdoId{rdo->identify()};
   return m_itkStripsID->wafer_id(rdoId);
 }

◆ onlineID()

uint32_t ITkStripsRodEncoder::onlineID ( const SCT_RDORawData * rdo ) const

private

Get the online Identifier from the RDO.

Definition at line 138 of file ITkStripsRodEncoder.cxx.

                                                              {
   const Identifier waferID{offlineID(rdo)};
   const IdentifierHash offlineIDHash{m_itkStripsID->wafer_hash(waferID)};
   return static_cast<uint32_t>(m_cabling->getOnlineIdFromHash(offlineIDHash));
 }

◆ packFragments()

void ITkStripsRodEncoder::packFragments	(	std::vector< uint16_t > &	vec16Words,
		std::vector< uint32_t > &	vec32Words
	)		const

private

Method to pack vector of 16 bit words intto a vector of 32 bit words.

Method us used by private method encodeData(...).

Parameters

vec16Words	Vector containing 16 bit words.
vec32Words	Vector for 32 bit words to be packed.

Definition at line 84 of file ITkStripsRodEncoder.cxx.

                                                                           {
   int num16Words{static_cast<int>(vec16Words.size())};
   if (isOdd(num16Words)) {
     // Just add an additional 16bit words to make even size v16 to in the 32 bits word 0x40004000
     vec16Words.push_back(0x4000);
     num16Words++;
   }
   // Now merge 2 consecutive 16 bit words in 32 bit words
   const unsigned short int numWords{2};
   const unsigned short int position[numWords]{0, 16};
   unsigned short int arr16Words[numWords]{0, 0};
   for (int i{0}; i<num16Words; i += numWords) {
     arr16Words[i%numWords]     = vec16Words[i+1];
     arr16Words[(i+1)%numWords] = vec16Words[i];
     const uint32_t uint32Word{set32Bits(arr16Words, position, numWords)};
     vec32Words.push_back(uint32Word);
 #ifdef ITkStripsDEBUG
     ATH_MSG_INFO("SCT encoder -> PackFragments: Output rod 0x"<<std::hex<<uint32Word<<std::dec);
 #endif
   }
   return;
 }

◆ set32Bits()

uint32_t ITkStripsRodEncoder::set32Bits	(	const unsigned short int *	arr16Words,
		const unsigned short int *	position,
		const unsigned short int &	numWords
	)		const

private

@breif Method to set pairs of 16 bit words to a 32 bit word.

Function used by the packFragments(...) method.

Parameters

arr16Words	Pointer to array containing a pair of 16 bit words.
position	Pointer to an array that gives the 32 bit starting positions of the 16 bit words and corresponding to arr16Words.
numWords	Number of word to be set to a 32 bit word.

Definition at line 110 of file ITkStripsRodEncoder.cxx.

                                                                              {
   uint32_t uint32Word{0};
   uint32_t pos{0};
   uint32_t uint16Word{0};
   for (uint16_t i{0}; i<numWords; i++) {
     uint16Word = static_cast<uint32_t>(*(arr16Words+i));
     pos = static_cast<uint32_t>(*(position+i));
     uint32Word |= (uint16Word<<pos);
   } 
   return uint32Word;
 }

◆ side()

int ITkStripsRodEncoder::side ( const SCT_RDORawData * rdo ) const

private

Get the side info from the RDO.

Definition at line 150 of file ITkStripsRodEncoder.cxx.

                                                          {
   const Identifier rdoID{rdo->identify()};
   int itkSide{m_itkStripsID->side(rdoID)};
   return itkSide;
 }

Member Data Documentation

◆ m_cabling

ToolHandle<ISCT_CablingTool> ITkStripsRodEncoder::m_cabling

private

Initial value:

{this, 
                                         "SCT_CablingTool", 
                                         "SCT_CablingTool", 
                                         "Tool to retrieve ITkStrips Cabling"}

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

Definition at line 129 of file ITkStripsRodEncoder.h.

◆ m_condensed

BooleanProperty ITkStripsRodEncoder::m_condensed {this, "CondensedMode", false, "Condensed mode (true) or Expanded mode (false)"}

private

Example Boolean used to determine decoding mode, maybe unused finally.

Definition at line 139 of file ITkStripsRodEncoder.h.

◆ m_itkStripsID

const SCT_ID* ITkStripsRodEncoder::m_itkStripsID {nullptr}

private

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

Also allows decoding of these IDs.

Definition at line 136 of file ITkStripsRodEncoder.h.

◆ m_swapModuleID

std::set<Identifier> ITkStripsRodEncoder::m_swapModuleID {}

private

Swap Module identifier, set by SCTRawContByteStreamTool.

Definition at line 142 of file ITkStripsRodEncoder.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ITkStripsRodEncoder()

◆ ~ITkStripsRodEncoder()

Member Function Documentation

◆ encodeData()

◆ fillROD()

◆ finalize()

◆ getHeaderUsingHash()

◆ getHeaderUsingRDO()

◆ getRODLink()

◆ getStrip()

◆ getTimeBin()

◆ getTrailer()

◆ initialize()

◆ offlineID()

◆ onlineID()

◆ packFragments()

◆ set32Bits()

◆ side()

Member Data Documentation

◆ m_cabling

◆ m_condensed

◆ m_itkStripsID

◆ m_swapModuleID