DCCSCBlock.cc

Go to the documentation of this file.

#include "EventFilter/EcalRawToDigi/interface/DCCSCBlock.h"
#include "EventFilter/EcalRawToDigi/interface/DCCEventBlock.h"
#include "EventFilter/EcalRawToDigi/interface/DCCDataUnpacker.h"
#include <cstdio>
#include "EventFilter/EcalRawToDigi/interface/EcalElectronicsMapper.h"

DCCSCBlock::DCCSCBlock(
    DCCDataUnpacker *u, EcalElectronicsMapper *m, DCCEventBlock *e, bool unpack, bool forceToKeepFRdata)
    : DCCFEBlock(u, m, e, unpack, forceToKeepFRdata) {}

void DCCSCBlock::updateCollectors() {
  DCCFEBlock::updateCollectors();

  // needs to be update for eb/ee
  digis_ = unpacker_->eeDigisCollection();

  invalidGains_ = unpacker_->invalidEEGainsCollection();
  invalidGainsSwitch_ = unpacker_->invalidEEGainsSwitchCollection();
  invalidChIds_ = unpacker_->invalidEEChIdsCollection();
}

int DCCSCBlock::unpackXtalData(unsigned int expStripID, unsigned int expXtalID) {
  bool errorOnXtal(false);

  const uint16_t *xData_ = reinterpret_cast<const uint16_t *>(data_);

  // Get xtal data ids
  unsigned int stripId = (*xData_) & TOWER_STRIPID_MASK;
  unsigned int xtalId = ((*xData_) >> TOWER_XTALID_B) & TOWER_XTALID_MASK;

  // std::cout<<"\n DEBUG : unpacked xtal data for strip id "<<stripId<<" and xtal id "<<xtalId<<std::endl;
  // std::cout<<"\n DEBUG : expected strip id "<<expStripID<<" expected xtal id "<<expXtalID<<std::endl;

  if (!zs_ && (expStripID != stripId || expXtalID != xtalId)) {
    if (!DCCDataUnpacker::silentMode_) {
      edm::LogWarning("IncorrectBlock") << "For event LV1: " << event_->l1A() << ", fed " << mapper_->getActiveDCC()
                                        << " and tower " << towerId_ << "\n The expected strip is " << expStripID
                                        << " and " << stripId << " was found"
                                        << "\n The expected xtal  is " << expXtalID << " and " << xtalId
                                        << " was found";
    }

    // using expected cry_di to raise warning about xtal_id problem
    pDetId_ = (EEDetId *)mapper_->getDetIdPointer(towerId_, expStripID, expXtalID);
    if (pDetId_) {
      (*invalidChIds_)->push_back(*pDetId_);
    }

    // return here, so to skip all following checks
    data_ += numbDWInXtalBlock_;
    return BLOCK_UNPACKED;
  }

  // check id in case of 0suppressed data

  else if (zs_) {
    // Check for valid Ids 1) values out of range

    if (stripId == 0 || stripId > 5 || xtalId == 0 || xtalId > 5) {
      if (!DCCDataUnpacker::silentMode_) {
        edm::LogWarning("IncorrectBlock")
            << "For event LV1: " << event_->l1A() << ", fed " << mapper_->getActiveDCC() << " and tower " << towerId_
            << "\n Invalid strip : " << stripId << " or xtal : " << xtalId << " ids ( last strip was: " << lastStripId_
            << " last ch was: " << lastXtalId_ << ")";
      }

      int st = lastStripId_;
      int ch = lastXtalId_;
      ch++;
      if (ch > NUMB_XTAL) {
        ch = 1;
        st++;
      }
      if (st > NUMB_STRIP) {
        ch = 1;
        st = 1;
      }

      // adding channel following the last valid
      //pDetId_ = (EEDetId*) mapper_->getDetIdPointer(towerId_,st,ch);
      //(*invalidChIds_)->push_back(*pDetId_);
      fillEcalElectronicsError(invalidZSXtalIds_);

      lastStripId_ = st;
      lastXtalId_ = ch;

      // return here, so to skip all following checks
      return SKIP_BLOCK_UNPACKING;
    } else {
      // Check for zs valid Ids 2) if channel-in-strip has increased wrt previous xtal
      //                        3) if strip has increased wrt previous xtal
      if ((stripId == lastStripId_ && xtalId <= lastXtalId_) || (stripId < lastStripId_)) {
        if (!DCCDataUnpacker::silentMode_) {
          edm::LogWarning("IncorrectBlock")
              << "Xtal id was expected to increase but it didn't - last xtal id was " << lastXtalId_
              << " while current xtal is " << xtalId << " (LV1 " << event_->l1A() << " fed " << mapper_->getActiveDCC()
              << " tower " << towerId_ << ")";
        }

        int st = lastStripId_;
        int ch = lastXtalId_;
        ch++;
        if (ch > NUMB_XTAL) {
          ch = 1;
          st++;
        }
        if (st > NUMB_STRIP) {
          ch = 1;
          st = 1;
        }

        // adding channel following the last valid
        //pDetId_ = (EEDetId*) mapper_->getDetIdPointer(towerId_,stripId,xtalId);
        //(*invalidChIds_)->push_back(*pDetId_);
        fillEcalElectronicsError(invalidZSXtalIds_);

        lastStripId_ = st;
        lastXtalId_ = ch;

        // return here, so to skip all following checks
        return SKIP_BLOCK_UNPACKING;
      }

      lastStripId_ = stripId;
      lastXtalId_ = xtalId;
    }  // end else
  }    // end if(zs_)

  bool addedFrame = false;

  // if there is an error on xtal id ignore next error checks
  // otherwise, assume channel_id is valid and proceed with making and checking the data frame
  if (errorOnXtal)
    return SKIP_BLOCK_UNPACKING;

  pDetId_ = (EEDetId *)mapper_->getDetIdPointer(towerId_, stripId, xtalId);

  if (pDetId_) {  // checking that requested EEDetId exists

    (*digis_)->push_back(*pDetId_);
    EEDataFrame df((*digis_)->back());
    addedFrame = true;
    bool wrongGain(false);

    //set samples in the frame
    for (unsigned int i = 0; i < nTSamples_; i++) {
      xData_++;
      unsigned int data = (*xData_) & TOWER_DIGI_MASK;
      unsigned int gain = data >> 12;
      xtalGains_[i] = gain;
      if (gain == 0) {
        wrongGain = true;
      }  // although gain==0 found, produce the dataFrame in order to have it, for saturation case
      df.setSample(i, data);
    }

    bool isSaturation(true);
    if (wrongGain) {
      // check whether the gain==0 has features of saturation or not
      // gain==0 occurs either in case of data corruption or of ADC saturation
      //                                  \->reject digi            \-> keep digi

      // determine where gainId==0 starts
      short firstGainZeroSampID(-1);
      short firstGainZeroSampADC(-1);
      for (unsigned int s = 0; s < nTSamples_; s++) {
        if (df.sample(s).gainId() == 0 && firstGainZeroSampID == -1) {
          firstGainZeroSampID = s;
          firstGainZeroSampADC = df.sample(s).adc();
          break;
        }
      }

      // check whether gain==0 and adc() stays constant for (at least) 5 consecutive samples
      unsigned int plateauEnd = std::min(nTSamples_, (unsigned int)(firstGainZeroSampID + 5));
      for (unsigned int s = firstGainZeroSampID; s < plateauEnd; s++) {
        if (df.sample(s).gainId() == 0 && df.sample(s).adc() == firstGainZeroSampADC) {
          ;
        } else {
          isSaturation = false;
          break;
        }  //it's not saturation
      }
      // get rid of channels which are stuck in gain0
      if (firstGainZeroSampID < 3) {
        isSaturation = false;
      }

      if (!DCCDataUnpacker::silentMode_) {
        if (unpacker_->getChannelValue(mapper_->getActiveDCC(), towerId_, stripId, xtalId) != 10) {
          edm::LogWarning("IncorrectGain")
              << "Gain zero" << (isSaturation ? " with features of saturation" : "") << " was found in SC Block"
              << " (L1A " << event_->l1A() << " bx " << event_->bx() << " fed " << mapper_->getActiveDCC() << " tower "
              << towerId_ << " strip " << stripId << " xtal " << xtalId << ")";
        }
      }

      if (!isSaturation) {
        (*invalidGains_)->push_back(*pDetId_);
        (*digis_)->pop_back();

        //return here, so to skip all the rest
        //make special collection for gain0 data frames (saturation)
        //Point to begin of next xtal Block
        data_ += numbDWInXtalBlock_;

        return BLOCK_UNPACKED;

      }  //end isSaturation
      else {
        data_ += numbDWInXtalBlock_;
        return BLOCK_UNPACKED;
      }
    }  //end WrongGain

    short firstGainWrong = -1;
    short numGainWrong = 0;

    for (unsigned int i = 1; i < nTSamples_; i++) {
      if (xtalGains_[i - 1] > xtalGains_[i]) {
        numGainWrong++;

        if (firstGainWrong == -1) {
          firstGainWrong = i;
        }
      }
    }

    if (numGainWrong > 0) {
      if (!DCCDataUnpacker::silentMode_) {
        edm::LogWarning("IncorrectGain") << "A wrong gain transition switch was found for SC Block in strip " << stripId
                                         << " and xtal " << xtalId << " (L1A " << event_->l1A() << " bx "
                                         << event_->bx() << " fed " << mapper_->getActiveDCC() << " tower " << towerId_
                                         << ")";
      }

      (*invalidGainsSwitch_)->push_back(*pDetId_);

      errorOnXtal = true;
    }

    //Add frame to collection only if all data format and gain rules are respected
    if (errorOnXtal && addedFrame) {
      (*digis_)->pop_back();
    }

  }  // End 'if EE id exist'

  else {
    // in case EEDetId do not exist
    // In EE we may have crystals with no valid EEDetId
    if (!mapper_->isGhost(mapper_->getActiveDCC(), towerId_, stripId)) {  // check the VFE is not a 'ghost'

      // this is real EE VFE - print warning
      if (!DCCDataUnpacker::silentMode_) {
        edm::LogWarning("IncorrectBlock") << "An EEDetId was requested that does not exist "
                                          << "(LV1 " << event_->l1A() << " fed " << mapper_->getActiveDCC() << " tower "
                                          << towerId_ << " strip " << stripId << " xtal " << xtalId << ")";
      }
    }
  }

  //Point to begin of next xtal Block
  data_ += numbDWInXtalBlock_;

  return BLOCK_UNPACKED;
}

void DCCSCBlock::fillEcalElectronicsError(std::unique_ptr<EcalElectronicsIdCollection> *errorColection) {
  const int activeDCC = mapper_->getActiveSM();

  if ((NUMB_SM_EE_MIN_MIN <= activeDCC && activeDCC <= NUMB_SM_EE_MIN_MAX) ||
      (NUMB_SM_EE_PLU_MIN <= activeDCC && activeDCC <= NUMB_SM_EE_PLU_MAX)) {
    EcalElectronicsId *eleTp = mapper_->getSCElectronicsPointer(activeDCC, expTowerID_);
    (*errorColection)->push_back(*eleTp);
  } else {
    if (!DCCDataUnpacker::silentMode_) {
      edm::LogWarning("IncorrectBlock") << "For event " << event_->l1A() << " there's fed: " << activeDCC
                                        << " activeDcc: " << mapper_->getActiveSM()
                                        << " but that activeDcc is not valid in EE.";
    }
  }
}