sistrip::FEDBufferPayloadCreator Class Reference

#include <SiStripFEDBufferGenerator.h>

Public Member Functions
FEDBufferPayload	createPayload (FEDReadoutMode mode, uint8_t packetCode, const FEDStripData &data) const
	FEDBufferPayloadCreator (const std::vector< bool > &enabledFEUnits, const std::vector< bool > &enabledChannels)
FEDBufferPayload	operator() (FEDReadoutMode mode, uint8_t packetCode, const FEDStripData &data) const

Private Member Functions
void	fillChannelBuffer (std::vector< uint8_t > *channelBuffer, FEDReadoutMode mode, uint8_t packetCode, const FEDStripData::ChannelData &data, const bool channelEnabled) const
void	fillClusterData (std::vector< uint8_t > *channelBuffer, uint8_t packetCode, const FEDStripData::ChannelData &data, const FEDReadoutMode mode) const
void	fillClusterDataPreMixMode (std::vector< uint8_t > *channelBuffer, const FEDStripData::ChannelData &data) const
void	fillPreMixRawChannelBuffer (std::vector< uint8_t > *channelBuffer, const FEDStripData::ChannelData &data, const bool channelEnabled) const
void	fillRawChannelBuffer (std::vector< uint8_t > *channelBuffer, const uint8_t packetCode, const FEDStripData::ChannelData &data, const bool channelEnabled, const bool reorderData) const
void	fillZeroSuppressedChannelBuffer (std::vector< uint8_t > *channelBuffer, const uint8_t packetCode, const FEDStripData::ChannelData &data, const bool channelEnabled) const
void	fillZeroSuppressedLiteChannelBuffer (std::vector< uint8_t > *channelBuffer, const FEDStripData::ChannelData &data, const bool channelEnabled, const FEDReadoutMode mode) const

Private Attributes
std::vector< bool >	channelsEnabled_
std::vector< bool >	feUnitsEnabled_

Detailed Description

Definition at line 81 of file SiStripFEDBufferGenerator.h.

Constructor & Destructor Documentation

FEDBufferPayloadCreator()

sistrip::FEDBufferPayloadCreator::FEDBufferPayloadCreator ( const std::vector< bool > &  enabledFEUnits, const std::vector< bool > &  enabledChannels  )

inline

Definition at line 290 of file SiStripFEDBufferGenerator.h.

      : feUnitsEnabled_(feUnitsEnabled), channelsEnabled_(channelsEnabled) {}

Member Function Documentation

createPayload()

FEDBufferPayload sistrip::FEDBufferPayloadCreator::createPayload	(	FEDReadoutMode	mode,
		uint8_t	packetCode,
		const FEDStripData &	data
	)		const

Definition at line 102 of file SiStripFEDBufferGenerator.cc.

References data, sistrip::FEDCH_PER_FED, sistrip::FEDCH_PER_FEUNIT, and ALCARECOPromptCalibProdSiPixelAli0T_cff::mode.

Referenced by operator()().

                                                                                          {
    std::vector<std::vector<uint8_t> > channelBuffers(FEDCH_PER_FED, std::vector<uint8_t>());
    for (size_t iCh = 0; iCh < FEDCH_PER_FED; iCh++) {
      if (!feUnitsEnabled_[iCh / FEDCH_PER_FEUNIT])
        continue;
      fillChannelBuffer(&channelBuffers[iCh], mode, packetCode, data.channel(iCh), channelsEnabled_[iCh]);
    }
    return FEDBufferPayload(channelBuffers);
  }

fillChannelBuffer()

void sistrip::FEDBufferPayloadCreator::fillChannelBuffer ( std::vector< uint8_t > *  channelBuffer, FEDReadoutMode  mode, uint8_t  packetCode, const FEDStripData::ChannelData &  data, const bool  channelEnabled  ) const

private

Definition at line 114 of file SiStripFEDBufferGenerator.cc.

References data, Exception, ALCARECOPromptCalibProdSiPixelAli0T_cff::mode, sistrip::PACKET_CODE_PROC_RAW, sistrip::PACKET_CODE_SCOPE, sistrip::PACKET_CODE_VIRGIN_RAW, sistrip::PACKET_CODE_VIRGIN_RAW10, sistrip::PACKET_CODE_VIRGIN_RAW8_BOTBOT, sistrip::PACKET_CODE_VIRGIN_RAW8_TOPBOT, sistrip::READOUT_MODE_PREMIX_RAW, sistrip::READOUT_MODE_PROC_RAW, sistrip::READOUT_MODE_SCOPE, sistrip::READOUT_MODE_VIRGIN_RAW, sistrip::READOUT_MODE_ZERO_SUPPRESSED, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE10, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE10_CMOVERRIDE, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT_CMOVERRIDE, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_CMOVERRIDE, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT_CMOVERRIDE, and contentValuesCheck::ss.

                                                                                   {
    switch (mode) {
      case READOUT_MODE_SCOPE:
        fillRawChannelBuffer(channelBuffer, PACKET_CODE_SCOPE, data, channelEnabled, false);
        break;
      case READOUT_MODE_VIRGIN_RAW:
        switch (packetCode) {
          case PACKET_CODE_VIRGIN_RAW:
            fillRawChannelBuffer(channelBuffer, PACKET_CODE_VIRGIN_RAW, data, channelEnabled, true);
            break;
          case PACKET_CODE_VIRGIN_RAW10:
            fillRawChannelBuffer(channelBuffer, PACKET_CODE_VIRGIN_RAW10, data, channelEnabled, true);
            break;
          case PACKET_CODE_VIRGIN_RAW8_BOTBOT:
            fillRawChannelBuffer(channelBuffer, PACKET_CODE_VIRGIN_RAW8_BOTBOT, data, channelEnabled, true);
            break;
          case PACKET_CODE_VIRGIN_RAW8_TOPBOT:
            fillRawChannelBuffer(channelBuffer, PACKET_CODE_VIRGIN_RAW8_TOPBOT, data, channelEnabled, true);
            break;
        }
        break;
      case READOUT_MODE_PROC_RAW:
        fillRawChannelBuffer(channelBuffer, PACKET_CODE_PROC_RAW, data, channelEnabled, false);
        break;
      case READOUT_MODE_ZERO_SUPPRESSED:
        //case READOUT_MODE_ZERO_SUPPRESSED_CMOVERRIDE:
        fillZeroSuppressedChannelBuffer(channelBuffer, packetCode, data, channelEnabled);
        break;
      case READOUT_MODE_ZERO_SUPPRESSED_LITE10:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE10_CMOVERRIDE:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_CMOVERRIDE:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT_CMOVERRIDE:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT_CMOVERRIDE:
        fillZeroSuppressedLiteChannelBuffer(channelBuffer, data, channelEnabled, mode);
        break;
      case READOUT_MODE_PREMIX_RAW:
        fillPreMixRawChannelBuffer(channelBuffer, data, channelEnabled);
        break;
      default:
        std::ostringstream ss;
        ss << "Invalid readout mode " << mode;
        throw cms::Exception("FEDBufferGenerator") << ss.str();
        break;
    }
  }

fillClusterData()

void sistrip::FEDBufferPayloadCreator::fillClusterData ( std::vector< uint8_t > *  channelBuffer, uint8_t  packetCode, const FEDStripData::ChannelData &  data, const FEDReadoutMode  mode  ) const

private

Definition at line 321 of file SiStripFEDBufferGenerator.cc.

References gpuClustering::adc, nano_mu_local_reco_cff::clusterSize, data, ALCARECOPromptCalibProdSiPixelAli0T_cff::mode, PresampleTask_cfi::nSamples, sistrip::PACKET_CODE_ZERO_SUPPRESSED, sistrip::PACKET_CODE_ZERO_SUPPRESSED10, sistrip::PACKET_CODE_ZERO_SUPPRESSED8_BOTBOT, sistrip::PACKET_CODE_ZERO_SUPPRESSED8_TOPBOT, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE10, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE10_CMOVERRIDE, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT_CMOVERRIDE, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT, sistrip::READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT_CMOVERRIDE, nano_mu_digi_cff::strip, and sistrip::STRIPS_PER_APV.

                                                                                 {
    // ZS lite: retrieve "packet code"
    switch (mode) {
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8:
        packetCode = PACKET_CODE_ZERO_SUPPRESSED;
        break;
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_TOPBOT_CMOVERRIDE:
        packetCode = PACKET_CODE_ZERO_SUPPRESSED8_TOPBOT;
        break;
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE8_BOTBOT_CMOVERRIDE:
        packetCode = PACKET_CODE_ZERO_SUPPRESSED8_BOTBOT;
        break;
      case READOUT_MODE_ZERO_SUPPRESSED_LITE10:
      case READOUT_MODE_ZERO_SUPPRESSED_LITE10_CMOVERRIDE:
        packetCode = PACKET_CODE_ZERO_SUPPRESSED10;
        break;
      default:;
    }
    const bool is10Bit = (packetCode == PACKET_CODE_ZERO_SUPPRESSED10);
    const uint16_t bShift = (packetCode == PACKET_CODE_ZERO_SUPPRESSED8_BOTBOT
                                 ? 2
                                 : (packetCode == PACKET_CODE_ZERO_SUPPRESSED8_TOPBOT ? 1 : 0));

    uint16_t clusterSize = 0;  // counter
    std::size_t size_pos = 0;  // index of cluster size
    uint16_t adc_pre = 0;
    const uint16_t nSamples = data.size();
    for (uint16_t strip = 0; strip < nSamples; ++strip) {
      const uint16_t adc = is10Bit ? data.get10BitSample(strip) : data.get8BitSample(strip, bShift);
      if (adc) {
        if (clusterSize == 0 || strip == STRIPS_PER_APV) {
          if (clusterSize) {
            if (is10Bit && (clusterSize % 4)) {
              channelBuffer->push_back(adc_pre);
            }
            (*channelBuffer)[size_pos] = clusterSize;
            clusterSize = 0;
          }
          // cluster header: first strip and size
          channelBuffer->push_back(strip);
          size_pos = channelBuffer->size();
          channelBuffer->push_back(0);  // for clustersize
        }
        if (!is10Bit) {
          channelBuffer->push_back(adc & 0xFF);
        } else {
          if (clusterSize % 4 == 0) {
            channelBuffer->push_back((adc & 0x3FC) >> 2);
            adc_pre = ((adc & 0x3) << 6);
          } else if (clusterSize % 4 == 1) {
            channelBuffer->push_back(adc_pre | ((adc & 0x3F0) >> 4));
            adc_pre = ((adc & 0xF) << 4);
          } else if (clusterSize % 4 == 2) {
            channelBuffer->push_back(adc_pre | ((adc & 0x3C0) >> 6));
            adc_pre = ((adc & 0x3F) << 2);
          } else if (clusterSize % 4 == 3) {
            channelBuffer->push_back(adc_pre | ((adc & 0x300) >> 8));
            channelBuffer->push_back(adc & 0xFF);
            adc_pre = 0;
          }
        }
        ++clusterSize;
      } else if (clusterSize) {
        if (is10Bit && (clusterSize % 4)) {
          channelBuffer->push_back(adc_pre);
        }
        (*channelBuffer)[size_pos] = clusterSize;
        clusterSize = 0;
      }
    }
    if (clusterSize) {
      (*channelBuffer)[size_pos] = clusterSize;
      if (is10Bit && (clusterSize % 4)) {
        channelBuffer->push_back(adc_pre);
      }
    }
  }

fillClusterDataPreMixMode()

void sistrip::FEDBufferPayloadCreator::fillClusterDataPreMixMode ( std::vector< uint8_t > *  channelBuffer, const FEDStripData::ChannelData &  data  ) const

private

Definition at line 404 of file SiStripFEDBufferGenerator.cc.

References gpuClustering::adc, nano_mu_local_reco_cff::clusterSize, data, PresampleTask_cfi::nSamples, nano_mu_digi_cff::strip, and sistrip::STRIPS_PER_APV.

                                                                                                     {
    uint16_t clusterSize = 0;
    const uint16_t nSamples = data.size();
    for (uint16_t strip = 0; strip < nSamples; ++strip) {
      const uint16_t adc = data.get10BitSample(strip);

      if (adc) {
        if (clusterSize == 0 || strip == STRIPS_PER_APV) {
          if (clusterSize) {
            *(channelBuffer->end() - 2 * clusterSize - 1) = clusterSize;
            clusterSize = 0;
          }
          channelBuffer->push_back(strip);
          channelBuffer->push_back(0);  //clustersize
        }
        channelBuffer->push_back(adc & 0xFF);
        channelBuffer->push_back((adc & 0x0300) >> 8);

        ++clusterSize;
      }

      else if (clusterSize) {
        *(channelBuffer->end() - 2 * clusterSize - 1) = clusterSize;
        clusterSize = 0;
      }
    }
    if (clusterSize) {
      *(channelBuffer->end() - 2 * clusterSize - 1) = clusterSize;
    }
  }

fillPreMixRawChannelBuffer()

void sistrip::FEDBufferPayloadCreator::fillPreMixRawChannelBuffer ( std::vector< uint8_t > *  channelBuffer, const FEDStripData::ChannelData &  data, const bool  channelEnabled  ) const

private

Definition at line 286 of file SiStripFEDBufferGenerator.cc.

References data, and sistrip::PACKET_CODE_ZERO_SUPPRESSED.

                                                                                            {
    channelBuffer->reserve(50);
    //if channel is disabled then create empty channel header and return
    if (!channelEnabled) {
      //min length 7
      channelBuffer->push_back(7);
      channelBuffer->push_back(0);
      //packet code
      channelBuffer->push_back(PACKET_CODE_ZERO_SUPPRESSED);
      //4 bytes of medians
      channelBuffer->insert(channelBuffer->end(), 4, 0);
      return;
    }
    //if channel is not empty
    //add space for channel length
    channelBuffer->push_back(0xFF);
    channelBuffer->push_back(0xFF);
    //packet code
    channelBuffer->push_back(PACKET_CODE_ZERO_SUPPRESSED);
    //add medians
    const std::pair<uint16_t, uint16_t> medians = data.getMedians();
    channelBuffer->push_back(medians.first & 0xFF);
    channelBuffer->push_back((medians.first & 0x300) >> 8);
    channelBuffer->push_back(medians.second & 0xFF);
    channelBuffer->push_back((medians.second & 0x300) >> 8);
    //clusters
    fillClusterDataPreMixMode(channelBuffer, data);
    //set length
    const uint16_t length = channelBuffer->size();
    (*channelBuffer)[0] = (length & 0xFF);
    (*channelBuffer)[1] = ((length & 0x300) >> 8);
  }

fillRawChannelBuffer()

void sistrip::FEDBufferPayloadCreator::fillRawChannelBuffer ( std::vector< uint8_t > *  channelBuffer, const uint8_t  packetCode, const FEDStripData::ChannelData &  data, const bool  channelEnabled, const bool  reorderData  ) const

private

Definition at line 167 of file SiStripFEDBufferGenerator.cc.

References reco::ceil(), data, PresampleTask_cfi::nSamples, sistrip::PACKET_CODE_VIRGIN_RAW, sistrip::PACKET_CODE_VIRGIN_RAW10, sistrip::PACKET_CODE_VIRGIN_RAW8_BOTBOT, sistrip::PACKET_CODE_VIRGIN_RAW8_TOPBOT, and sistrip::FEDStripOrdering::physicalOrderForStripInChannel().

                                                                                   {
    const uint16_t nSamples = data.size();
    uint16_t channelLength = 0;
    switch (packetCode) {
      case PACKET_CODE_VIRGIN_RAW:
        channelLength = nSamples * 2 + 3;
        break;
      case PACKET_CODE_VIRGIN_RAW10:
        channelLength = std::ceil(nSamples * 1.25) + 3;
        break;
      case PACKET_CODE_VIRGIN_RAW8_BOTBOT:
      case PACKET_CODE_VIRGIN_RAW8_TOPBOT:
        channelLength = nSamples * 1 + 3;
        break;
    }
    channelBuffer->reserve(channelLength);
    //length (max length is 0xFFF)
    channelBuffer->push_back(channelLength & 0xFF);
    channelBuffer->push_back((channelLength & 0xF00) >> 8);
    //packet code
    channelBuffer->push_back(packetCode);
    //channel samples
    uint16_t sampleValue_pre = 0;
    for (uint16_t sampleNumber = 0; sampleNumber < nSamples; sampleNumber++) {
      const uint16_t sampleIndex =
          (reorderData ? FEDStripOrdering::physicalOrderForStripInChannel(sampleNumber) : sampleNumber);
      const uint16_t sampleValue = (channelEnabled ? data.getSample(sampleIndex) : 0);
      switch (packetCode) {
        case PACKET_CODE_VIRGIN_RAW:
          channelBuffer->push_back(sampleValue & 0xFF);
          channelBuffer->push_back((sampleValue & 0x300) >> 8);
          break;
        case PACKET_CODE_VIRGIN_RAW10:
          if (sampleNumber % 4 == 0) {
            channelBuffer->push_back((sampleValue & 0x3FC) >> 2);
          } else if (sampleNumber % 4 == 1) {
            channelBuffer->push_back(((sampleValue_pre & 0x3) << 6) | ((sampleValue & 0x3F0) >> 4));
          } else if (sampleNumber % 4 == 2) {
            channelBuffer->push_back(((sampleValue_pre & 0xF) << 4) | ((sampleValue & 0x3C0) >> 6));
          } else if (sampleNumber % 4 == 3) {
            channelBuffer->push_back(((sampleValue_pre & 0x3F) << 2) | ((sampleValue & 0x300) >> 8));
            channelBuffer->push_back(sampleValue & 0xFF);
          }
          sampleValue_pre = sampleValue;
          break;
        case PACKET_CODE_VIRGIN_RAW8_BOTBOT:
          channelBuffer->push_back((sampleValue & 0x3FC) >> 2);
          break;
        case PACKET_CODE_VIRGIN_RAW8_TOPBOT:
          channelBuffer->push_back((sampleValue & 0x1FE) >> 1);
          break;
      }
    }
  }

fillZeroSuppressedChannelBuffer()

void sistrip::FEDBufferPayloadCreator::fillZeroSuppressedChannelBuffer ( std::vector< uint8_t > *  channelBuffer, const uint8_t  packetCode, const FEDStripData::ChannelData &  data, const bool  channelEnabled  ) const

private

Definition at line 226 of file SiStripFEDBufferGenerator.cc.

References data, and sistrip::READOUT_MODE_ZERO_SUPPRESSED.

                                                                                                 {
    channelBuffer->reserve(50);
    //if channel is disabled then create empty channel header and return
    if (!channelEnabled) {
      //min length 7
      channelBuffer->push_back(7);
      channelBuffer->push_back(0);
      //packet code
      channelBuffer->push_back(packetCode);
      //4 bytes of medians
      channelBuffer->insert(channelBuffer->end(), 4, 0);
      return;
    }
    //if channel is not empty
    //add space for channel length
    channelBuffer->push_back(0xFF);
    channelBuffer->push_back(0xFF);
    //packet code
    channelBuffer->push_back(packetCode);
    //add medians
    const std::pair<uint16_t, uint16_t> medians = data.getMedians();
    channelBuffer->push_back(medians.first & 0xFF);
    channelBuffer->push_back((medians.first & 0x300) >> 8);
    channelBuffer->push_back(medians.second & 0xFF);
    channelBuffer->push_back((medians.second & 0x300) >> 8);
    //clusters
    fillClusterData(channelBuffer, packetCode, data, READOUT_MODE_ZERO_SUPPRESSED);
    //set length
    const uint16_t length = channelBuffer->size();
    (*channelBuffer)[0] = (length & 0xFF);
    (*channelBuffer)[1] = ((length & 0x300) >> 8);
  }

fillZeroSuppressedLiteChannelBuffer()

void sistrip::FEDBufferPayloadCreator::fillZeroSuppressedLiteChannelBuffer ( std::vector< uint8_t > *  channelBuffer, const FEDStripData::ChannelData &  data, const bool  channelEnabled, const FEDReadoutMode  mode  ) const

private

Definition at line 262 of file SiStripFEDBufferGenerator.cc.

References data, and ALCARECOPromptCalibProdSiPixelAli0T_cff::mode.

                                                                                                     {
    channelBuffer->reserve(50);
    //if channel is disabled then create empty channel header and return
    if (!channelEnabled) {
      //min length 2
      channelBuffer->push_back(2);
      channelBuffer->push_back(0);
      return;
    }
    //if channel is not empty
    //add space for channel length
    channelBuffer->push_back(0xFF);
    channelBuffer->push_back(0xFF);
    //clusters
    fillClusterData(channelBuffer, 0, data, mode);
    //set fibre length
    const uint16_t length = channelBuffer->size();
    (*channelBuffer)[0] = (length & 0xFF);
    (*channelBuffer)[1] = ((length & 0x300) >> 8);
  }

operator()()

FEDBufferPayload sistrip::FEDBufferPayloadCreator::operator() ( FEDReadoutMode  mode, uint8_t  packetCode, const FEDStripData &  data  ) const

inline

Definition at line 294 of file SiStripFEDBufferGenerator.h.

References createPayload(), data, and ALCARECOPromptCalibProdSiPixelAli0T_cff::mode.

                                                                                              {
    return createPayload(mode, packetCode, data);
  }

Member Data Documentation

channelsEnabled_

std::vector<bool> sistrip::FEDBufferPayloadCreator::channelsEnabled_

private

Definition at line 123 of file SiStripFEDBufferGenerator.h.

feUnitsEnabled_

std::vector<bool> sistrip::FEDBufferPayloadCreator::feUnitsEnabled_

private

Definition at line 122 of file SiStripFEDBufferGenerator.h.