TotemSampicFrame Class Reference

#include <TotemSampicFrame.h>

Public Member Functions
template<class T >
T	extractDataFromBytesLSB (const uint8_t *array, int start, int size) const
uint16_t	getBunchNumber () const
uint16_t	getCellInfo () const
uint16_t	getChannelMap () const
int	getDetChannel () const
int	getDetPlane () const
uint8_t	getEventHardwareId () const
uint32_t	getEventNumber () const
uint64_t	getFPGATimestamp () const
uint8_t	getFWVersion () const
uint8_t	getHardwareId () const
uint16_t	getL1ALatency () const
uint64_t	getL1ATimestamp () const
unsigned int	getNumberOfSamples () const
uint8_t	getNumberOfSentSamples () const
uint8_t	getOffsetOfSamples () const
uint32_t	getOrbitNumber () const
uint8_t	getPLLInfo () const
const std::vector< uint8_t >	getSamples () const
uint16_t	getTimestampA () const
uint16_t	getTimestampB () const
void	print () const
void	printRaw (bool binary=false) const
	TotemSampicFrame (const uint8_t *chInfoPtr, const uint8_t *chDataPtr, const uint8_t *eventInfoPtr)
bool	valid () const
	~TotemSampicFrame ()

Protected Member Functions
void	printRawBuffer (const uint16_t *buffer, const bool binary=false, const unsigned int size=12) const

Protected Attributes
int	status_
const uint8_t *	totemSampicDataPtr_
const uint8_t *	totemSampicEventInfoPtr_
const uint8_t *	totemSampicInfoPtr_

Detailed Description

This class is intended to handle the timing infromation of SAMPIC in the TOTEM implementation

Definition at line 80 of file TotemSampicFrame.h.

Constructor & Destructor Documentation

TotemSampicFrame::TotemSampicFrame ( const uint8_t *  chInfoPtr, const uint8_t *  chDataPtr, const uint8_t *  eventInfoPtr  )

inline

Definition at line 82 of file TotemSampicFrame.h.

References controlBits3, controlBits3_Position, status_, and totemSampicInfoPtr_.

      : totemSampicInfoPtr_(chInfoPtr),
        totemSampicDataPtr_(chDataPtr),
        totemSampicEventInfoPtr_(eventInfoPtr),
        status_(0) {
    if (chInfoPtr != nullptr && chDataPtr != nullptr && eventInfoPtr != nullptr &&
        totemSampicInfoPtr_[TotemSampicConstant::controlBits3_Position] == TotemSampicConstant::controlBits3)
      status_ = 1;
  }

TotemSampicFrame::~TotemSampicFrame ( )

inline

Definition at line 91 of file TotemSampicFrame.h.

{}

Member Function Documentation

template<class T >

T TotemSampicFrame::extractDataFromBytesLSB ( const uint8_t *  array, int  start, int  size  ) const

inline

Definition at line 136 of file TotemSampicFrame.h.

References mps_fire::i, mps_fire::result, and command_line::start.

                                                                             {
    T result = 0;
    for (int i = start + size - 1; i >= start; i--)
      result = (result << 8) | array[i];
    return result;
  }

uint16_t TotemSampicFrame::getBunchNumber ( ) const

inline

Definition at line 218 of file TotemSampicFrame.h.

References bunchNumber_Position, bunchNumber_Size, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                         {
    uint16_t tmp = 0;
    if (status_)
      tmp = extractDataFromBytesLSB<uint16_t>(
          totemSampicEventInfoPtr_, TotemSampicConstant::bunchNumber_Position, bunchNumber_Size);
    return tmp;
  }

uint16_t TotemSampicFrame::getCellInfo ( ) const

inline

Definition at line 168 of file TotemSampicFrame.h.

References cellInfo_Mask, cellInfo_Position, cellInfo_Size, status_, createJobs::tmp, and totemSampicInfoPtr_.

Referenced by print().

                                      {
    uint16_t tmp = 0;
    if (status_)
      tmp =
          extractDataFromBytesLSB<uint16_t>(totemSampicInfoPtr_, TotemSampicConstant::cellInfo_Position, cellInfo_Size);
    return tmp & TotemSampicConstant::cellInfo_Mask;
  }

uint16_t TotemSampicFrame::getChannelMap ( ) const

inline

Definition at line 242 of file TotemSampicFrame.h.

References channelMap_Position, channelMap_Size, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                        {
    uint16_t tmp = 0;
    if (status_)
      tmp = extractDataFromBytesLSB<uint16_t>(
          totemSampicEventInfoPtr_, TotemSampicConstant::channelMap_Position, channelMap_Size);
    return tmp;
  }

int TotemSampicFrame::getDetChannel ( ) const

inline

Definition at line 183 of file TotemSampicFrame.h.

References planeChannelId_Position, status_, createJobs::tmp, and totemSampicInfoPtr_.

Referenced by print().

                                   {
    int tmp = 0;
    if (status_)
      tmp = totemSampicInfoPtr_[planeChannelId_Position] & 0x0F;
    return tmp;
  }

int TotemSampicFrame::getDetPlane ( ) const

inline

Definition at line 176 of file TotemSampicFrame.h.

References planeChannelId_Position, status_, createJobs::tmp, and totemSampicInfoPtr_.

Referenced by print().

                                 {
    int tmp = 0;
    if (status_)
      tmp = (totemSampicInfoPtr_[planeChannelId_Position] & 0xF0) >> 4;
    return tmp;
  }

uint8_t TotemSampicFrame::getEventHardwareId ( ) const

inline

Definition at line 203 of file TotemSampicFrame.h.

References boardId_Position, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                            {
    uint8_t tmp = 0;
    if (status_)
      tmp = totemSampicEventInfoPtr_[TotemSampicConstant::boardId_Position];
    return tmp;
  }

uint32_t TotemSampicFrame::getEventNumber ( ) const

inline

Definition at line 234 of file TotemSampicFrame.h.

References eventNumber_Position, eventNumber_Size, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                         {
    uint32_t tmp = 0;
    if (status_)
      tmp = extractDataFromBytesLSB<uint32_t>(
          totemSampicEventInfoPtr_, TotemSampicConstant::eventNumber_Position, eventNumber_Size);
    return tmp;
  }

uint64_t TotemSampicFrame::getFPGATimestamp ( ) const

inline

Definition at line 143 of file TotemSampicFrame.h.

References fpgaTime_Position, fpgaTime_Size, status_, createJobs::tmp, and totemSampicInfoPtr_.

Referenced by print().

                                           {
    uint64_t tmp = 0;
    if (status_)
      tmp =
          extractDataFromBytesLSB<uint64_t>(totemSampicInfoPtr_, TotemSampicConstant::fpgaTime_Position, fpgaTime_Size);
    return tmp;
  }

uint8_t TotemSampicFrame::getFWVersion ( ) const

inline

Definition at line 279 of file TotemSampicFrame.h.

References fwVersion_Position, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                      {
    uint8_t tmp = 0;
    if (status_)
      tmp = totemSampicEventInfoPtr_[fwVersion_Position];
    return tmp;
  }

uint8_t TotemSampicFrame::getHardwareId ( ) const

inline

Definition at line 128 of file TotemSampicFrame.h.

References hwId_Position, status_, createJobs::tmp, and totemSampicInfoPtr_.

Referenced by print().

                                       {
    uint8_t tmp = 0;
    if (status_)
      tmp = totemSampicInfoPtr_[TotemSampicConstant::hwId_Position];
    return tmp;
  }

uint16_t TotemSampicFrame::getL1ALatency ( ) const

inline

Definition at line 250 of file TotemSampicFrame.h.

References l1ALatency_Position, l1ALatency_Size, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                        {
    uint16_t tmp = 0;
    if (status_)
      tmp = extractDataFromBytesLSB<uint16_t>(
          totemSampicEventInfoPtr_, TotemSampicConstant::l1ALatency_Position, l1ALatency_Size);
    return tmp;
  }

uint64_t TotemSampicFrame::getL1ATimestamp ( ) const

inline

Definition at line 210 of file TotemSampicFrame.h.

References l1ATimestamp_Position, l1ATimestamp_Size, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                          {
    uint64_t tmp = 0;
    if (status_)
      tmp = extractDataFromBytesLSB<uint64_t>(
          totemSampicEventInfoPtr_, TotemSampicConstant::l1ATimestamp_Position, l1ATimestamp_Size);
    return tmp;
  }

unsigned int TotemSampicFrame::getNumberOfSamples ( ) const

inline

Definition at line 200 of file TotemSampicFrame.h.

References numberOfSamples, and status_.

{ return status_ * TotemSampicConstant::numberOfSamples; }

uint8_t TotemSampicFrame::getNumberOfSentSamples ( ) const

inline

Definition at line 258 of file TotemSampicFrame.h.

References numberOfSamples_Position, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                                {
    uint8_t tmp = 0;
    if (status_)
      tmp = totemSampicEventInfoPtr_[TotemSampicConstant::numberOfSamples_Position];
    return tmp;
  }

uint8_t TotemSampicFrame::getOffsetOfSamples ( ) const

inline

Definition at line 265 of file TotemSampicFrame.h.

References offsetOfSamples_Position, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                            {
    uint8_t tmp = 0;
    if (status_)
      tmp = totemSampicEventInfoPtr_[TotemSampicConstant::offsetOfSamples_Position];
    return tmp;
  }

uint32_t TotemSampicFrame::getOrbitNumber ( ) const

inline

Definition at line 226 of file TotemSampicFrame.h.

References orbitNumber_Position, orbitNumber_Size, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                         {
    uint32_t tmp = 0;
    if (status_)
      tmp = extractDataFromBytesLSB<uint32_t>(
          totemSampicEventInfoPtr_, TotemSampicConstant::orbitNumber_Position, orbitNumber_Size);
    return tmp;
  }

uint8_t TotemSampicFrame::getPLLInfo ( ) const

inline

Definition at line 272 of file TotemSampicFrame.h.

References pllInfo_Position, status_, createJobs::tmp, and totemSampicEventInfoPtr_.

Referenced by print().

                                    {
    uint8_t tmp = 0;
    if (status_)
      tmp = totemSampicEventInfoPtr_[pllInfo_Position];
    return tmp;
  }

const std::vector<uint8_t> TotemSampicFrame::getSamples ( ) const

inline

Definition at line 190 of file TotemSampicFrame.h.

References numberOfSamples, status_, and totemSampicDataPtr_.

                                              {
    std::vector<uint8_t> samples;
    if (status_) {
      samples.assign(totemSampicDataPtr_, totemSampicDataPtr_ + TotemSampicConstant::numberOfSamples);
      for (auto it = samples.begin(); it != samples.end(); ++it)
        *it = grayToBinary<uint8_t>(*it);
    }
    return samples;
  }

uint16_t TotemSampicFrame::getTimestampA ( ) const

inline

Definition at line 151 of file TotemSampicFrame.h.

References status_, timestampA_Position, timestampA_Size, createJobs::tmp, and totemSampicInfoPtr_.

Referenced by print().

                                        {
    uint16_t tmp = 0;
    if (status_)
      tmp = extractDataFromBytesLSB<uint16_t>(
          totemSampicInfoPtr_, TotemSampicConstant::timestampA_Position, timestampA_Size);
    tmp = 0xFFF - tmp;
    return grayToBinary<uint16_t>(tmp);
  }

uint16_t TotemSampicFrame::getTimestampB ( ) const

inline

Definition at line 160 of file TotemSampicFrame.h.

References status_, timestampB_Position, timestampB_Size, createJobs::tmp, and totemSampicInfoPtr_.

Referenced by print().

                                        {
    uint16_t tmp = 0;
    if (status_)
      tmp = extractDataFromBytesLSB<uint16_t>(
          totemSampicInfoPtr_, TotemSampicConstant::timestampB_Position, timestampB_Size);
    return grayToBinary<uint16_t>(tmp);
  }

void TotemSampicFrame::print ( void  ) const

inline

Definition at line 106 of file TotemSampicFrame.h.

References TauDecayModes::dec, getBunchNumber(), getCellInfo(), getChannelMap(), getDetChannel(), getDetPlane(), getEventHardwareId(), getEventNumber(), getFPGATimestamp(), getFWVersion(), getHardwareId(), getL1ALatency(), getL1ATimestamp(), getNumberOfSentSamples(), getOffsetOfSamples(), getOrbitNumber(), getPLLInfo(), getTimestampA(), and getTimestampB().

                     {
    std::bitset<16> bitsChannelMap(getChannelMap());
    std::bitset<16> bitsPLLInfo(getPLLInfo());
    edm::LogInfo("TotemSampicFrame") << "\nEvent:"
                                     << "\nHardwareId (Event):\t" << std::hex << (unsigned int)getEventHardwareId()
                                     << "\nL1A Timestamp:\t" << std::dec << getL1ATimestamp() << "\nL1A Latency:\t"
                                     << std::dec << getL1ALatency() << "\nBunch Number:\t" << std::dec
                                     << getBunchNumber() << "\nOrbit Number:\t" << std::dec << getOrbitNumber()
                                     << "\nEvent Number:\t" << std::dec << getEventNumber() << "\nChannels fired:\t"
                                     << std::hex << bitsChannelMap.to_string() << "\nNumber of Samples:\t" << std::dec
                                     << getNumberOfSentSamples() << "\nOffset of Samples:\t" << std::dec
                                     << (int)getOffsetOfSamples() << "\nFW Version:\t" << std::hex
                                     << (int)getFWVersion() << "\nChannel:\nHardwareId:\t" << std::hex
                                     << (unsigned int)getHardwareId() << "\nFPGATimestamp:\t" << std::dec
                                     << getFPGATimestamp() << "\nTimestampA:\t" << std::dec << getTimestampA()
                                     << "\nTimestampB:\t" << std::dec << getTimestampB() << "\nCellInfo:\t" << std::dec
                                     << getCellInfo() << "\nPlane:\t" << std::dec << getDetPlane() << "\nChannel:\t"
                                     << std::dec << getDetChannel() << "\nPLL Info:\t" << bitsPLLInfo.to_string()
                                     << "\n\n";
  }

void TotemSampicFrame::printRaw ( bool  binary = false ) const

inline

Prints the frame. If binary is true, binary format is used.

Definition at line 95 of file TotemSampicFrame.h.

References printRawBuffer(), totemSampicDataPtr_, totemSampicEventInfoPtr_, and totemSampicInfoPtr_.

                                           {
    edm::LogInfo("TotemSampicFrame") << "Event Info: \n";
    printRawBuffer((uint16_t*)totemSampicEventInfoPtr_);

    edm::LogInfo("TotemSampicFrame") << "Channel Info: \n";
    printRawBuffer((uint16_t*)totemSampicInfoPtr_);

    edm::LogInfo("TotemSampicFrame") << "Channel Data: \n";
    printRawBuffer((uint16_t*)totemSampicDataPtr_);
  }

void TotemSampicFrame::printRawBuffer ( const uint16_t *  buffer, const bool  binary = false, const unsigned int  size = 12  ) const

inlineprotected

Definition at line 295 of file TotemSampicFrame.h.

References mps_fire::i, and findQualityFiles::size.

Referenced by printRaw().

                                                                                                                    {
    for (unsigned int i = 0; i < size; i++) {
      if (binary) {
        std::bitset<16> bits(*(buffer++));
        edm::LogInfo("TotemSampicFrame") << bits.to_string() << "\n";
      } else
        edm::LogInfo("TotemSampicFrame") << std::setfill('0') << std::setw(4) << std::hex << *(buffer++) << "\n";
    }
  }

bool TotemSampicFrame::valid ( ) const

inline

Definition at line 286 of file TotemSampicFrame.h.

References status_.

{ return status_ != 0; }

Member Data Documentation

int TotemSampicFrame::status_

protected

Definition at line 293 of file TotemSampicFrame.h.

Referenced by getBunchNumber(), getCellInfo(), getChannelMap(), getDetChannel(), getDetPlane(), getEventHardwareId(), getEventNumber(), getFPGATimestamp(), getFWVersion(), getHardwareId(), getL1ALatency(), getL1ATimestamp(), getNumberOfSamples(), getNumberOfSentSamples(), getOffsetOfSamples(), getOrbitNumber(), getPLLInfo(), getSamples(), getTimestampA(), getTimestampB(), TotemSampicFrame(), and valid().

const uint8_t* TotemSampicFrame::totemSampicDataPtr_

protected

Definition at line 290 of file TotemSampicFrame.h.

Referenced by getSamples(), and printRaw().

const uint8_t* TotemSampicFrame::totemSampicEventInfoPtr_

protected

Definition at line 291 of file TotemSampicFrame.h.

Referenced by getBunchNumber(), getChannelMap(), getEventHardwareId(), getEventNumber(), getFWVersion(), getL1ALatency(), getL1ATimestamp(), getNumberOfSentSamples(), getOffsetOfSamples(), getOrbitNumber(), getPLLInfo(), and printRaw().

const uint8_t* TotemSampicFrame::totemSampicInfoPtr_

protected

Definition at line 289 of file TotemSampicFrame.h.

Referenced by getCellInfo(), getDetChannel(), getDetPlane(), getFPGATimestamp(), getHardwareId(), getTimestampA(), getTimestampB(), printRaw(), and TotemSampicFrame().