sistrip::FEDBSChannelUnpacker Class Reference

#include <SiStripFEDBuffer.h>

Public Member Functions
uint16_t	adc () const
	FEDBSChannelUnpacker ()
bool	hasData () const
FEDBSChannelUnpacker &	operator++ ()
FEDBSChannelUnpacker &	operator++ (int)
uint8_t	sampleNumber () const

Static Public Member Functions
static FEDBSChannelUnpacker	virginRawModeUnpacker (const FEDChannel &channel, uint16_t num_bits)
static FEDBSChannelUnpacker	zeroSuppressedLiteModeUnpacker (const FEDChannel &channel, uint16_t num_bits)
static FEDBSChannelUnpacker	zeroSuppressedModeUnpacker (const FEDChannel &channel, uint16_t num_bits)

Private Member Functions
	FEDBSChannelUnpacker (const uint8_t *payload, const uint16_t channelPayloadOffset, const int16_t channelPayloadLength, const uint16_t offsetIncrement, bool useZS)
void	readNewClusterInfo ()

Static Private Member Functions
static void	throwBadChannelLength (const uint16_t length)
static void	throwBadWordLength (const uint16_t word_length)
static void	throwUnorderedData (const uint8_t currentStrip, const uint8_t firstStripOfNewCluster)

Private Attributes
uint16_t	bitOffsetIncrement_
uint16_t	channelPayloadLength_
uint16_t	channelPayloadOffset_
uint16_t	currentLocalBitOffset_
uint8_t	currentStrip_
uint16_t	currentWordOffset_
const uint8_t *	data_
uint16_t	oldWordOffset_
bool	useZS_
uint8_t	valuesLeftInCluster_

Detailed Description

Definition at line 147 of file SiStripFEDBuffer.h.

Constructor & Destructor Documentation

sistrip::FEDBSChannelUnpacker::FEDBSChannelUnpacker ( )

inline

Definition at line 211 of file SiStripFEDBuffer.h.

      : data_(nullptr),
        oldWordOffset_(0),
        currentWordOffset_(0),
        currentLocalBitOffset_(0),
        bitOffsetIncrement_(10),
        currentStrip_(0),
        channelPayloadOffset_(0),
        channelPayloadLength_(0),
        useZS_(false),
        valuesLeftInCluster_(0) {}

sistrip::FEDBSChannelUnpacker::FEDBSChannelUnpacker ( const uint8_t *  payload, const uint16_t  channelPayloadOffset, const int16_t  channelPayloadLength, const uint16_t  offsetIncrement, bool  useZS  )

inlineprivate

Definition at line 223 of file SiStripFEDBuffer.h.

References bitOffsetIncrement_, channelPayloadLength_, readNewClusterInfo(), throwBadWordLength(), and useZS_.

      : data_(payload),
        oldWordOffset_(0),
        currentWordOffset_(channelPayloadOffset),
        currentLocalBitOffset_(0),
        bitOffsetIncrement_(offsetIncrement),
        currentStrip_(0),
        channelPayloadOffset_(channelPayloadOffset),
        channelPayloadLength_(channelPayloadLength),
        useZS_(useZS),
        valuesLeftInCluster_(0) {
    if (bitOffsetIncrement_ > 16)
      throwBadWordLength(bitOffsetIncrement_);  // more than 2 words... still to be implemented
    if (useZS_ && channelPayloadLength_)
      readNewClusterInfo();
  }

Member Function Documentation

uint16_t sistrip::FEDBSChannelUnpacker::adc ( ) const

inline

Definition at line 275 of file SiStripFEDBuffer.h.

References bitOffsetIncrement_, sistrip::BITS_PER_BYTE, currentLocalBitOffset_, currentWordOffset_, data_, and oldWordOffset_.

Referenced by sistrip::RawToDigiUnpacker::createDigis().

                                                  {
    uint16_t bits_missing = (bitOffsetIncrement_ - BITS_PER_BYTE) + currentLocalBitOffset_;
    uint16_t adc = (data_[currentWordOffset_ ^ 7] << bits_missing);
    if (currentWordOffset_ > oldWordOffset_) {
      adc += ((data_[(currentWordOffset_ + 1) ^ 7] >> (BITS_PER_BYTE - bits_missing)));
    }
    return (adc & ((1 << bitOffsetIncrement_) - 1));
  }

bool sistrip::FEDBSChannelUnpacker::hasData ( ) const

inline

Definition at line 284 of file SiStripFEDBuffer.h.

References bitOffsetIncrement_, sistrip::BITS_PER_BYTE, channelPayloadLength_, channelPayloadOffset_, currentLocalBitOffset_, and currentWordOffset_.

Referenced by sistrip::RawToDigiUnpacker::createDigis(), and operator++().

                                                  {
    const uint16_t nextChanWordOffset = channelPayloadOffset_ + channelPayloadLength_;
    if (currentWordOffset_ + 1 < nextChanWordOffset) {
      return true;  // fast case: 2 bytes always fit an ADC (even if offset)
    } else {        // close to end
      const uint16_t plusOneBitOffset = currentLocalBitOffset_ + bitOffsetIncrement_;
      const uint16_t plusOneWordOffset = currentWordOffset_ + plusOneBitOffset / BITS_PER_BYTE;
      return (plusOneBitOffset % BITS_PER_BYTE) ? (plusOneWordOffset < nextChanWordOffset)
                                                : (plusOneWordOffset <= nextChanWordOffset);
    }
  }

FEDBSChannelUnpacker & sistrip::FEDBSChannelUnpacker::operator++ ( void  )

inline

Definition at line 296 of file SiStripFEDBuffer.h.

References bitOffsetIncrement_, sistrip::BITS_PER_BYTE, currentLocalBitOffset_, currentStrip_, currentWordOffset_, hasData(), oldWordOffset_, readNewClusterInfo(), throwUnorderedData(), useZS_, and valuesLeftInCluster_.

                                                                {
    oldWordOffset_ = currentWordOffset_;
    currentLocalBitOffset_ += bitOffsetIncrement_;
    while (currentLocalBitOffset_ >= BITS_PER_BYTE) {
      currentWordOffset_++;
      currentLocalBitOffset_ -= BITS_PER_BYTE;
    }
    if (useZS_) {
      if (valuesLeftInCluster_) {
        currentStrip_++;
        valuesLeftInCluster_--;
      } else {
        if (hasData()) {
          const uint8_t oldStrip = currentStrip_;
          readNewClusterInfo();
          if (!(currentStrip_ > oldStrip))
            throwUnorderedData(oldStrip, currentStrip_);
        }
      }
    } else {
      currentStrip_++;
    }
    return (*this);
  }

FEDBSChannelUnpacker & sistrip::FEDBSChannelUnpacker::operator++ ( int  )

inline

Definition at line 321 of file SiStripFEDBuffer.h.

                                                                   {
    ++(*this);
    return *this;
  }

void sistrip::FEDBSChannelUnpacker::readNewClusterInfo ( )

inlineprivate

Definition at line 326 of file SiStripFEDBuffer.h.

References currentLocalBitOffset_, currentStrip_, currentWordOffset_, data_, and valuesLeftInCluster_.

Referenced by FEDBSChannelUnpacker(), and operator++().

                                                       {
    if (currentLocalBitOffset_) {
      ++currentWordOffset_;
      currentLocalBitOffset_ = 0;
    }
    currentStrip_ = data_[(currentWordOffset_++) ^ 7];
    valuesLeftInCluster_ = data_[(currentWordOffset_++) ^ 7] - 1;
  }

uint8_t sistrip::FEDBSChannelUnpacker::sampleNumber ( ) const

inline

Definition at line 273 of file SiStripFEDBuffer.h.

References currentStrip_.

Referenced by sistrip::RawToDigiUnpacker::createDigis().

{ return currentStrip_; }

void sistrip::FEDBSChannelUnpacker::throwBadChannelLength ( const uint16_t  length )

staticprivate

Definition at line 435 of file SiStripFEDBuffer.cc.

References Exception, and contentValuesCheck::ss.

Referenced by virginRawModeUnpacker(), zeroSuppressedLiteModeUnpacker(), and zeroSuppressedModeUnpacker().

                                                                        {
    std::ostringstream ss;
    ss << "Channel length is invalid. "
       << "Channel length is " << uint16_t(length) << "." << std::endl;
    throw cms::Exception("FEDBuffer") << ss.str();
  }

void sistrip::FEDBSChannelUnpacker::throwBadWordLength ( const uint16_t  word_length )

staticprivate

Definition at line 442 of file SiStripFEDBuffer.cc.

References Exception, and contentValuesCheck::ss.

Referenced by FEDBSChannelUnpacker(), and virginRawModeUnpacker().

                                                                          {
    std::ostringstream ss;
    ss << "Word length is invalid. "
       << "Word length is " << word_length << "." << std::endl;
    throw cms::Exception("FEDBuffer") << ss.str();
  }

void sistrip::FEDBSChannelUnpacker::throwUnorderedData ( const uint8_t  currentStrip, const uint8_t  firstStripOfNewCluster  )

staticprivate

Definition at line 449 of file SiStripFEDBuffer.cc.

References Exception, and contentValuesCheck::ss.

Referenced by operator++().

                                                                                                                {
    std::ostringstream ss;
    ss << "First strip of new cluster is not greater than last strip of previous cluster. "
       << "Last strip of previous cluster is " << uint16_t(currentStrip) << ". "
       << "First strip of new cluster is " << uint16_t(firstStripOfNewCluster) << "." << std::endl;
    throw cms::Exception("FEDBuffer") << ss.str();
  }

FEDBSChannelUnpacker sistrip::FEDBSChannelUnpacker::virginRawModeUnpacker ( const FEDChannel &  channel, uint16_t  num_bits  )

inlinestatic

Definition at line 244 of file SiStripFEDBuffer.h.

References sistrip::FEDChannel::data(), sistrip::FEDChannel::length(), sistrip::FEDChannel::offset(), mps_fire::result, throwBadChannelLength(), and throwBadWordLength().

Referenced by sistrip::RawToDigiUnpacker::createDigis(), and SiStripClusterizerFromRaw::run().

                                                                                             {
    uint16_t length = channel.length();
    if (length & 0xF000)
      throwBadChannelLength(length);
    if (num_bits <= 0 or num_bits > 16)
      throwBadWordLength(num_bits);
    FEDBSChannelUnpacker result(channel.data(), channel.offset() + 3, length - 3, num_bits, false);
    return result;
  }

FEDBSChannelUnpacker sistrip::FEDBSChannelUnpacker::zeroSuppressedLiteModeUnpacker ( const FEDChannel &  channel, uint16_t  num_bits  )

inlinestatic

Definition at line 264 of file SiStripFEDBuffer.h.

References sistrip::FEDChannel::data(), sistrip::FEDChannel::length(), sistrip::FEDChannel::offset(), mps_fire::result, and throwBadChannelLength().

Referenced by sistrip::RawToDigiUnpacker::createDigis().

                                                                                                      {
    uint16_t length = channel.length();
    if (length & 0xF000)
      throwBadChannelLength(length);
    FEDBSChannelUnpacker result(channel.data(), channel.offset() + 2, length - 2, num_bits, true);
    return result;
  }

FEDBSChannelUnpacker sistrip::FEDBSChannelUnpacker::zeroSuppressedModeUnpacker ( const FEDChannel &  channel, uint16_t  num_bits  )

inlinestatic

Definition at line 255 of file SiStripFEDBuffer.h.

References sistrip::FEDChannel::data(), sistrip::FEDChannel::length(), sistrip::FEDChannel::offset(), mps_fire::result, and throwBadChannelLength().

Referenced by sistrip::RawToDigiUnpacker::createDigis().

                                                                                                  {
    uint16_t length = channel.length();
    if (length & 0xF000)
      throwBadChannelLength(length);
    FEDBSChannelUnpacker result(channel.data(), channel.offset() + 7, length - 7, num_bits, true);
    return result;
  }

Member Data Documentation

uint16_t sistrip::FEDBSChannelUnpacker::bitOffsetIncrement_

private

Definition at line 174 of file SiStripFEDBuffer.h.

Referenced by adc(), FEDBSChannelUnpacker(), hasData(), and operator++().

uint16_t sistrip::FEDBSChannelUnpacker::channelPayloadLength_

private

Definition at line 177 of file SiStripFEDBuffer.h.

Referenced by FEDBSChannelUnpacker(), and hasData().

uint16_t sistrip::FEDBSChannelUnpacker::channelPayloadOffset_

private

Definition at line 176 of file SiStripFEDBuffer.h.

Referenced by hasData().

uint16_t sistrip::FEDBSChannelUnpacker::currentLocalBitOffset_

private

Definition at line 173 of file SiStripFEDBuffer.h.

Referenced by adc(), hasData(), operator++(), and readNewClusterInfo().

uint8_t sistrip::FEDBSChannelUnpacker::currentStrip_

private

Definition at line 175 of file SiStripFEDBuffer.h.

Referenced by operator++(), readNewClusterInfo(), and sampleNumber().

uint16_t sistrip::FEDBSChannelUnpacker::currentWordOffset_

private

Definition at line 172 of file SiStripFEDBuffer.h.

Referenced by adc(), hasData(), operator++(), and readNewClusterInfo().

const uint8_t* sistrip::FEDBSChannelUnpacker::data_

private

Definition at line 170 of file SiStripFEDBuffer.h.

Referenced by adc(), and readNewClusterInfo().

uint16_t sistrip::FEDBSChannelUnpacker::oldWordOffset_

private

Definition at line 171 of file SiStripFEDBuffer.h.

Referenced by adc(), and operator++().

bool sistrip::FEDBSChannelUnpacker::useZS_

private

Definition at line 178 of file SiStripFEDBuffer.h.

Referenced by FEDBSChannelUnpacker(), and operator++().

uint8_t sistrip::FEDBSChannelUnpacker::valuesLeftInCluster_

private

Definition at line 179 of file SiStripFEDBuffer.h.

Referenced by operator++(), and readNewClusterInfo().