TotemSampicFrame Class Reference

#include <TotemSampicFrame.h>

Public Member Functions
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 69 of file TotemSampicFrame.h.

Constructor & Destructor Documentation

TotemSampicFrame()

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

inline

Definition at line 71 of file TotemSampicFrame.h.

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

References controlBits3, controlBits3_Position, status_, and totemSampicInfoPtr_.

~TotemSampicFrame()

TotemSampicFrame::~TotemSampicFrame ( )

inline

Definition at line 80 of file TotemSampicFrame.h.

{}

Member Function Documentation

getBunchNumber()

uint16_t TotemSampicFrame::getBunchNumber ( ) const

inline

Definition at line 198 of file TotemSampicFrame.h.

                                         {
    uint16_t tmp = 0;
    if (status_)
      tmp = *((const uint16_t*)(totemSampicEventInfoPtr_ + TotemSampicConstant::bunchNumber_Position));
    return tmp;

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

Referenced by print().

getCellInfo()

uint16_t TotemSampicFrame::getCellInfo ( ) const

inline

Definition at line 149 of file TotemSampicFrame.h.

                                      {
    uint16_t tmp = 0;
    if (status_)
      tmp = *((const uint16_t*)(totemSampicInfoPtr_ + TotemSampicConstant::cellInfo_Position));
    return tmp & TotemSampicConstant::cellInfo_Mask;

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

Referenced by print().

getChannelMap()

uint16_t TotemSampicFrame::getChannelMap ( ) const

inline

Definition at line 219 of file TotemSampicFrame.h.

                                        {
    uint16_t tmp = 0;
    if (status_)
      tmp = *((const uint16_t*)(totemSampicEventInfoPtr_ + TotemSampicConstant::channelMap_Position));
    return tmp;

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

Referenced by print().

getDetChannel()

int TotemSampicFrame::getDetChannel ( ) const

inline

Definition at line 163 of file TotemSampicFrame.h.

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

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

Referenced by print().

getDetPlane()

int TotemSampicFrame::getDetPlane ( ) const

inline

Definition at line 156 of file TotemSampicFrame.h.

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

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

Referenced by print().

getEventHardwareId()

uint8_t TotemSampicFrame::getEventHardwareId ( ) const

inline

Definition at line 183 of file TotemSampicFrame.h.

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

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

Referenced by print().

getEventNumber()

uint32_t TotemSampicFrame::getEventNumber ( ) const

inline

Definition at line 212 of file TotemSampicFrame.h.

                                         {
    uint32_t tmp = 0;
    if (status_)
      tmp = *((const uint32_t*)(totemSampicEventInfoPtr_ + TotemSampicConstant::eventNumber_Position));
    return tmp;

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

Referenced by print().

getFPGATimestamp()

uint64_t TotemSampicFrame::getFPGATimestamp ( ) const

inline

Definition at line 124 of file TotemSampicFrame.h.

                                           {
    uint64_t tmp = 0;
    if (status_) {
      tmp = *((const uint64_t*)(totemSampicInfoPtr_ + TotemSampicConstant::fpgaTime_Position)) & 0xFFFFFFFFFF;
    }
    return tmp;

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

Referenced by print().

getFWVersion()

uint8_t TotemSampicFrame::getFWVersion ( ) const

inline

Definition at line 254 of file TotemSampicFrame.h.

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

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

Referenced by print().

getHardwareId()

uint8_t TotemSampicFrame::getHardwareId ( ) const

inline

Definition at line 117 of file TotemSampicFrame.h.

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

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

Referenced by print().

getL1ALatency()

uint16_t TotemSampicFrame::getL1ALatency ( ) const

inline

Definition at line 226 of file TotemSampicFrame.h.

                                        {
    uint16_t tmp = 0;
    if (status_)
      tmp = *((const uint16_t*)(totemSampicEventInfoPtr_ + TotemSampicConstant::l1ALatency_Position));
    return tmp;

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

Referenced by print().

getL1ATimestamp()

uint64_t TotemSampicFrame::getL1ATimestamp ( ) const

inline

Definition at line 190 of file TotemSampicFrame.h.

                                          {
    uint64_t tmp = 0;
    if (status_) {
      tmp = *((const uint64_t*)(totemSampicEventInfoPtr_ + TotemSampicConstant::l1ATimestamp_Position)) & 0xFFFFFFFFFF;
    }
    return tmp;

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

Referenced by print().

getNumberOfSamples()

unsigned int TotemSampicFrame::getNumberOfSamples ( ) const

inline

Definition at line 180 of file TotemSampicFrame.h.

{ return status_ * TotemSampicConstant::numberOfSamples; }

References numberOfSamples, and status_.

getNumberOfSentSamples()

uint8_t TotemSampicFrame::getNumberOfSentSamples ( ) const

inline

Definition at line 233 of file TotemSampicFrame.h.

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

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

Referenced by print().

getOffsetOfSamples()

uint8_t TotemSampicFrame::getOffsetOfSamples ( ) const

inline

Definition at line 240 of file TotemSampicFrame.h.

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

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

Referenced by print().

getOrbitNumber()

uint32_t TotemSampicFrame::getOrbitNumber ( ) const

inline

Definition at line 205 of file TotemSampicFrame.h.

                                         {
    uint32_t tmp = 0;
    if (status_)
      tmp = *((const uint32_t*)(totemSampicEventInfoPtr_ + TotemSampicConstant::orbitNumber_Position));
    return tmp;

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

Referenced by print().

getPLLInfo()

uint8_t TotemSampicFrame::getPLLInfo ( ) const

inline

Definition at line 247 of file TotemSampicFrame.h.

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

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

Referenced by print().

getSamples()

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

inline

Definition at line 170 of file TotemSampicFrame.h.

                                              {
    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;

References numberOfSamples, EgammaValidation_cff::samples, status_, and totemSampicDataPtr_.

getTimestampA()

uint16_t TotemSampicFrame::getTimestampA ( ) const

inline

Definition at line 132 of file TotemSampicFrame.h.

                                        {
    uint16_t tmp = 0;
    if (status_) {
      tmp = *((const uint16_t*)(totemSampicInfoPtr_ + TotemSampicConstant::timestampA_Position));
    }
    tmp = 0xFFF - tmp;
    return grayToBinary<uint16_t>(tmp);

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

Referenced by print().

getTimestampB()

uint16_t TotemSampicFrame::getTimestampB ( ) const

inline

Definition at line 141 of file TotemSampicFrame.h.

                                        {
    uint16_t tmp = 0;
    if (status_) {
      tmp = *((const uint16_t*)(totemSampicInfoPtr_ + TotemSampicConstant::timestampB_Position));
    }
    return grayToBinary<uint16_t>(tmp);

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

Referenced by print().

print()

void TotemSampicFrame::print ( void  ) const

inline

Definition at line 95 of file TotemSampicFrame.h.

                     {
    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";

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

printRaw()

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

inline

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

Definition at line 84 of file TotemSampicFrame.h.

                                           {
    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_);

printRawBuffer()

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

inlineprotected

Definition at line 270 of file TotemSampicFrame.h.

                                                                                                                    {
    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";
    }

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

valid()

bool TotemSampicFrame::valid ( ) const

inline

Definition at line 261 of file TotemSampicFrame.h.

{ return status_ != 0; }

References status_.

Member Data Documentation

status_

int TotemSampicFrame::status_

protected

Definition at line 268 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().

totemSampicDataPtr_

const uint8_t* TotemSampicFrame::totemSampicDataPtr_

protected

Definition at line 265 of file TotemSampicFrame.h.

Referenced by getSamples().

totemSampicEventInfoPtr_

const uint8_t* TotemSampicFrame::totemSampicEventInfoPtr_

protected

Definition at line 266 of file TotemSampicFrame.h.

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

totemSampicInfoPtr_

const uint8_t* TotemSampicFrame::totemSampicInfoPtr_

protected

Definition at line 264 of file TotemSampicFrame.h.

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