---

GctRawToDigi Class Reference

Description: Produce GCT digis from raw data. More...

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

Inheritance diagram for GctRawToDigi:

List of all members.

Public Member Functions
	GctRawToDigi (const edm::ParameterSet &)
	~GctRawToDigi ()
Private Member Functions
bool	autoDetectRequiredFormatTranslator (const unsigned char *data)
	Looks at the firmware version header in the S-Link packet and instantiates relevant format translator.
virtual void	beginJob (const edm::EventSetup &)
void	doVerboseOutput (const GctBlockHeaderCollection &bHdrs, const GctUnpackCollections *const colls) const
	Prints out a list of blocks and the various numbers of trigger objects that have been unpacked from them.
virtual void	endJob ()
virtual void	produce (edm::Event &, const edm::EventSetup &)
void	unpack (const FEDRawData &d, edm::Event &e, GctUnpackCollections *const colls)
	Unpacks the raw data.
Private Attributes
int	fedId_
	GCT FED ID.
GctFormatTranslateBase *	formatTranslator_
const unsigned	formatVersion_
	Defines unpacker verison to be used (e.g.: "Auto-detect", "MCLegacy", "V35", etc).
const bool	hltMode_
	If true, only outputs the GT output data, and only BX = 0.
edm::InputTag	inputLabel_
	FED collection label.
unsigned	unpackFailures_
	To count the total number of GCT unpack failures.
const bool	unpackSharedRegions_
	Commissioning option: if true, where applicable the shared RCT calo regions will also be unpacked.
const bool	verbose_
	If true, then debug print out for each event.
Static Private Attributes
static const unsigned	MAX_BLOCKS = 256
	The maximum number of blocks we will try to unpack before thinking something is wrong.

---

Detailed Description

Description: Produce GCT digis from raw data.

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

Definition at line 45 of file GctRawToDigi.h.

---

Constructor & Destructor Documentation

GctRawToDigi::GctRawToDigi

(

const edm::ParameterSet &

iConfig

)

[explicit]

Register Products

Definition at line 33 of file GctRawToDigi.cc.

References fedId_, formatTranslator_, formatVersion_, hltMode_, LogDebug, and unpackSharedRegions_.

                                                         :
  inputLabel_(iConfig.getParameter<edm::InputTag>("inputLabel")),
  fedId_(iConfig.getParameter<int>("gctFedId")),
  hltMode_(iConfig.getParameter<bool>("hltMode")),
  unpackSharedRegions_(iConfig.getParameter<bool>("unpackSharedRegions")),
  formatVersion_(iConfig.getParameter<unsigned>("unpackerVersion")),
  verbose_(iConfig.getUntrackedParameter<bool>("verbose",false)),
  formatTranslator_(0),
  unpackFailures_(0)
{
  LogDebug("GCT") << "GctRawToDigi will unpack FED Id " << fedId_;

  // If the GctFormatTranslate version has been forced from config file, instantiate the relevant one.
  /***  THIS OBVIOUSLY STINKS - NEED TO REPLACE WITH SOMETHING BETTER THAN MASSIVE IF-ELSE SOON ***/
  if(formatVersion_ == 0) { edm::LogInfo("GCT") << "The required GCT Format Translator will be automatically determined from the first S-Link packet header."; }
  else if(formatVersion_ == 1)
  {
    edm::LogInfo("GCT") << "You have selected to use GctFormatTranslateMCLegacy";
    formatTranslator_ = new GctFormatTranslateMCLegacy(hltMode_, unpackSharedRegions_);
  }
  else if(formatVersion_ == 2)
  {
    edm::LogInfo("GCT") << "You have selected to use GctFormatTranslateV35";
    formatTranslator_ = new GctFormatTranslateV35(hltMode_, unpackSharedRegions_);
  }
  else if(formatVersion_ == 3)
  {
    edm::LogInfo("GCT") << "You have selected to use GctFormatTranslateV38";
    formatTranslator_ = new GctFormatTranslateV38(hltMode_, unpackSharedRegions_);    
  }
  else
  { 
    edm::LogWarning("GCT") << "You have requested a version of GctFormatTranslate that does not exist! Will attempt to auto-detect "
                              "the required GCT Format Translator from the first S-Link packet header instead.";
  }

  if(hltMode_) { edm::LogInfo("GCT") << "HLT unpack mode selected: HLT unpack optimisations will be used."; }
  if(unpackSharedRegions_) { edm::LogInfo("GCT") << "You have selected to unpack shared RCT calo regions - be warned: "
                                                    "this is for commissioning purposes only!"; }

  // GCT input collections
  produces<L1GctFibreCollection>();
  produces<L1CaloEmCollection>();
  produces<L1CaloRegionCollection>();

  // GCT internal collections
  produces<L1GctInternEmCandCollection>();
  produces<L1GctInternJetDataCollection>();
  produces<L1GctInternEtSumCollection>();

  // GCT output collections
  produces<L1GctEmCandCollection>("isoEm");
  produces<L1GctEmCandCollection>("nonIsoEm");
  produces<L1GctJetCandCollection>("cenJets");
  produces<L1GctJetCandCollection>("forJets");
  produces<L1GctJetCandCollection>("tauJets");
  produces<L1GctHFBitCountsCollection>();
  produces<L1GctHFRingEtSumsCollection>();
  produces<L1GctEtTotalCollection>();
  produces<L1GctEtHadCollection>();
  produces<L1GctEtMissCollection>();
  produces<L1GctJetCountsCollection>();  // Deprecated (empty collection still needed by GT)
}

GctRawToDigi::~GctRawToDigi

(

)

Definition at line 99 of file GctRawToDigi.cc.

References formatTranslator_.

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

---

Member Function Documentation

bool GctRawToDigi::autoDetectRequiredFormatTranslator

(

const unsigned char *

data

)

[private]

Looks at the firmware version header in the S-Link packet and instantiates relevant format translator.

Returns false if it fails to instantiate a Format Translator

Definition at line 194 of file GctRawToDigi.cc.

References formatTranslator_, hltMode_, LogDebug, unpackFailures_, and unpackSharedRegions_.

Referenced by unpack().

{
  LogDebug("GCT") << "About to auto-detect the required format translator from the firmware version header.";
    
  const uint32_t * p32 = reinterpret_cast<const uint32_t *>(d);
  unsigned firmwareHeader = p32[2];

  /***  THIS OBVIOUSLY STINKS - NEED TO REPLACE WITH SOMETHING BETTER THAN MASSIVE IF-ELSE SOON ***/
  if( firmwareHeader >= 25 && firmwareHeader <= 35 )
  {
    edm::LogInfo("GCT") << "Firmware Version V" << firmwareHeader << " detected: GctFormatTranslateV" << firmwareHeader << " will be used to unpack.";
    formatTranslator_ = new GctFormatTranslateV35(hltMode_, unpackSharedRegions_);
    return true;
  }
  else if( firmwareHeader == 38 )
  {
    edm::LogInfo("GCT") << "Firmware Version V" << firmwareHeader << " detected: GctFormatTranslateV" << firmwareHeader << " will be used to unpack.";
    formatTranslator_ = new GctFormatTranslateV38(hltMode_, unpackSharedRegions_);
    return true;
  }
  else if( firmwareHeader == 0x00000000 )
  {
    edm::LogInfo("GCT") << "Legacy Monte-Carlo data detected: GctFormatTranslateMCLegacy will be used to unpack.";
    formatTranslator_ = new GctFormatTranslateMCLegacy(hltMode_, unpackSharedRegions_);
    return true;
  }
  else if(firmwareHeader == 0xdeadffff) { /* Driver detected unknown firmware version. L1TriggerError code? */ }
  else if( firmwareHeader == 0xaaaaaaaa) { /* Before driver firmware version checks implemented. L1TriggerError code?  */ }
  else { /* Totally unknown firmware header. L1TriggerError code?  */ }
  
  LogDebug("GCT") << "Failed to determine unpacker to use from the firmware version header! "
                     "(firmware header = 0x" << hex << firmwareHeader << dec << ")";

  ++unpackFailures_;
  return false;
}

void GctRawToDigi::beginJob

(

const edm::EventSetup &

)

[private, virtual]

Reimplemented from edm::EDProducer.

Definition at line 112 of file GctRawToDigi.cc.

{
}

void GctRawToDigi::doVerboseOutput	(	const GctBlockHeaderCollection &	bHdrs,
		const GctUnpackCollections *const	colls
	)			const [private]

Prints out a list of blocks and the various numbers of trigger objects that have been unpacked from them.

Definition at line 231 of file GctRawToDigi.cc.

References lat::endl(), formatTranslator_, GctFormatTranslateBase::getBlockDescription(), i, and size.

Referenced by unpack().

{
  std::ostringstream os;
  os << "Found " << bHdrs.size() << " GCT block headers" << endl;
  for (unsigned i=0, size = bHdrs.size(); i < size; ++i)
  {
    os << "GCT Raw Data Block : " << formatTranslator_->getBlockDescription(bHdrs[i]) << " : " << bHdrs[i] << endl;
  }
  os << *colls << endl;
  edm::LogVerbatim("GCT") << os.str();
}

void GctRawToDigi::endJob

(

void

)

[private, virtual]

Reimplemented from edm::EDProducer.

Definition at line 244 of file GctRawToDigi.cc.

References unpackFailures_.

{
  if(unpackFailures_ > 0)
  {
    edm::LogError("GCT") << "GCT unpacker encountered " << unpackFailures_
                         << " unpack errors in total during this job!";
  }  
}

void GctRawToDigi::produce	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)			[private, virtual]

Implements edm::EDProducer.

Definition at line 118 of file GctRawToDigi.cc.

References fedId_, edm::Event::get(), edm::Event::getByLabel(), hltMode_, inputLabel_, LogDebug, FEDRawData::size(), unpack(), and unpackFailures_.

{
  using namespace edm;

  // get raw data collection
  edm::Handle<FEDRawDataCollection> feds;
  iEvent.getByLabel(inputLabel_, feds);
  const FEDRawData& gctRcd = feds->FEDData(fedId_);
 
  LogDebug("GCT") << "Upacking FEDRawData of size " << std::dec << gctRcd.size();

  // Instantiate all the collections the unpacker needs; puts them in event when this object goes out of scope.
  std::auto_ptr<GctUnpackCollections> colls(new GctUnpackCollections(iEvent, hltMode_));
  
  // do a simple check of the raw data - this will detect empty events
  if(gctRcd.size() < 16)
  {
    LogDebug("GCT") << "Cannot unpack: empty/invalid GCT raw data (size = "
                    << gctRcd.size() << "). Returning empty collections!";
    ++unpackFailures_;
  }
  else{ unpack(gctRcd, iEvent, colls.get()); }
}

void GctRawToDigi::unpack	(	const FEDRawData &	d,
		edm::Event &	e,
		GctUnpackCollections *const	colls
	)			[private]

Unpacks the raw data.

Parameters:

invalidDataFlag

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

Definition at line 143 of file GctRawToDigi.cc.

References autoDetectRequiredFormatTranslator(), GctBlockHeader::blockLength(), GctFormatTranslateBase::convertBlock(), FEDRawData::data(), data, doVerboseOutput(), formatTranslator_, GctFormatTranslateBase::generateBlockHeader(), LogDebug, MAX_BLOCKS, GctBlockHeader::nSamples(), GctFormatTranslateBase::setUnpackCollections(), FEDRawData::size(), unpackFailures_, and verbose_.

Referenced by produce().

{
  const unsigned char * data = d.data();  // The 8-bit wide raw-data array.  

  // If no format translator yet set, need to auto-detect from header.
  if(!formatTranslator_)
  {
    // If auto format detection fails, we have no concrete format
    // translator instantiated... so bail from event.
    if(!autoDetectRequiredFormatTranslator(data)) { return; }
  }

  // We should now have a valid formatTranslator pointer  
  formatTranslator_->setUnpackCollections(colls);

  // 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).
  unsigned dPtr = 16;

  const unsigned dEnd = d.size() - 8; // End of payload is at (packet size - final slink header)

  GctBlockHeaderCollection bHdrs; // Vector for storing block headers for verbosity print-out.

  // read blocks
  for (unsigned nb=0; dPtr<dEnd; ++nb)
  {
    if(nb >= MAX_BLOCKS) { LogDebug("GCT") << "Reached block limit - bailing out from this event!"; ++unpackFailures_; break; }
  
    // read block header
    GctBlockHeader blockHeader = formatTranslator_->generateBlockHeader(&data[dPtr]);
  
    // unpack the block; dPtr+4 is to get to the block data.
    if(!formatTranslator_->convertBlock(&data[dPtr+4], blockHeader)) // Record if we had an unpack problem then skip rest of event.
    {
      LogDebug("GCT") << "Encountered block unpack error - bailing out from this event!";
      ++unpackFailures_; break;
    } 

    // advance pointer
    dPtr += 4*(blockHeader.blockLength()*blockHeader.nSamples()+1); // *4 because blockLen is in 32-bit words, +1 for header

    // If verbose, store the header in vector.
    if(verbose_) { bHdrs.push_back(blockHeader); }
  }

  // dump summary in verbose mode
  if(verbose_) { doVerboseOutput(bHdrs, colls); }
}

---

Member Data Documentation

int GctRawToDigi::fedId_ [private]

GCT FED ID.

Definition at line 77 of file GctRawToDigi.h.

Referenced by GctRawToDigi(), and produce().

GctFormatTranslateBase* GctRawToDigi::formatTranslator_ [private]

Definition at line 86 of file GctRawToDigi.h.

Referenced by autoDetectRequiredFormatTranslator(), doVerboseOutput(), GctRawToDigi(), unpack(), and ~GctRawToDigi().

const unsigned GctRawToDigi::formatVersion_ [private]

Defines unpacker verison to be used (e.g.: "Auto-detect", "MCLegacy", "V35", etc).

Definition at line 82 of file GctRawToDigi.h.

Referenced by GctRawToDigi().

const bool GctRawToDigi::hltMode_ [private]

If true, only outputs the GT output data, and only BX = 0.

Definition at line 80 of file GctRawToDigi.h.

Referenced by autoDetectRequiredFormatTranslator(), GctRawToDigi(), and produce().

edm::InputTag GctRawToDigi::inputLabel_ [private]

FED collection label.

Definition at line 76 of file GctRawToDigi.h.

Referenced by produce().

const unsigned GctRawToDigi::MAX_BLOCKS = 256 [static, private]

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

Definition at line 74 of file GctRawToDigi.h.

Referenced by unpack().

unsigned GctRawToDigi::unpackFailures_ [private]

To count the total number of GCT unpack failures.

Definition at line 88 of file GctRawToDigi.h.

Referenced by autoDetectRequiredFormatTranslator(), endJob(), produce(), and unpack().

const bool GctRawToDigi::unpackSharedRegions_ [private]

Commissioning option: if true, where applicable the shared RCT calo regions will also be unpacked.

Definition at line 81 of file GctRawToDigi.h.

Referenced by autoDetectRequiredFormatTranslator(), and GctRawToDigi().

const bool GctRawToDigi::verbose_ [private]

If true, then debug print out for each event.

Definition at line 83 of file GctRawToDigi.h.

Referenced by unpack().

---

The documentation for this class was generated from the following files:

• EventFilter/GctRawToDigi/plugins/GctRawToDigi.h
• EventFilter/GctRawToDigi/plugins/GctRawToDigi.cc

---