CTPPSPixelDataFormatter Class Reference

#include <CTPPSPixelDataFormatter.h>

Public Types
typedef edm::DetSetVector< CTPPSPixelDigi >	Collection
typedef std::vector< CTPPSPixelDigi >	DetDigis
typedef std::vector< CTPPSPixelDataError >	DetErrors
typedef std::map< uint32_t, DetErrors >	Errors
typedef std::map< int, FEDRawData >	RawData
typedef uint32_t	Word32
typedef uint64_t	Word64

Public Member Functions
	CTPPSPixelDataFormatter (std::map< CTPPSPixelFramePosition, CTPPSPixelROCInfo > const &mapping)
void	interpretRawData (bool &errorsInEvent, int fedId, const FEDRawData &data, Collection &digis, Errors &errors)
int	nWords () const
void	setErrorStatus (bool theErrorStatus)

Private Member Functions
int	checkError (const Word32 &data) const
std::string	print (const Word64 &word) const

Private Attributes
Word32	m_ADC_mask
int	m_ADC_shift
Word32	m_DCOL_mask
int	m_DCOL_shift
RPixErrorChecker	m_ErrorCheck
bool	m_IncludeErrors
Word32	m_LINK_mask
int	m_LINK_shift
const std::map< CTPPSPixelFramePosition, CTPPSPixelROCInfo > &	m_Mapping
Word32	m_PXID_mask
int	m_PXID_shift
Word32	m_ROC_mask
int	m_ROC_shift
int	m_WordCounter

Detailed Description

Transform CTPPSPixel raw data of a given FED to digi

FED OUTPUT DATA FORMAT (F.Ferro from SiPixel code)

The output is transmitted through a 64 bit S-link connection. The packet format is defined by the CMS RU group to be : 1st packet header, 64 bits, includes a 6 bit FED id. 2nd packet header, 64 bits. .......................... (detector data) packet trailer, 64 bits. of the 64 bit pixel data records consists of 2 32 bit words. Each 32 bit word includes data from 1 pixel, the bit fields are the following:

6 bit link ID (max 36) - this defines the input link within 1 FED. 5 bit ROC ID (max 24) - this defines the readout chip within one link. 5 bit DCOL ID (max 26) - this defines the double column index with 1 chip. 8 bit pixel ID (max 180) - this defines the pixel address within 1 DCOL. 8 bit ADC vales - this has the charge amplitude.

So, 1 pixel occupies 4 bytes. If the number of pixels is odd, one extra 32 bit word is added (value 0) to fill all 64 bits.

The CTPPSPixelDataFormatter interpret/format ONLY detector data words (not FED headers or trailer, which are treated elsewhere).

Definition at line 49 of file CTPPSPixelDataFormatter.h.

Member Typedef Documentation

typedef edm::DetSetVector<CTPPSPixelDigi> CTPPSPixelDataFormatter::Collection

Definition at line 53 of file CTPPSPixelDataFormatter.h.

typedef std::vector<CTPPSPixelDigi> CTPPSPixelDataFormatter::DetDigis

Definition at line 56 of file CTPPSPixelDataFormatter.h.

typedef std::vector<CTPPSPixelDataError> CTPPSPixelDataFormatter::DetErrors

Definition at line 58 of file CTPPSPixelDataFormatter.h.

typedef std::map<uint32_t, DetErrors> CTPPSPixelDataFormatter::Errors

Definition at line 59 of file CTPPSPixelDataFormatter.h.

typedef std::map<int, FEDRawData> CTPPSPixelDataFormatter::RawData

Definition at line 55 of file CTPPSPixelDataFormatter.h.

typedef uint32_t CTPPSPixelDataFormatter::Word32

Definition at line 61 of file CTPPSPixelDataFormatter.h.

typedef uint64_t CTPPSPixelDataFormatter::Word64

Definition at line 62 of file CTPPSPixelDataFormatter.h.

Constructor & Destructor Documentation

CTPPSPixelDataFormatter::CTPPSPixelDataFormatter

(

std::map< CTPPSPixelFramePosition, CTPPSPixelROCInfo > const &

mapping

)

Definition at line 32 of file CTPPSPixelDataFormatter.cc.

References m_ADC_mask, m_ADC_shift, m_DCOL_mask, m_DCOL_shift, m_IncludeErrors, m_LINK_mask, m_LINK_shift, m_PXID_mask, m_PXID_shift, m_ROC_mask, and m_ROC_shift.

                                                                                                                   :  m_WordCounter(0), m_Mapping(mapping)
{
  int s32 = sizeof(Word32);
  int s64 = sizeof(Word64);
  int s8  = sizeof(char);
  if ( s8 != 1 || s32 != 4*s8 || s64 != 2*s32) {
    LogError("UnexpectedSizes")
      <<" unexpected sizes: "
      <<"  size of char is: " << s8
      <<", size of Word32 is: " << s32
      <<", size of Word64 is: " << s64
      <<", send exception" ;
  }

  m_IncludeErrors = false;

  m_ADC_shift  = 0;
  m_PXID_shift = m_ADC_shift + m_ADC_bits;
  m_DCOL_shift = m_PXID_shift + m_PXID_bits;
  m_ROC_shift  = m_DCOL_shift + m_DCOL_bits;


  m_LINK_shift = m_ROC_shift + m_ROC_bits;
  m_LINK_mask = ~(~CTPPSPixelDataFormatter::Word32(0) << m_LINK_bits);
  m_ROC_mask  = ~(~CTPPSPixelDataFormatter::Word32(0) << m_ROC_bits);    

  m_DCOL_mask = ~(~CTPPSPixelDataFormatter::Word32(0) << m_DCOL_bits);
  m_PXID_mask = ~(~CTPPSPixelDataFormatter::Word32(0) << m_PXID_bits);
  m_ADC_mask  = ~(~CTPPSPixelDataFormatter::Word32(0) << m_ADC_bits);

}

Member Function Documentation

int CTPPSPixelDataFormatter::checkError ( const Word32 &  data ) const

private

void CTPPSPixelDataFormatter::interpretRawData	(	bool &	errorsInEvent,
		int	fedId,
		const FEDRawData &	data,
		Collection &	digis,
		Errors &	errors
	)

check CRC bit

check headers

check trailers

data words

Definition at line 72 of file CTPPSPixelDataFormatter.cc.

References ecalMGPA::adc(), RPixErrorChecker::checkCRC(), RPixErrorChecker::checkHeader(), RPixErrorChecker::checkROC(), RPixErrorChecker::checkTrailer(), RPixErrorChecker::conversionError(), FEDRawData::data(), edm::DetSet< T >::data, RPixErrorChecker::dummyDetId, edm::DetSetVector< T >::find_or_insert(), RecoTauValidation_cfi::header, CTPPSPixelROCInfo::iD, InvalidLinkId, InvalidPixelId, InvalidROCId, LIKELY, LogTrace, m_ADC_mask, m_ADC_shift, m_DCOL_mask, m_DCOL_shift, m_ErrorCheck, m_LINK_mask, m_LINK_shift, m_Mapping, m_PXID_mask, m_PXID_shift, m_ROC_mask, m_ROC_shift, m_WordCounter, nWords(), print(), CTPPSPixelROC::rawId(), CTPPSPixelROCInfo::roc, FEDRawData::size(), CTPPSPixelROC::toGlobalfromDcol(), reco::Unknown, and UNLIKELY.

Referenced by nWords(), and CTPPSPixelRawToDigi::produce().

{

  int nWords = rawData.size()/sizeof(Word64);
  if (nWords==0) return;

  const Word64* trailer = reinterpret_cast<const Word64* >(rawData.data())+(nWords-1);  
  if(!m_ErrorCheck.checkCRC(errorsInEvent, fedId, trailer, errors)) return;

  const Word64* header = reinterpret_cast<const Word64* >(rawData.data()); header--;
  bool moreHeaders = true;
  while (moreHeaders) {
    header++;
    LogTrace("")<<"HEADER:  " <<  print(*header);
    bool headerStatus = m_ErrorCheck.checkHeader(errorsInEvent, fedId, header, errors);
    moreHeaders = headerStatus;
  }

  bool moreTrailers = true;
  trailer++;
  while (moreTrailers) {
    trailer--;
    LogTrace("")<<"TRAILER: " <<  print(*trailer);
    bool trailerStatus = m_ErrorCheck.checkTrailer(errorsInEvent, fedId, nWords, trailer, errors);
    moreTrailers = trailerStatus;
  }

  m_WordCounter += 2*(nWords-2);
  LogTrace("")<<"data words: "<< (trailer-header-1);

  int link = -1;
  int roc  = -1;

  bool skipROC=false;

  edm::DetSet<CTPPSPixelDigi> * detDigis=nullptr;

  const  Word32 * bw =(const  Word32 *)(header+1);
  const  Word32 * ew =(const  Word32 *)(trailer);
  if ( *(ew-1) == 0 ) { ew--;  m_WordCounter--;}
  for (auto word = bw; word < ew; ++word) {
    LogTrace("")<<"DATA: " <<  print(*word);

    auto ww = *word;
    if UNLIKELY(ww==0) { m_WordCounter--; continue;}
    int nlink = (ww >> m_LINK_shift) & m_LINK_mask; 
    int nroc  = (ww >> m_ROC_shift) & m_ROC_mask;

    int FMC = 0;
    uint32_t iD = RPixErrorChecker::dummyDetId;//0xFFFFFFFF; //dummyDetId
    int convroc = nroc-1;
    CTPPSPixelFramePosition fPos(fedId, FMC, nlink, convroc);
    std::map<CTPPSPixelFramePosition, CTPPSPixelROCInfo>::const_iterator mit;
    mit = m_Mapping.find(fPos);

    if (mit == m_Mapping.end()){      
      if(nlink >= maxLinkIndex){
    m_ErrorCheck.conversionError(fedId, iD, InvalidLinkId, ww, errors);
      }
      else if((nroc-1)>=maxRocIndex){
    m_ErrorCheck.conversionError(fedId, iD, InvalidROCId, ww, errors);
      }else{
    m_ErrorCheck.conversionError(fedId, iD, Unknown, ww, errors);
      }
      continue; //skip word
    }

    CTPPSPixelROCInfo rocInfo = (*mit).second;
    iD = rocInfo.iD;
    CTPPSPixelROC rocp(iD, rocInfo.roc, convroc);

    if ( (nlink!=link) | (nroc!=roc) ) {  // new roc
      link = nlink; roc=nroc;

      skipROC = LIKELY((roc-1)<maxRocIndex) ? false : !m_ErrorCheck.checkROC(errorsInEvent, fedId, iD,  ww, errors); 
      if (skipROC) continue;

      auto rawId = rocp.rawId();

      detDigis = &digis.find_or_insert(rawId);
      if ( (*detDigis).empty() ) (*detDigis).data.reserve(32); // avoid the first relocations

    }
  
    int adc  = (ww >> m_ADC_shift) & m_ADC_mask;
 
    int dcol = (ww >> m_DCOL_shift) & m_DCOL_mask;
    int pxid = (ww >> m_PXID_shift) & m_PXID_mask;

    if(dcol<min_Dcol || dcol>max_Dcol || pxid<min_Pixid || pxid>max_Pixid){
      edm::LogError("CTPPSPixelDataFormatter")<< " unphysical dcol and/or pxid "  << " nllink=" << nlink 
                          << " nroc="<< nroc << " adc=" << adc << " dcol=" << dcol << " pxid=" << pxid;

      m_ErrorCheck.conversionError(fedId, iD, InvalidPixelId, ww, errors);

      continue;
    }

    std::pair<int,int> rocPixel;
    std::pair<int,int> modPixel;

    rocPixel = std::make_pair(dcol,pxid);

    modPixel = rocp.toGlobalfromDcol(rocPixel);

    CTPPSPixelDigi testdigi(modPixel.first, modPixel.second, adc);

    if(detDigis)
    (*detDigis).data.emplace_back( modPixel.first, modPixel.second, adc); 
 
  }

}

int CTPPSPixelDataFormatter::nWords ( ) const

inline

Definition at line 68 of file CTPPSPixelDataFormatter.h.

References data, l1t::stage2::layer2::fedId, interpretRawData(), and m_WordCounter.

Referenced by interpretRawData().

{ return m_WordCounter; }

std::string CTPPSPixelDataFormatter::print ( const Word64 &  word ) const

private

Definition at line 192 of file CTPPSPixelDataFormatter.cc.

References str.

Referenced by interpretRawData().

{
  std::ostringstream str;
  str  <<"word64:  " << reinterpret_cast<const std::bitset<64>&> (word);
  return str.str();
}

void CTPPSPixelDataFormatter::setErrorStatus

(

bool

theErrorStatus

)

Definition at line 65 of file CTPPSPixelDataFormatter.cc.

References m_ErrorCheck, m_IncludeErrors, and RPixErrorChecker::setErrorStatus().

Referenced by CTPPSPixelRawToDigi::produce().

{
  m_IncludeErrors = errorStatus;
  m_ErrorCheck.setErrorStatus(m_IncludeErrors);
}

Member Data Documentation

Word32 CTPPSPixelDataFormatter::m_ADC_mask

private

Definition at line 83 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

int CTPPSPixelDataFormatter::m_ADC_shift

private

Definition at line 82 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

Word32 CTPPSPixelDataFormatter::m_DCOL_mask

private

Definition at line 83 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

int CTPPSPixelDataFormatter::m_DCOL_shift

private

Definition at line 82 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

RPixErrorChecker CTPPSPixelDataFormatter::m_ErrorCheck

private

Definition at line 80 of file CTPPSPixelDataFormatter.h.

Referenced by interpretRawData(), and setErrorStatus().

bool CTPPSPixelDataFormatter::m_IncludeErrors

private

Definition at line 79 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and setErrorStatus().

Word32 CTPPSPixelDataFormatter::m_LINK_mask

private

Definition at line 83 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

int CTPPSPixelDataFormatter::m_LINK_shift

private

Definition at line 82 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

const std::map<CTPPSPixelFramePosition, CTPPSPixelROCInfo>& CTPPSPixelDataFormatter::m_Mapping

private

Definition at line 90 of file CTPPSPixelDataFormatter.h.

Referenced by interpretRawData().

Word32 CTPPSPixelDataFormatter::m_PXID_mask

private

Definition at line 83 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

int CTPPSPixelDataFormatter::m_PXID_shift

private

Definition at line 82 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

Word32 CTPPSPixelDataFormatter::m_ROC_mask

private

Definition at line 83 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

int CTPPSPixelDataFormatter::m_ROC_shift

private

Definition at line 82 of file CTPPSPixelDataFormatter.h.

Referenced by CTPPSPixelDataFormatter(), and interpretRawData().

int CTPPSPixelDataFormatter::m_WordCounter

mutableprivate

Definition at line 77 of file CTPPSPixelDataFormatter.h.

Referenced by interpretRawData(), and nWords().