#include <EventFilter/RctRawToDigi/src/RctRawToDigi.cc>

Inheritance diagram for RctRawToDigi:

Public Member Functions
	RctRawToDigi (const edm::ParameterSet &)

	~RctRawToDigi ()

Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default

Public Member Functions inherited from edm::stream::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () const

virtual	~EDProducerBase ()

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	ProducerBase ()

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

virtual	~ProducerBase ()

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

	EDConsumerBase ()

ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

Private Member Functions
void	checkHeaders ()

bool	decodeLinkID (const uint32_t inputValue, uint32_t &crateNumber, uint32_t &linkNumber, bool &even)

virtual void	endJob ()
	method called at job end - use to print summary report More...

bool	printAll (const unsigned char *data, const unsigned size)

void	produce (edm::Event &, const edm::EventSetup &)

void	unpack (const FEDRawData &d, edm::Event &e, RctUnpackCollections *const colls)
	Unpacks the raw data. More...

void	unpackCTP7 (const uint32_t data, const unsigned block_id, const unsigned size, RctUnpackCollections const colls)

Private Attributes
std::vector< unsigned >	errorCounters_
	Counts number of errors for each code (index) More...

L1TriggerErrorCollection *	errors_
	pointer to error collection More...

int	fedId_
	RCT FED ID. More...

edm::InputTag	inputLabel_
	FED collection label. More...

unsigned	unpackFailures_
	To count the total number of RCT unpack failures. More...

const bool	verbose_
	If true, then debug print out for each event. More...

Static Private Attributes
static const unsigned	amc13HeaderSize_ = 16

static const unsigned	amc13TrailerSize_ = 8

static const unsigned	ctp7HeaderSize_ = 8

static const unsigned	ctp7TrailerSize_ = 8

static const unsigned	MAX_DATA = 4680
	The maximum number of blocks we will try to unpack before thinking something is wrong. More...

static const unsigned	MAX_ERR_CODE = 6

static const unsigned	MIN_DATA = 900
	The minimum number of blocks we will try to unpack before thinking something is wrong (really this should be 920, to be tested) More...

static const unsigned	sLinkHeaderSize_ = 8

static const unsigned	sLinkTrailerSize_ = 8

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
typedef CacheContexts< T...>	CacheTypes

typedef CacheTypes::GlobalCache	GlobalCache

typedef AbilityChecker< T...>	HasAbility

typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache

typedef LuminosityBlockContextT < LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext

typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache

typedef CacheTypes::RunCache	RunCache

typedef RunContextT< RunCache, GlobalCache >	RunContext

typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Types inherited from edm::stream::EDProducerBase
typedef EDProducerAdaptorBase	ModuleType

Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Static Public Member Functions inherited from edm::stream::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Description: Produce RCT digis from raw data

Implementation: <Notes on="" implementation>="">

Definition at line 40 of file RctRawToDigi.h.

Constructor & Destructor Documentation

RctRawToDigi::RctRawToDigi ( const edm::ParameterSet & iConfig )

explicit

Register Products

Definition at line 36 of file RctRawToDigi.cc.

References fedId_, inputLabel_, and LogDebug.

                                                          :
   inputLabel_(iConfig.getParameter<edm::InputTag>("inputLabel")),
   fedId_(iConfig.getUntrackedParameter<int>("rctFedId", FEDNumbering::MINTriggerUpgradeFEDID)),
   verbose_(iConfig.getUntrackedParameter<bool>("verbose",false))
 {
   LogDebug("RCT") << "RctRawToDigi will unpack FED Id " << fedId_;
   // RCT collections
   produces<L1CaloEmCollection>();
   produces<L1CaloRegionCollection>();
 
   // Error collection
   consumes<FEDRawDataCollection>(inputLabel_);
 
 }

RctRawToDigi::~RctRawToDigi ( )

Definition at line 53 of file RctRawToDigi.cc.

 {
   // do anything here that needs to be done at destruction time
   // (e.g. close files, deallocate resources etc.)
   //delete formatTranslator_;
 }

Member Function Documentation

void RctRawToDigi::checkHeaders ( )

private

Looks at the firmware version header in the S-Link packet and instantiates relevant format translator. check block headers for consistency

bool RctRawToDigi::decodeLinkID	(	const uint32_t	inputValue,
		uint32_t &	crateNumber,
		uint32_t &	linkNumber,
		bool &	even
	)

private

void RctRawToDigi::endJob ( void )

privatevirtual

method called at job end - use to print summary report

Definition at line 348 of file RctRawToDigi.cc.

References errorCounters_, i, MAX_ERR_CODE, pileupDistInMC::total, and verbose_.

 {
   unsigned total=0;
   std::ostringstream os;
 
   for (unsigned i=0 ; i <= MAX_ERR_CODE ; ++i) {
     total+=errorCounters_.at(i);
     os << "Error " << i << " (" << errorCounters_.at(i) << ")";
     if(i < MAX_ERR_CODE) { os << ", "; }
   }
 
   if (total>0 && verbose_) {
     edm::LogError("RCT") << "Encountered " << total << " unpacking errors: " << os.str();
   }  
 }

bool RctRawToDigi::printAll	(	const unsigned char *	data,
		const unsigned	size
	)

private

Definition at line 336 of file RctRawToDigi.cc.

References gather_cfg::cout, i, and findQualityFiles::size.

 {
   for(unsigned i = 0; i < size; i ++){
     std::cout << data[i] << " ";
     if(i%6==5)
       std::cout<<std::endl;
   }
   return true;
 }

void RctRawToDigi::produce	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

privatevirtual

Implements edm::stream::EDProducerBase.

Definition at line 61 of file RctRawToDigi.cc.

References amc13HeaderSize_, amc13TrailerSize_, TauDecayModes::dec, fedId_, HcalMonitorModule_cfi::feds, edm::Event::get(), edm::Event::getByLabel(), inputLabel_, LogDebug, MIN_DATA, FEDRawData::size(), sLinkHeaderSize_, sLinkTrailerSize_, and unpack().

Referenced by JSONExport.JsonExport::export(), HTMLExport.HTMLExport::export(), and HTMLExport.HTMLExportStatic::export().

 {
 
   using namespace edm;
 
   // Instantiate all the collections the unpacker needs; puts them in event when this object goes out of scope.
   std::auto_ptr<RctUnpackCollections> colls(new RctUnpackCollections(iEvent));  
   
   // get raw data collection
   edm::Handle<FEDRawDataCollection> feds;
   iEvent.getByLabel(inputLabel_, feds);
 
   // if raw data collection is present, check the headers and do the unpacking
   if (feds.isValid()) {
   
     const FEDRawData& rctRcd = feds->FEDData(fedId_);
 
     //Check FED size
     LogDebug("RCT") << "Upacking FEDRawData of size " << std::dec << rctRcd.size();
 
     //check header size
     if ( rctRcd.size() < sLinkHeaderSize_ + sLinkTrailerSize_ + amc13HeaderSize_ + amc13TrailerSize_ + MIN_DATA) {
       if (rctRcd.size() > 0) {
     LogError("L1T") << "Cannot unpack: empty/invalid L1T raw data (size = "
             << rctRcd.size() << ") for ID " << fedId_ << ". Returning empty collections!";
       } else {
     // there's no MC packer for this payload, so totally expected that sometimes it will be absent... no warning issued.
       }
       //continue;
       return;
     }
 
     // do the unpacking
     unpack(rctRcd, iEvent, colls.get()); 
 
   }
   else{
 
     LogError("L1T") << "Cannot unpack: no collection found";
 
     return; 
   }
 
 }

void RctRawToDigi::unpack	(	const FEDRawData &	d,
		edm::Event &	e,
		RctUnpackCollections *const	colls
	)

private

Unpacks the raw data.

Parameters

invalidDataFlag - if true, then won't attempt unpack but just output empty collecions.

Definition at line 106 of file RctRawToDigi.cc.

References FEDHeader::bxID(), FEDTrailer::check(), FEDHeader::check(), FEDTrailer::crc(), FEDRawData::data(), data, FEDTrailer::evtStatus(), FEDTrailer::lenght(), LogDebug, FEDHeader::lvl1ID(), FEDRawData::size(), sLinkTrailerSize_, FEDHeader::sourceID(), FEDHeader::triggerType(), FEDTrailer::ttsBits(), unpackCTP7(), and FEDHeader::version().

Referenced by produce().

 {
 
   const unsigned char * data = d.data();  // The 8-bit wide raw-data array.  
   // Data offset - starts at 16 as there is a 64-bit S-Link header followed
   // by a 64-bit software-controlled header (for pipeline format version
   // info that is not yet used).
 
   
   FEDHeader header(data);
   
   if (header.check()) {
     LogDebug("L1T") << "Found SLink header:"
             << " Trigger type " << header.triggerType()
             << " L1 event ID " << header.lvl1ID()
             << " BX Number " << header.bxID()
             << " FED source " << header.sourceID()
             << " FED version " << header.version();
   } else {
     LogWarning("L1T") << "Did not find a valid SLink header!";
   }
   
   FEDTrailer trailer(data + (d.size() - sLinkTrailerSize_));
   
   if (trailer.check()) {
     LogDebug("L1T") << "Found SLink trailer:"
             << " Length " << trailer.lenght()
             << " CRC " << trailer.crc()
             << " Status " << trailer.evtStatus()
             << " Throttling bits " << trailer.ttsBits();
   } else {
     LogWarning("L1T") << "Did not find a SLink trailer!";
   }
   
   unpackCTP7((uint32_t*)data, 0, sizeof(data), colls);
 
 }

void RctRawToDigi::unpackCTP7	(	const uint32_t *	data,
		const unsigned	block_id,
		const unsigned	size,
		RctUnpackCollections *const	colls
	)

private

Definition at line 146 of file RctRawToDigi.cc.

References assert(), j, relval_2017::k, LogDebug, visualization-live-secondInstance_cfg::m, connectstrParser::o, hltrates_dqm_sourceclient-live_cfg::offset, lumiQueryAPI::q, RctUnpackCollections::rctCalo(), RctUnpackCollections::rctEm(), L1CaloEmCand::setBx(), L1CaloRegion::setBx(), findQualityFiles::size, lumiQTWidget::t, and tmp.

Referenced by unpack().

 {
   //offset from 6 link header words
   uint32_t of = 6;
   LogDebug("L1T") << "Block ID  = " << block_id << " size = " << size;
 
   CTP7Format ctp7Format;
   RctDataDecoder rctDataDecoder;
   uint32_t nBXTemp = 0; 
   uint32_t ctp7FWVersion;
   uint32_t L1ID, L1aBCID;
   std::vector<RCTInfo> allCrateRCTInfo[5];
   
   L1ID          =  data[1+of];                      // extract the L1 ID number
   L1aBCID       =  data[5+of] & 0x00000FFF;         // extract the BCID number of L1A
   nBXTemp       = (data[5+of] & 0x00FF0000) >> 16;  // extract number of BXs readout per L1A 
   ctp7FWVersion =  data[4+of];
   
   if(nBXTemp != 1 && nBXTemp != 3 && nBXTemp != 5)
     nBXTemp = 1;
 
   const uint32_t nBX = nBXTemp;
 
   LogDebug("L1T") << "CTP7 L1ID = " << L1ID << " L1A BCID = " << L1aBCID << " BXs in capture = " << nBX << " CTP7 DAQ FW = " << ctp7FWVersion;
   
   struct link_data{
     bool even;
     unsigned int crateID;
     unsigned int ctp7LinkNumber;
     std::vector <unsigned int> uint;
   };
 
   //nBX max 5, nLinks max 36 [nBX][nLinks]
   link_data allLinks[5][36];
   const uint32_t NLinks = ctp7Format.NLINKS;
   assert(NLinks <= 36);
 
   //change this implementation
   uint32_t iDAQBuffer = 0;
 
   //Step 1: Grab all data from ctp7 buffer and put into link format
   for(unsigned int iLink = 0; iLink < NLinks; iLink++ ){
     iDAQBuffer = of +
                  ctp7Format.EVENT_HEADER_WORDS + iLink * (ctp7Format.CHANNEL_HEADER_WORDS + 
                               nBX * ctp7Format.CHANNEL_DATA_WORDS_PER_BX);
     
     //first decode linkID 
     uint32_t linkID     = data[iDAQBuffer++];
     uint32_t tmp        = data[iDAQBuffer++];
     uint32_t CRCErrCnt  =  tmp & 0x0000FFFF;
     //uint32_t linkStatus = (tmp & 0xFFFF0000) >> 16;
 
     uint32_t crateID = 0;    uint32_t expectedCrateID = 0;
     bool even = false; bool expectedEven = false;
 
     //getExpected Link ID
     rctDataDecoder.getExpectedLinkID(iLink, expectedCrateID, expectedEven);
     //getDecodedLink ID
     rctDataDecoder.decodeLinkID(linkID, crateID, even);
 
     //Perform a check to see if the link ID is as expected, if not then report an error but continue unpacking
     if(expectedCrateID!=crateID || even!=expectedEven ){
       LogError("L1T") <<"Expected Crate ID "<< expectedCrateID <<" expectedEven "<< expectedEven 
               <<"does not match actual Crate ID "<<crateID<<" even "<<even;
     }
 
     if(CRCErrCnt!=0)
       LogError("L1T")<<"WARNING CRC ErrorFound linkID "<< linkID<<" expected crateID "<< expectedCrateID;
     
     // Loop over multiple BX                                                                        
     for (uint32_t iBX=0; iBX<nBX; iBX++){
       allLinks[iBX][iLink].uint.reserve(6);
       allLinks[iBX][iLink].ctp7LinkNumber     = iLink;
       allLinks[iBX][iLink].crateID            = expectedCrateID;
       allLinks[iBX][iLink].even               = expectedEven;
 
       //Notice 6 words per BX
       for(unsigned int iWord = 0; iWord < 6 ; iWord++ ){
     allLinks[iBX][iLink].uint.push_back(data[iDAQBuffer+iWord+iBX*6]);
       }
     }
   }
 
   //Step 2: Dynamically match links and create RCTInfo Objects 
   uint32_t nCratesFound = 0;
   for(unsigned int iCrate = 0; iCrate < 18 ; iCrate++){
     
     bool foundEven = false, foundOdd = false;
     link_data even[5];
     link_data odd[5];
     
     for(unsigned int iLink = 0; iLink < NLinks; iLink++){
       
       if( (allLinks[0][iLink].crateID==iCrate) && (allLinks[0][iLink].even == true) ){
     foundEven = true;
     for (unsigned int iBX=0; iBX<nBX; iBX++)
       even[iBX] = allLinks[iBX][iLink];
       }
       else if( (allLinks[0][iLink].crateID==iCrate) && (allLinks[0][iLink].even == false) ){
     foundOdd = true;
     for (unsigned int iBX=0; iBX<nBX; iBX++)
       odd[iBX] = allLinks[iBX][iLink];
       } 
 
       //if success then create RCTInfoVector and fill output object
       if(foundEven && foundOdd){
     nCratesFound++;
        
     //fill rctInfoVector for all BX read out
     for (unsigned int iBX=0; iBX<nBX; iBX++){
       //RCTInfoFactory rctInfoFactory;
       std::vector <RCTInfo> rctInfoData;
       rctDataDecoder.decodeLinks(even[iBX].uint, odd[iBX].uint, rctInfoData);
       rctDataDecoder.setRCTInfoCrateID(rctInfoData, iCrate);
       allCrateRCTInfo[iBX].push_back(rctInfoData.at(0));
     }
     break;
       }
     }
   }
 
   if(nCratesFound != 18)
     LogError("L1T") << "Warning -- only found "<< nCratesFound << " valid crates";
 
   //start assuming 1 BX readout
  int32_t startBX = 0;
   if(nBX == 1)
     startBX = 0;
   else if(nBX == 3)
     startBX = -1;
   else if(nBX == 5)
     startBX = -2;  
   
   //Step 3: Create Collections from RCTInfo Objects  
   //Notice, iBX used for grabbing data from array, startBX used for storing in Collection
   for (uint32_t iBX=0; iBX<nBX; iBX++, startBX++){
 
     for(unsigned int iCrate = 0; iCrate < nCratesFound; iCrate++ ){
       
       RCTInfo rctInfo = allCrateRCTInfo[iBX].at(iCrate);
       //Use Crate ID to identify eta/phi of candidate
       for(int j = 0; j < 4; j++) {
     L1CaloEmCand em = L1CaloEmCand(rctInfo.neRank[j], 
                        rctInfo.neRegn[j], 
                        rctInfo.neCard[j], 
                        rctInfo.crateID, 
                        false);
     em.setBx(startBX);
     colls->rctEm()->push_back(em);
       }
       
       for(int j = 0; j < 4; j++) {
     L1CaloEmCand em = L1CaloEmCand(rctInfo.ieRank[j], 
                        rctInfo.ieRegn[j], 
                        rctInfo.ieCard[j], 
                        rctInfo.crateID, 
                        true);
     em.setBx(startBX);
     colls->rctEm()->push_back(em);
       }
       
       for(int j = 0; j < 7; j++) {
     for(int k = 0; k < 2; k++) {
       bool o = (((rctInfo.oBits >> (j * 2 + k)) & 0x1) == 0x1);
       bool t = (((rctInfo.tBits >> (j * 2 + k)) & 0x1) == 0x1);
       bool m = (((rctInfo.mBits >> (j * 2 + k)) & 0x1) == 0x1);
       bool q = (((rctInfo.qBits >> (j * 2 + k)) & 0x1) == 0x1);
       L1CaloRegion rgn = L1CaloRegion(rctInfo.rgnEt[j][k], o, t, m, q, rctInfo.crateID , j, k);
       rgn.setBx(startBX);
       colls->rctCalo()->push_back(rgn);
     }
       }
       
       for(int k = 0; k < 4; k++) {
     for(int j = 0; j < 2; j++) {
       // 0 1 4 5 2 3 6 7
       uint32_t offset = j*2 + k%2 + (k/2)*4;
       bool fg=(((rctInfo.hfQBits >> offset) & 0x1)  == 0x1); 
       L1CaloRegion rgn = L1CaloRegion(rctInfo.hfEt[j][k], fg,  rctInfo.crateID , (j * 4 + k));
       rgn.setBx(startBX);
       colls->rctCalo()->push_back(rgn);
     }
       }
     }
   }
 }

Member Data Documentation

const unsigned RctRawToDigi::amc13HeaderSize_ = 16

staticprivate

Definition at line 80 of file RctRawToDigi.h.

Referenced by produce().

const unsigned RctRawToDigi::amc13TrailerSize_ = 8

staticprivate

Definition at line 83 of file RctRawToDigi.h.

Referenced by produce().

const unsigned RctRawToDigi::ctp7HeaderSize_ = 8

staticprivate

Definition at line 86 of file RctRawToDigi.h.

const unsigned RctRawToDigi::ctp7TrailerSize_ = 8

staticprivate

Definition at line 89 of file RctRawToDigi.h.

std::vector<unsigned> RctRawToDigi::errorCounters_

private

Counts number of errors for each code (index)

Definition at line 109 of file RctRawToDigi.h.

Referenced by endJob().

L1TriggerErrorCollection* RctRawToDigi::errors_

private

pointer to error collection

Definition at line 108 of file RctRawToDigi.h.

int RctRawToDigi::fedId_

private

RCT FED ID.

Definition at line 99 of file RctRawToDigi.h.

Referenced by produce(), and RctRawToDigi().

edm::InputTag RctRawToDigi::inputLabel_

private

FED collection label.

Definition at line 98 of file RctRawToDigi.h.

Referenced by produce(), and RctRawToDigi().

const unsigned RctRawToDigi::MAX_DATA = 4680

staticprivate

The maximum number of blocks we will try to unpack before thinking something is wrong.

Definition at line 92 of file RctRawToDigi.h.

const unsigned RctRawToDigi::MAX_ERR_CODE = 6

staticprivate

Definition at line 107 of file RctRawToDigi.h.

Referenced by endJob().

const unsigned RctRawToDigi::MIN_DATA = 900

staticprivate

The minimum number of blocks we will try to unpack before thinking something is wrong (really this should be 920, to be tested)

Definition at line 95 of file RctRawToDigi.h.

Referenced by produce().

const unsigned RctRawToDigi::sLinkHeaderSize_ = 8

staticprivate

Definition at line 74 of file RctRawToDigi.h.

Referenced by produce().

const unsigned RctRawToDigi::sLinkTrailerSize_ = 8

staticprivate

Definition at line 77 of file RctRawToDigi.h.

Referenced by produce(), and unpack().

unsigned RctRawToDigi::unpackFailures_

private

To count the total number of RCT unpack failures.

Definition at line 110 of file RctRawToDigi.h.

const bool RctRawToDigi::verbose_

private

If true, then debug print out for each event.

Definition at line 101 of file RctRawToDigi.h.

Referenced by endJob().

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation