MuCTPI_RDO Class Reference

Class representing the readout data of the MuCTPI hardware and simulation. More...

#include <MuCTPI_RDO.h>

Collaboration diagram for MuCTPI_RDO:

Public Types
enum	SectorLocation { BARREL = 0, ENDCAP = 1, FORWARD = 2 }
	Enumeration defining the different sources for the muon candidates. More...

Public Member Functions
	MuCTPI_RDO (const uint32_t candidateMultiplicity, std::vector< uint32_t > &&dataWord)
	"Intermediate" constructor More...
	MuCTPI_RDO (std::vector< uint32_t > &&candidateMultiplicity, std::vector< uint32_t > &&dataWord)
	Full constructor. More...
	MuCTPI_RDO ()=default
	Default constructor. More...
	~MuCTPI_RDO ()=default
	Destructor. More...
void	setCandidateMultiplicity (const uint32_t candidateMultiplicity)
	Function adding a multiplicity word to the object. More...
uint32_t	candidateMultiplicity () const
	Function returning the candidate multiplicity for the triggered bunch crossing. More...
const std::vector< uint32_t > &	getAllCandidateMultiplicities () const
	Function returning all candidate multiplicities. More...
void	setDataWord (const uint32_t dataWord)
	Function adding a data word to the object. More...
const std::vector< uint32_t > &	dataWord () const
	Function returning the muon candidate data words. More...

Private Attributes
std::vector< uint32_t >	m_candidateMultiplicity
	Variable storing the multiplicity word(s) sent to the CTP. More...
std::vector< uint32_t >	m_dataWord
	Variable storing the muon data words read out. More...

Detailed Description

Class representing the readout data of the MuCTPI hardware and simulation.

Date

2007-07-05 13:26:22

   The MuCTPI hardware and the simulation can send all the muon candidates
   recevied in a maximal window spanning +-2 BCs around the triggered BC 
   (giving a window of maximally 5 BCs) together with the muon multiplicities
   in the same window to the readout system. This class represents the ROD
   fragment generated by the MuCTPI to Athena.

   For a detailed description of the data format of the MuCTPI, see
   the MIROD documentation (https://edms.cern.ch/file/248757/1/mirod.pdf).

See also

LVL1MUCTPI::L1Muctpi

MuCTPIByteStreamCnv

Author

Tadashi Maeno tmaen.nosp@m.o@bn.nosp@m.l.gov

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

David Berge David.nosp@m..Ber.nosp@m.ge@ce.nosp@m.rn.c.nosp@m.h

Version

Revision

1.9

Definition at line 41 of file MuCTPI_RDO.h.

Member Enumeration Documentation

SectorLocation

enum MuCTPI_RDO::SectorLocation

Enumeration defining the different sources for the muon candidates.

Enumerator
BARREL
ENDCAP
FORWARD

Definition at line 45 of file MuCTPI_RDO.h.

{ BARREL = 0, ENDCAP = 1, FORWARD = 2 };

Constructor & Destructor Documentation

MuCTPI_RDO() [1/3]

MuCTPI_RDO::MuCTPI_RDO ( const uint32_t  candidateMultiplicity, std::vector< uint32_t > &&  dataWord  )

inline

"Intermediate" constructor

This constructor is tipically used for filling the object with information about muon candidates from one bunch crossing.

Parameters

candidateMultiplicity	The multiplicity word with the 6 separate 3-bit muon multiplicities
dataWord	The muon candidate data words

Definition at line 56 of file MuCTPI_RDO.h.

    : m_dataWord( std::move(dataWord) ) {
    setCandidateMultiplicity( candidateMultiplicity );
  }

MuCTPI_RDO() [2/3]

MuCTPI_RDO::MuCTPI_RDO ( std::vector< uint32_t > &&  candidateMultiplicity, std::vector< uint32_t > &&  dataWord  )

inline

Full constructor.

This constructor can be used to fill the object with the multiplicity and data words from an up to +-5 buch crossing wide window.

Parameters

candidateMultiplicity	The multiplicity words with the 6 separate 3-bit muon multiplicities
dataWord	The muon candidate data words

Definition at line 70 of file MuCTPI_RDO.h.

    : m_candidateMultiplicity( std::move(candidateMultiplicity) ),
      m_dataWord( std::move(dataWord) ) {
  }

MuCTPI_RDO() [3/3]

MuCTPI_RDO::MuCTPI_RDO ( )

default

Default constructor.

A parameter-less constructor to be able to use the class with POOL.

~MuCTPI_RDO()

MuCTPI_RDO::~MuCTPI_RDO ( )

default

Destructor.

The destructor doesn't really have to do anything.

Member Function Documentation

candidateMultiplicity()

uint32_t MuCTPI_RDO::candidateMultiplicity ( ) const

inline

Function returning the candidate multiplicity for the triggered bunch crossing.

In case of reading out multiple BCs, the one that is considered to have triggered the event is always the "center" one. (In principle you can only read out 1, 3 or 5 BCs, not 2 or 4!) This function takes care of returning this one word.

Returns

The "central" multiplicity word

Definition at line 106 of file MuCTPI_RDO.h.

                                         {
    if( m_candidateMultiplicity.size() == 0 ) return 0;
    else return m_candidateMultiplicity[ ( m_candidateMultiplicity.size() - 1 ) / 2 ];
  }

dataWord()

const std::vector< uint32_t >& MuCTPI_RDO::dataWord ( ) const

inline

Function returning the muon candidate data words.

The muon candidate data words returned by this function are very similar to the muon RoI words, but they contain a bit more information. This is the last 3 bits of the BCID in which they were created, which is important to be able to separate the muon candidates from the different bunch crossings.

Returns

A vector of all the muon candidate data words

Definition at line 141 of file MuCTPI_RDO.h.

                                                {
    return m_dataWord;
  }

getAllCandidateMultiplicities()

const std::vector< uint32_t >& MuCTPI_RDO::getAllCandidateMultiplicities ( ) const

inline

Function returning all candidate multiplicities.

This function can be used to retrieve the candidate multiplicities from all the saved bunch crossings.

Returns

A vector of all the candidate multiplicity words

Definition at line 117 of file MuCTPI_RDO.h.

                                                                     {
    return m_candidateMultiplicity;
  }

setCandidateMultiplicity()

void MuCTPI_RDO::setCandidateMultiplicity ( const uint32_t  candidateMultiplicity )

inline

Function adding a multiplicity word to the object.

Be careful, that contrary to its name, this function doesn't reset the multiplicity word list, it only adds the specified word to the end of the list.

Parameters

candidateMultiplicity

The multiplicity word to be added to the object

Definition at line 95 of file MuCTPI_RDO.h.

                                                                        {
    m_candidateMultiplicity.push_back(candidateMultiplicity);
  }

setDataWord()

void MuCTPI_RDO::setDataWord ( const uint32_t  dataWord )

inline

Function adding a data word to the object.

Just like with MuCTPI_RDO::setCandidateMultiplicity, be careful that this function also only adds the specified data word to the list of stored data words, it doesn't reset the list.

Parameters

dataWord

The 32-bit data word to be added to the object

Definition at line 129 of file MuCTPI_RDO.h.

                                              {
    m_dataWord.push_back( dataWord );
  }

Member Data Documentation

m_candidateMultiplicity

std::vector< uint32_t > MuCTPI_RDO::m_candidateMultiplicity

private

Variable storing the multiplicity word(s) sent to the CTP.

Definition at line 148 of file MuCTPI_RDO.h.

m_dataWord

std::vector< uint32_t > MuCTPI_RDO::m_dataWord

private

Variable storing the muon data words read out.

Definition at line 150 of file MuCTPI_RDO.h.

---

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

• MuCTPI_RDO.h