DCCSCBlock Class Reference

#include <DCCSCBlock.h>

Inheritance diagram for DCCSCBlock:

Public Member Functions
	DCCSCBlock (DCCDataUnpacker *u, EcalElectronicsMapper *m, DCCEventBlock *e, bool unpack, bool forceToKeepFRdata)
void	updateCollectors () override
Public Member Functions inherited from DCCFEBlock
	DCCFEBlock (DCCDataUnpacker *u, EcalElectronicsMapper *m, DCCEventBlock *e, bool unpack, bool forceToKeepFRdata)
void	display (std::ostream &o) override
void	enableFeIdChecks ()
unsigned int	getLength () override
virtual int	unpack (const uint64_t **data, unsigned int *dwToEnd)
int	unpack (const uint64_t **data, unsigned int *dwToEnd, bool zs, unsigned int expectedTowerID)
void	zsFlag (bool zs)
	~DCCFEBlock () override
Public Member Functions inherited from DCCDataBlockPrototype
	DCCDataBlockPrototype (DCCDataUnpacker *unpacker, EcalElectronicsMapper *mapper, DCCEventBlock *event, bool unpack=true)
void	enableSyncChecks ()
virtual int	unpack (const uint64_t **data, unsigned int *dwToEnd)
virtual void	updateEventPointers ()
virtual	~DCCDataBlockPrototype ()

Protected Member Functions
void	fillEcalElectronicsError (std::unique_ptr< EcalElectronicsIdCollection > *) override
int	unpackXtalData (unsigned int stripID, unsigned int xtalID) override

Protected Attributes
std::unique_ptr< EEDigiCollection > *	digis_
std::unique_ptr< EEDetIdCollection > *	invalidChIds_
std::unique_ptr< EEDetIdCollection > *	invalidGains_
std::unique_ptr< EEDetIdCollection > *	invalidGainsSwitch_
EEDetId *	pDetId_
EEDataFrame *	pDFId_
Protected Attributes inherited from DCCFEBlock
unsigned int	blockSize_
unsigned int	bx_
bool	checkFeId_
unsigned int	expTowerID_
unsigned int	expXtalTSamples_
bool	forceToKeepFRdata_
std::unique_ptr< EcalElectronicsIdCollection > *	invalidBlockLengths_
std::unique_ptr< EcalElectronicsIdCollection > *	invalidTTIds_
std::unique_ptr< EcalElectronicsIdCollection > *	invalidZSXtalIds_
unsigned int	l1_
unsigned int	lastStripId_
unsigned int	lastXtalId_
unsigned int	nTSamples_
unsigned int	numbDWInXtalBlock_
unsigned int	towerId_
unsigned int	unfilteredDataBlockLength_
unsigned int	xtalBlockSize_
short *	xtalGains_
bool	zs_
Protected Attributes inherited from DCCDataBlockPrototype
unsigned int	blockLength_
const uint64_t *	data_
const uint64_t **	datap_
unsigned int *	dwToEnd_
bool	error_
DCCEventBlock *	event_
EcalElectronicsMapper *	mapper_
bool	sync_
DCCDataUnpacker *	unpacker_
bool	unpackInternalData_

Detailed Description

Definition at line 22 of file DCCSCBlock.h.

Constructor & Destructor Documentation

DCCSCBlock()

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

Definition at line 7 of file DCCSCBlock.cc.

    : DCCFEBlock(u, m, e, unpack, forceToKeepFRdata) {}

Member Function Documentation

fillEcalElectronicsError()

void DCCSCBlock::fillEcalElectronicsError ( std::unique_ptr< EcalElectronicsIdCollection > *  errorColection )

overrideprotectedvirtual

Reimplemented from DCCFEBlock.

Definition at line 269 of file DCCSCBlock.cc.

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

References DCCDataBlockPrototype::event_, DCCFEBlock::expTowerID_, EcalElectronicsMapper::getActiveSM(), EcalElectronicsMapper::getSCElectronicsPointer(), DCCEventBlock::l1A(), DCCDataBlockPrototype::mapper_, NUMB_SM_EE_MIN_MAX, NUMB_SM_EE_MIN_MIN, NUMB_SM_EE_PLU_MAX, NUMB_SM_EE_PLU_MIN, and DCCDataUnpacker::silentMode_.

Referenced by unpackXtalData().

unpackXtalData()

int DCCSCBlock::unpackXtalData ( unsigned int  stripID, unsigned int  xtalID  )

overrideprotectedvirtual

Reimplemented from DCCFEBlock.

Definition at line 22 of file DCCSCBlock.cc.

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

References BLOCK_UNPACKED, DCCEventBlock::bx(), data, DCCDataBlockPrototype::data_, hgcalPerformanceValidation::df, DCCDataBlockPrototype::event_, fillEcalElectronicsError(), PedestalClient_cfi::gain, EcalElectronicsMapper::getActiveDCC(), DCCDataUnpacker::getChannelValue(), EcalElectronicsMapper::getDetIdPointer(), mps_fire::i, DCCFEBlock::invalidZSXtalIds_, EcalElectronicsMapper::isGhost(), DCCEventBlock::l1A(), DCCFEBlock::lastStripId_, DCCFEBlock::lastXtalId_, DCCDataBlockPrototype::mapper_, min(), DCCFEBlock::nTSamples_, NUMB_STRIP, NUMB_XTAL, DCCFEBlock::numbDWInXtalBlock_, pDetId_, alignCSCRings::s, DCCDataUnpacker::silentMode_, SKIP_BLOCK_UNPACKING, TOWER_DIGI_MASK, TOWER_STRIPID_MASK, TOWER_XTALID_B, TOWER_XTALID_MASK, DCCFEBlock::towerId_, DCCDataBlockPrototype::unpacker_, DCCFEBlock::xtalGains_, and DCCFEBlock::zs_.

updateCollectors()

void DCCSCBlock::updateCollectors ( )

overridevirtual

Reimplemented from DCCFEBlock.

Definition at line 11 of file DCCSCBlock.cc.

                                  {
  DCCFEBlock::updateCollectors();
 
  // needs to be update for eb/ee
  digis_ = unpacker_->eeDigisCollection();
 
  invalidGains_ = unpacker_->invalidEEGainsCollection();
  invalidGainsSwitch_ = unpacker_->invalidEEGainsSwitchCollection();
  invalidChIds_ = unpacker_->invalidEEChIdsCollection();
}

References digis_, DCCDataUnpacker::eeDigisCollection(), invalidChIds_, DCCDataUnpacker::invalidEEChIdsCollection(), DCCDataUnpacker::invalidEEGainsCollection(), DCCDataUnpacker::invalidEEGainsSwitchCollection(), invalidGains_, invalidGainsSwitch_, DCCDataBlockPrototype::unpacker_, and DCCFEBlock::updateCollectors().

Member Data Documentation

digis_

std::unique_ptr<EEDigiCollection>* DCCSCBlock::digis_

protected

Definition at line 37 of file DCCSCBlock.h.

Referenced by updateCollectors().

invalidChIds_

std::unique_ptr<EEDetIdCollection>* DCCSCBlock::invalidChIds_

protected

Definition at line 42 of file DCCSCBlock.h.

Referenced by updateCollectors().

invalidGains_

std::unique_ptr<EEDetIdCollection>* DCCSCBlock::invalidGains_

protected

Definition at line 40 of file DCCSCBlock.h.

Referenced by updateCollectors().

invalidGainsSwitch_

std::unique_ptr<EEDetIdCollection>* DCCSCBlock::invalidGainsSwitch_

protected

Definition at line 41 of file DCCSCBlock.h.

Referenced by updateCollectors().

pDetId_

EEDetId* DCCSCBlock::pDetId_

protected

Definition at line 34 of file DCCSCBlock.h.

Referenced by unpackXtalData().

pDFId_

EEDataFrame* DCCSCBlock::pDFId_

protected

Definition at line 35 of file DCCSCBlock.h.