Utility functions for xAOD::CTPResult objects that rely on tdaq-common. More...

Enumerations
enum	WordType { WordType::TIP, WordType::TBP, WordType::TAP, WordType::TAV, WordType::Extra }
	Enum describing the different word types in the CTP result. More...

Functions
void	initialize (xAOD::CTPResult &ctpRes, uint32_t ctpVersionNumber, const uint32_t nBCs=1, uint32_t nExtraWords=0)
	Initialize with a number of bunch crossings of the readout window. More...

void	initialize (xAOD::CTPResult &ctpRes, uint32_t ctpVersionNumber, const std::vector< uint32_t > &data, uint32_t nExtraWords=0)
	Initialize with raw data words from one or more bunch crossings. More...

uint32_t	getTimeSec (const xAOD::CTPResult &ctpRes)
	Get the time in seconds. More...

void	setTimeSec (xAOD::CTPResult &ctpRes, const uint32_t sec)
	Set the time in seconds. More...

uint32_t	getTimeNanoSec (const xAOD::CTPResult &ctpRes)
	Get the time in nanoseconds. More...

void	setTimeNanoSec (xAOD::CTPResult &ctpRes, const uint32_t nano)
	Set the time in nanoseconds. More...

void	setNumberOfBunches (xAOD::CTPResult &ctpRes, const uint32_t nBCs)
	Set the number of bunch crossings. More...

void	setNumberOfAdditionalWords (xAOD::CTPResult &ctpRes, const uint32_t nExtraWords)
	Set the number of additional data words. More...

std::vector< uint32_t >	getTIPWords (const xAOD::CTPResult &ctpRes)
	Get the TIP (Trigger Inputs to the CTP) words (in Run3 512 items) More...

std::vector< uint32_t >	getTBPWords (const xAOD::CTPResult &ctpRes)
	Get the TBP (Trigger Before Prescale) words. More...

std::vector< uint32_t >	getTAPWords (const xAOD::CTPResult &ctpRes)
	Get the TAP (Trigger After Prescale) words. More...

std::vector< uint32_t >	getTAVWords (const xAOD::CTPResult &ctpRes)
	Get the TAV (Trigger After Veto) words. More...

std::vector< uint32_t >	getExtraWords (const xAOD::CTPResult &ctpRes)
	Get additional words. More...

std::vector< uint32_t >	getWords (const xAOD::CTPResult &ctpRes, CTPResultUtils::WordType type)
	Helper to retrieve specific words. More...

uint32_t	getTimeSinceLastL1A (const xAOD::CTPResult &ctpRes)
	Get the time since the last 1 accept. More...

Detailed Description

Utility functions for xAOD::CTPResult objects that rely on tdaq-common.

Declared here as tdaq-common is used in TrigT1Interfaces and not xAODTrigger. Prevents using XAOD_ANALYSIS macro in xAOD class.

Enumeration Type Documentation

◆ WordType

enum CTPResultUtils::WordType

strong

Enum describing the different word types in the CTP result.

TIP: Trigger inputs to the CTP.
TBP: Trigger Before Prescale.
TAP: Trigger After Prescale.
TAV: Trigger After Veto.
Extra: Additional data words beyond the standard categories.

Enumerator
TIP
TBP
TAP
TAV
Extra

Definition at line 27 of file CTPResultUtils.h.

27 {TIP, TBP, TAP, TAV, Extra};

Function Documentation

◆ getExtraWords()

std::vector< uint32_t > CTPResultUtils::getExtraWords ( const xAOD::CTPResult & ctpRes )

Get additional words.

Returns: Vector of extra words.

Definition at line 120 of file CTPResultUtils.cxx.

120 {return getWords(ctpRes, WordType::Extra);}

◆ getTAPWords()

std::vector< uint32_t > CTPResultUtils::getTAPWords ( const xAOD::CTPResult & ctpRes )

Get the TAP (Trigger After Prescale) words.

Returns: Vector of TAP words.

Definition at line 114 of file CTPResultUtils.cxx.

114 {return getWords(ctpRes, WordType::TAP);}

◆ getTAVWords()

std::vector< uint32_t > CTPResultUtils::getTAVWords ( const xAOD::CTPResult & ctpRes )

Get the TAV (Trigger After Veto) words.

Returns: Vector of TAV words.

Definition at line 117 of file CTPResultUtils.cxx.

117 {return getWords(ctpRes, WordType::TAV);}

◆ getTBPWords()

std::vector< uint32_t > CTPResultUtils::getTBPWords ( const xAOD::CTPResult & ctpRes )

Get the TBP (Trigger Before Prescale) words.

Returns: Vector of TBP words.

Definition at line 111 of file CTPResultUtils.cxx.

111 {return getWords(ctpRes, WordType::TBP);}

◆ getTimeNanoSec()

uint32_t CTPResultUtils::getTimeNanoSec ( const xAOD::CTPResult & ctpRes )

Get the time in nanoseconds.

Returns: Time in nanoseconds.

Definition at line 65 of file CTPResultUtils.cxx.

                                                        {
     CTPdataformatVersion ctpDataFormat(ctpRes.ctpVersionNumber());
     if(ctpRes.dataWords().size() <= ctpDataFormat.getTimeNanosecondsPos()) {
       return 0; 
     } 
     return (ctpRes.dataWords().at(ctpDataFormat.getTimeNanosecondsPos() ) >> ctpDataFormat.getTimeNanosecondsOffset() ) * ctpDataFormat.getTimeNanosecondsTicks();
   }

◆ getTimeSec()

uint32_t CTPResultUtils::getTimeSec ( const xAOD::CTPResult & ctpRes )

Get the time in seconds.

Returns: Time in seconds.

Definition at line 46 of file CTPResultUtils.cxx.

                                                    {
     CTPdataformatVersion ctpDataFormat(ctpRes.ctpVersionNumber());
     if(ctpRes.dataWords().size() <= ctpDataFormat.getTimeSecondsPos()){
       return 0;
     } 
     return ctpRes.dataWords().at(ctpDataFormat.getTimeSecondsPos());
   }

◆ getTimeSinceLastL1A()

uint32_t CTPResultUtils::getTimeSinceLastL1A ( const xAOD::CTPResult & ctpRes )

Get the time since the last 1 accept.

Returns: Time since the last L1 accept.

◆ getTIPWords()

std::vector< uint32_t > CTPResultUtils::getTIPWords ( const xAOD::CTPResult & ctpRes )

Get the TIP (Trigger Inputs to the CTP) words (in Run3 512 items)

Returns: Vector of TIP words.

Definition at line 108 of file CTPResultUtils.cxx.

108 {return getWords(ctpRes, WordType::TIP);}

◆ getWords()

std::vector< uint32_t > CTPResultUtils::getWords	(	const xAOD::CTPResult &	ctpRes,
		CTPResultUtils::WordType	type
	)

Helper to retrieve specific words.

Parameters

type	The word type to retrieve.

Returns: Vector of words of the specified type.

Definition at line 123 of file CTPResultUtils.cxx.

                                                                                          {
     unsigned int nWords = 0;
     unsigned int offset = 0;
     std::vector<uint32_t> vec;
     vec.clear();
     CTPdataformatVersion ctpDataFormat(ctpRes.ctpVersionNumber());
     switch (type) {
     case WordType::TIP:
         nWords = ctpDataFormat.getTIPwords();
         offset = ctpDataFormat.getTIPpos();
         break;
     case WordType::TBP:
         nWords = ctpDataFormat.getTBPwords();
         offset = ctpDataFormat.getTBPpos();
         break;
     case WordType::TAP:
         nWords = ctpDataFormat.getTAPwords();
         offset = ctpDataFormat.getTAPpos();
         break;
     case WordType::TAV:
         nWords = ctpDataFormat.getTAVwords();
         offset = ctpDataFormat.getTAVpos();
         break;
     case WordType::Extra:
         vec.assign(ctpRes.dataWords().begin() + (ctpRes.dataWords().size()-ctpRes.numberOfAdditionalWords()), ctpRes.dataWords().end());
         return vec;
         break;
     default:
         break;
     }
     for(unsigned int bunch = 0 ; bunch < ctpRes.numberOfBunches() ; ++bunch) {
       for(unsigned int tbp = 0; tbp < nWords; ++tbp) {
           // take offset of TBPwords into account
           unsigned int index = offset + tbp;
           // go to the correct bunch
           index += (bunch * ctpDataFormat.getDAQwordsPerBunch());
           if( index < ctpRes.dataWords().size() ) {
             vec.push_back(ctpRes.dataWords()[index]);
           }
       }
     }
     // this is now a list of consecutive data words for all bunches
     return vec;
   }

◆ initialize() [1/2]

void CTPResultUtils::initialize	(	xAOD::CTPResult &	ctpRes,
		uint32_t	ctpVersionNumber,
		const std::vector< uint32_t > &	data,
		uint32_t	nExtraWords = `0`
	)

Initialize with raw data words from one or more bunch crossings.

Parameters

ctpVersionNumber	The version number of the CTP data format.
data	Vector of raw data words.
nExtraWords	Number of extra data words.

Definition at line 30 of file CTPResultUtils.cxx.

                                                                                                                            {
     CTPdataformatVersion ctpDataFormat(ctpVersionNumber);
     ctpRes.setCtpVersionNumber(ctpVersionNumber);
     ctpRes.setDataWords(data);
     setNumberOfAdditionalWords(ctpRes, nExtraWords);
  
     //additional initialisation
     if (!ctpRes.dataWords().size()) {
       setNumberOfBunches(ctpRes, 0u);
     } else {
       uint32_t words = static_cast<uint32_t>(ctpRes.dataWords().size()) - ctpDataFormat.getNumberTimeWords() - nExtraWords;
       setNumberOfBunches(ctpRes, words / ctpDataFormat.getDAQwordsPerBunch());
     }
   }

◆ initialize() [2/2]

void CTPResultUtils::initialize	(	xAOD::CTPResult &	ctpRes,
		uint32_t	ctpVersionNumber,
		const uint32_t	nBCs = `1`,
		uint32_t	nExtraWords = `0`
	)

Initialize with a number of bunch crossings of the readout window.

Parameters

ctpVersionNumber	The version number of the CTP data format.
nBCs	Number of bunch crossings in the readout window.
nExtraWords	Number of extra data words.

Definition at line 17 of file CTPResultUtils.cxx.

                                                                                                                {   
     CTPdataformatVersion ctpDataFormat(ctpVersionNumber);
     ctpRes.setCtpVersionNumber(ctpVersionNumber);
     setNumberOfBunches(ctpRes, nBCs);
     setNumberOfAdditionalWords(ctpRes, nExtraWords);
  
     // create correct length, zero filled data member
     std::vector<uint32_t> words;
     words.resize(ctpDataFormat.getNumberTimeWords()+(nBCs*ctpDataFormat.getDAQwordsPerBunch() )+nExtraWords);
     ctpRes.setDataWords(words);
   }

◆ setNumberOfAdditionalWords()

void CTPResultUtils::setNumberOfAdditionalWords	(	xAOD::CTPResult &	ctpRes,
		const uint32_t	nExtraWords
	)

Set the number of additional data words.

Parameters

nExtraWords Number of extra words.

Definition at line 96 of file CTPResultUtils.cxx.

                                                                                      {
     if(nExtraWords > ctpRes.numberOfAdditionalWords()) {
       CTPdataformatVersion ctpDataFormat(ctpRes.ctpVersionNumber());
       std::vector<uint32_t> words = ctpRes.dataWords();
       words.resize(ctpRes.dataWords().size()+nExtraWords-ctpRes.numberOfAdditionalWords());
       ctpRes.setDataWords(words);
     }
     static const SG::AuxElement::Accessor< uint32_t > acc("numberOfAdditionalWords");
     acc(ctpRes) = nExtraWords;
   }

◆ setNumberOfBunches()

void CTPResultUtils::setNumberOfBunches	(	xAOD::CTPResult &	ctpRes,
		const uint32_t	nBCs
	)

Set the number of bunch crossings.

Parameters

nBCs	Number of bunch crossings.

Definition at line 84 of file CTPResultUtils.cxx.

                                                                       {
     if(nBCs > ctpRes.numberOfBunches()) {
       static const SG::AuxElement::Accessor< uint32_t > acc("numberOfBunches");
       acc(ctpRes) = nBCs;
       CTPdataformatVersion ctpDataFormat(ctpRes.ctpVersionNumber());
       std::vector<uint32_t> words = ctpRes.dataWords();
       words.resize(ctpDataFormat.getNumberTimeWords()+(nBCs*ctpDataFormat.getDAQwordsPerBunch())+ctpRes.numberOfAdditionalWords());
       ctpRes.setDataWords(words);
     }
   }

◆ setTimeNanoSec()

void CTPResultUtils::setTimeNanoSec	(	xAOD::CTPResult &	ctpRes,
		const uint32_t	nano
	)

Set the time in nanoseconds.

Parameters

nano	Time in nanoseconds.

Definition at line 74 of file CTPResultUtils.cxx.

                                                                   {
     CTPdataformatVersion ctpDataFormat(ctpRes.ctpVersionNumber());
     std::vector<uint32_t> words = ctpRes.dataWords();
     if(ctpDataFormat.getTimeNanosecondsPos() < words.size()) {
       words[ctpDataFormat.getTimeNanosecondsPos()] = ((nano/ctpDataFormat.getTimeNanosecondsTicks()) << ctpDataFormat.getTimeNanosecondsOffset());
       ctpRes.setDataWords(words);
     }
   }

◆ setTimeSec()

void CTPResultUtils::setTimeSec	(	xAOD::CTPResult &	ctpRes,
		const uint32_t	sec
	)

Set the time in seconds.

Parameters

sec	Time in seconds.

Definition at line 55 of file CTPResultUtils.cxx.

                                                              {
     CTPdataformatVersion ctpDataFormat(ctpRes.ctpVersionNumber());
     std::vector<uint32_t> words = ctpRes.dataWords();
     if (ctpDataFormat.getTimeSecondsPos() < words.size()) {
       words[ctpDataFormat.getTimeSecondsPos()] = sec;
       ctpRes.setDataWords(words);
     }
   }

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ WordType

Function Documentation

◆ getExtraWords()

◆ getTAPWords()

◆ getTAVWords()

◆ getTBPWords()

◆ getTimeNanoSec()

◆ getTimeSec()

◆ getTimeSinceLastL1A()

◆ getTIPWords()

◆ getWords()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ setNumberOfAdditionalWords()

◆ setNumberOfBunches()

◆ setTimeNanoSec()

◆ setTimeSec()