CSCTMBHeader Class Reference

#include <CSCTMBHeader.h>

Public Member Functions
void	add (const std::vector< CSCCLCTDigi > &digis)
	these methods need more brains to figure which one goes first More...
void	add (const std::vector< CSCCorrelatedLCTDigi > &digis)
void	add (const std::vector< CSCShowerDigi > &digis)
void	addALCT0 (const CSCALCTDigi &digi)
void	addALCT1 (const CSCALCTDigi &digi)
void	addAnodeShower (const CSCShowerDigi &digi)
void	addCathodeShower (const CSCShowerDigi &digi)
void	addCLCT0 (const CSCCLCTDigi &digi)
	for data packing More...
void	addCLCT1 (const CSCCLCTDigi &digi)
void	addCorrelatedLCT0 (const CSCCorrelatedLCTDigi &digi)
void	addCorrelatedLCT1 (const CSCCorrelatedLCTDigi &digi)
void	addShower (const CSCShowerDigi &digi)
uint16_t	alctHMT () const
uint16_t	ALCTMatchTime () const
uint16_t	ALCTOnly () const
CSCShowerDigi	anodeShowerDigi (uint32_t idlayer) const
	returns Run3 anode Shower Digi for HMT More...
uint16_t	Bxn0Diff () const
uint16_t	Bxn1Diff () const
uint16_t	BXNCount () const
CSCShowerDigi	cathodeShowerDigi (uint32_t idlayer) const
	returns Run3 cathode Shower Digi for HMT More...
bool	check () const
uint16_t	clct0_ComparatorCode () const
	== Run 3 CSC-GEM Trigger Format More...
uint16_t	clct0_xky () const
uint16_t	clct1_ComparatorCode () const
uint16_t	clct1_xky () const
std::vector< CSCCLCTDigi >	CLCTDigis (uint32_t idlayer)
	returns CLCT digis More...
uint16_t	clctHMT () const
uint16_t	CLCTOnly () const
std::vector< CSCCorrelatedLCTDigi >	CorrelatedLCTDigis (uint32_t idlayer) const
	returns CorrelatedLCT digis More...
	CSCTMBHeader (int firmwareVersion, int firmwareRevision)
	CSCTMBHeader (const CSCTMBStatusDigi &digi)
	CSCTMBHeader (const unsigned short *buf)
unsigned short *	data ()
int	FirmwareRevision () const
int	FirmwareVersion () const
uint16_t	gem_enabled_fibers () const
uint16_t	gem_fifo_pretrig () const
uint16_t	gem_fifo_tbins () const
uint16_t	gem_sync_dataword () const
uint16_t	gem_timing_dataword () const
uint16_t	gem_zero_suppress () const
uint16_t	hmt_ALCTMatchTime () const
uint16_t	hmt_nhits () const
uint16_t	L1ANumber () const
uint16_t	NCFEBs () const
unsigned short int	NHeaderFrames () const
uint16_t	NTBins () const
uint16_t	run3_CLCT_patternID () const
void	setALCTMatchTime (uint16_t alctmatchtime)
void	setEventInformation (const CSCDMBHeader &dmbHeader)
	fills fields like bxn and l1a More...
void	setNCFEBs (uint16_t ncfebs)
CSCShowerDigi	showerDigi (uint32_t idlayer) const
	returns Run3 lct Shower Digi for HMT More...
uint16_t	sizeInBytes () const
unsigned short int	sizeInWords () const
uint16_t	syncError () const
uint16_t	syncErrorCLCT () const
uint16_t	syncErrorMPC0 () const
uint16_t	syncErrorMPC1 () const
CSCTMBHeader2006	tmbHeader2006 () const
CSCTMBHeader2007	tmbHeader2007 () const
	will throw if the cast fails More...
CSCTMBHeader2007_rev0x50c3	tmbHeader2007_rev0x50c3 () const
CSCTMBHeader2013	tmbHeader2013 () const
CSCTMBHeader2020_CCLUT	tmbHeader2020_CCLUT () const
CSCTMBHeader2020_GEM	tmbHeader2020_GEM () const
CSCTMBHeader2020_Run2	tmbHeader2020_Run2 () const
CSCTMBHeader2020_TMB	tmbHeader2020_TMB () const
uint16_t	TMBMatch () const

Static Public Member Functions
static void	selfTest (int firmwwareVersion, int firmwareRevision)
	tests that packing and unpacking give same results More...
static void	setDebug (const bool value)

Private Attributes
int	theFirmwareVersion
std::shared_ptr< CSCVTMBHeaderFormat >	theHeaderFormat

Static Private Attributes
static std::atomic< bool >	debug {false}

Friends
std::ostream &	operator<< (std::ostream &os, const CSCTMBHeader &hdr)

Detailed Description

Definition at line 31 of file CSCTMBHeader.h.

Constructor & Destructor Documentation

CSCTMBHeader() [1/3]

CSCTMBHeader::CSCTMBHeader	(	int	firmwareVersion,
		int	firmwareRevision
	)

Copper TMB hybrid fw Run2 CLCT + Run3 LCT/MPC + anode-only HMT (March 2022)

Definition at line 24 of file CSCTMBHeader.cc.

References simCaloStage2Layer1Digis_cfi::firmwareVersion, and theHeaderFormat.

    : theHeaderFormat(), theFirmwareVersion(firmwareVersion) {
  if (firmwareVersion == 2020) {
    if ((firmwareRevision < 0x4000) && (firmwareRevision > 0x0)) { /* New (O)TMB firmware revision format */
      bool isGEM_fw = false;
      bool isCCLUT_HMT_fw = false;
      bool isOTMB_Run2_fw = false;
      bool isTMB_Run3_fw = false;
      bool isTMB_Run2_fw = false;
      bool isTMB_hybrid_fw = false;  
      bool isRun2_df = false;
      unsigned df_version = (firmwareRevision >> 9) & 0xF;  // 4-bits Data Format version
      unsigned major_ver = (firmwareRevision >> 5) & 0xF;   // 4-bits major version part
      // unsigned minor_ver = firmwareRevision & 0x1F;         // 5-bits minor version part
      switch (df_version) {
        case 0x4:
          isTMB_hybrid_fw = true;
          break;
        case 0x3:
          isGEM_fw = true;
          break;
        case 0x2:
          isCCLUT_HMT_fw = true;
          break;
        case 0x1:
          isOTMB_Run2_fw = true;
          break;
        case 0x0:
          if (major_ver == 1)
            isTMB_Run2_fw = true;
          else
            isTMB_Run3_fw = true;
          break;
        default:
          isGEM_fw = true;
      }
      if (major_ver == 1) {
        isRun2_df = true;
      }

      if (isGEM_fw) {
        if (isRun2_df) {
          theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_Run2(firmwareRevision));
        } else {
          theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_GEM());
        }
      } else if (isCCLUT_HMT_fw) {
        if (isRun2_df) {
          theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_Run2(firmwareRevision));
        } else {
          theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_CCLUT());
        }
      } else if (isOTMB_Run2_fw || isTMB_Run2_fw || isRun2_df) {
        theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_Run2(firmwareRevision));
      } else if (isTMB_Run3_fw) {
        theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_CCLUT());
      } else if (isTMB_hybrid_fw) {
        theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_TMB());
      }
    }
  } else if (firmwareVersion == 2013) {
    theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2013());
  } else if (firmwareVersion == 2006) {
    theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2006());
  } else if (firmwareVersion == 2007) {
    /* Checks for TMB2007 firmware revisions ranges to detect data format
       * rev.0x50c3 - first revision with changed format
       * rev.0x42D5 - oldest known from 06/21/2007
       * There is 4-bits year value rollover in revision number (0 in 2016)
       */
    if ((firmwareRevision >= 0x50c3) || (firmwareRevision < 0x42D5)) {
      // if (firmwareRevision >= 0x7a76) // First OTMB firmware revision with 2013 format
      /* Revisions > 0x6000 - OTMB firmwares, < 0x42D5 - new TMB revisions in 2016 */
      if ((firmwareRevision >= 0x6000) || (firmwareRevision < 0x42D5)) {
        bool isGEMfirmware = false;
        /* There are OTMB2013 firmware versions exist, which reports firmwareRevision code = 0x0 */
        if ((firmwareRevision < 0x4000) && (firmwareRevision > 0x0)) { /* New (O)TMB firmware revision format */
          if (((firmwareRevision >> 9) & 0x3) == 0x3)
            isGEMfirmware = true;
          if (isGEMfirmware) {
            theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_GEM());
          } else {
            theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2013());
          }
        }
      } else {
        theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2007_rev0x50c3());
      }
    } else {
      theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2007());
    }
  } else {
    edm::LogError("CSCTMBHeader|CSCRawToDigi") << "failed to determine TMB firmware version!!";
  }
}

CSCTMBHeader() [2/3]

CSCTMBHeader::CSCTMBHeader

(

const CSCTMBStatusDigi &

digi

)

CSCTMBHeader() [3/3]

CSCTMBHeader::CSCTMBHeader

(

const unsigned short *

buf

)

first determine the format

Run3 ME11+GE11 OTMB fw with CCLUT and HMT

Run3 MEx1 OTMB fw with CCLUT and HMT

Run2-compatible data format OTMB fw with Run3 revision code format

Copper TMB hybrid fw Run2 CLCT + Run3 LCT/MPC + anode-only HMT (March 2022)

Definition at line 124 of file CSCTMBHeader.cc.

References visDQMUpload::buf, theFirmwareVersion, and theHeaderFormat.

                                                    : theHeaderFormat() {
  if (buf[0] == 0xDB0C) {
    theFirmwareVersion = 2007;
    theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2007(buf));
    /* Checks for TMB2007 firmware revisions ranges to detect data format
       * rev.0x50c3 - first revision with changed format
       * rev.0x42D5 - oldest known from 06/21/2007
       * There is 4-bits year value rollover in revision number (0 in 2016)
       */
    if ((theHeaderFormat->firmwareRevision() >= 0x50c3) || (theHeaderFormat->firmwareRevision() < 0x42D5)) {
      // if (theHeaderFormat->firmwareRevision() >= 0x7a76) // First OTMB firmware revision with 2013 format
      /* Revisions > 0x6000 - OTMB firmwares, < 0x42D5 - new TMB revisions in 2016 */
      if ((theHeaderFormat->firmwareRevision() >= 0x6000) || (theHeaderFormat->firmwareRevision() < 0x42D5)) {
        theFirmwareVersion = 2013;
        bool isGEM_fw = false;        
        bool isCCLUT_HMT_fw = false;  
        bool isOTMB_Run2_fw = false;  
        bool isTMB_Run3_fw = false;
        bool isTMB_Run2_fw = false;
        bool isTMB_hybrid_fw = false;  
        bool isRun2_df = false;
        unsigned firmwareRevision = theHeaderFormat->firmwareRevision();
        /* There are OTMB2013 firmware versions exist, which reports firmwareRevision code = 0x0 */
        if ((firmwareRevision < 0x4000) && (firmwareRevision > 0x0)) { /* New (O)TMB firmware revision format */
          theFirmwareVersion = 2020;
          unsigned df_version = (firmwareRevision >> 9) & 0xF;  // 4-bits Data Format version
          unsigned major_ver = (firmwareRevision >> 5) & 0xF;   // 4-bits major version part
          // unsigned minor_ver = firmwareRevision & 0x1F;         // 5-bits minor version part
          switch (df_version) {
            case 0x4:
              isTMB_hybrid_fw = true;
              break;
            case 0x3:
              isGEM_fw = true;
              break;
            case 0x2:
              isCCLUT_HMT_fw = true;
              break;
            case 0x1:
              isOTMB_Run2_fw = true;
              break;
            case 0x0:
              if (major_ver == 1)
                isTMB_Run2_fw = true;
              else
                isTMB_Run3_fw = true;
              break;
            default:
              isGEM_fw = true;
          }
          if (major_ver == 1) {
            isRun2_df = true;
          }
        }
        if (theFirmwareVersion == 2020) {
          if (isGEM_fw) {
            if (isRun2_df) {
              theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_Run2(buf));
            } else {
              theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_GEM(buf));
            }
          } else if (isCCLUT_HMT_fw) {
            if (isRun2_df) {
              theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_Run2(buf));
            } else {
              theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_CCLUT(buf));
            }
          } else if (isOTMB_Run2_fw || isTMB_Run2_fw || isRun2_df) {
            theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_Run2(buf));
          } else if (isTMB_Run3_fw) {
            theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_CCLUT(buf));
          } else if (isTMB_hybrid_fw) {
            theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2020_TMB(buf));
          }

        } else {
          theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2013(buf));
        }

      } else {
        theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2007_rev0x50c3(buf));
      }
    }

  } else if (buf[0] == 0x6B0C) {
    theFirmwareVersion = 2006;
    theHeaderFormat = std::shared_ptr<CSCVTMBHeaderFormat>(new CSCTMBHeader2006(buf));
  } else {
    edm::LogError("CSCTMBHeader|CSCRawToDigi") << "failed to determine TMB firmware version!!";
  }
}

Member Function Documentation

add() [1/3]

void CSCTMBHeader::add

(

const std::vector< CSCCLCTDigi > &

digis

)

these methods need more brains to figure which one goes first

Definition at line 250 of file CSCTMBHeader.cc.

References addCLCT0(), and addCLCT1().

Referenced by CSCEventData::add(), counter.Counter::register(), SequenceTypes._TaskBase::remove(), and SequenceTypes._TaskBase::replace().

                                                          {
  // sort???
  if (!digis.empty()) {
    addCLCT0(digis[0]);
  }
  if (digis.size() > 1)
    addCLCT1(digis[1]);
}

add() [2/3]

void CSCTMBHeader::add

(

const std::vector< CSCCorrelatedLCTDigi > &

digis

)

Definition at line 259 of file CSCTMBHeader.cc.

References addCorrelatedLCT0(), and addCorrelatedLCT1().

Referenced by counter.Counter::register(), SequenceTypes._TaskBase::remove(), and SequenceTypes._TaskBase::replace().

                                                                   {
  // sort???
  if (!digis.empty())
    addCorrelatedLCT0(digis[0]);
  if (digis.size() > 1)
    addCorrelatedLCT1(digis[1]);
}

add() [3/3]

void CSCTMBHeader::add

(

const std::vector< CSCShowerDigi > &

digis

)

Definition at line 267 of file CSCTMBHeader.cc.

References theHeaderFormat.

Referenced by counter.Counter::register(), SequenceTypes._TaskBase::remove(), and SequenceTypes._TaskBase::replace().

                                                            {
  if (!digis.empty())
    theHeaderFormat->addShower(digis[0]);
}

addALCT0()

void CSCTMBHeader::addALCT0 ( const CSCALCTDigi &  digi )

inline

Definition at line 124 of file CSCTMBHeader.h.

References theHeaderFormat.

{ theHeaderFormat->addALCT0(digi); }

addALCT1()

void CSCTMBHeader::addALCT1 ( const CSCALCTDigi &  digi )

inline

Definition at line 125 of file CSCTMBHeader.h.

References theHeaderFormat.

{ theHeaderFormat->addALCT1(digi); }

addAnodeShower()

void CSCTMBHeader::addAnodeShower ( const CSCShowerDigi &  digi )

inline

Definition at line 131 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCEventData::addAnodeShower().

{ theHeaderFormat->addAnodeShower(digi); }

addCathodeShower()

void CSCTMBHeader::addCathodeShower ( const CSCShowerDigi &  digi )

inline

Definition at line 133 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCEventData::addCathodeShower().

{ theHeaderFormat->addCathodeShower(digi); }

addCLCT0()

void CSCTMBHeader::addCLCT0 ( const CSCCLCTDigi &  digi )

inline

for data packing

Definition at line 122 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by add(), and selfTest().

{ theHeaderFormat->addCLCT0(digi); }

addCLCT1()

void CSCTMBHeader::addCLCT1 ( const CSCCLCTDigi &  digi )

inline

Definition at line 123 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by add(), and selfTest().

{ theHeaderFormat->addCLCT1(digi); }

addCorrelatedLCT0()

void CSCTMBHeader::addCorrelatedLCT0 ( const CSCCorrelatedLCTDigi &  digi )

inline

Definition at line 126 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by add(), and selfTest().

{ theHeaderFormat->addCorrelatedLCT0(digi); }

addCorrelatedLCT1()

void CSCTMBHeader::addCorrelatedLCT1 ( const CSCCorrelatedLCTDigi &  digi )

inline

Definition at line 127 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by add(), and selfTest().

{ theHeaderFormat->addCorrelatedLCT1(digi); }

addShower()

void CSCTMBHeader::addShower ( const CSCShowerDigi &  digi )

inline

Definition at line 129 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCEventData::addShower().

{ theHeaderFormat->addShower(digi); }

alctHMT()

uint16_t CSCTMBHeader::alctHMT ( ) const

inline

Definition at line 84 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->alctHMT(); }

ALCTMatchTime()

uint16_t CSCTMBHeader::ALCTMatchTime ( ) const

inline

Definition at line 44 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCOfflineMonitor::doBXMonitor(), CSCValidation::doTimeMonitoring(), and cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->ALCTMatchTime(); }

ALCTOnly()

uint16_t CSCTMBHeader::ALCTOnly ( ) const

inline

Definition at line 47 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->ALCTOnly(); }

anodeShowerDigi()

CSCShowerDigi CSCTMBHeader::anodeShowerDigi ( uint32_t  idlayer ) const

inline

returns Run3 anode Shower Digi for HMT

Definition at line 96 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->anodeShowerDigi(idlayer); }

Bxn0Diff()

uint16_t CSCTMBHeader::Bxn0Diff ( ) const

inline

Definition at line 50 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->Bxn0Diff(); }

Bxn1Diff()

uint16_t CSCTMBHeader::Bxn1Diff ( ) const

inline

Definition at line 51 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->Bxn1Diff(); }

BXNCount()

uint16_t CSCTMBHeader::BXNCount ( ) const

inline

Definition at line 43 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCOfflineMonitor::doBXMonitor(), CSCValidation::doTimeMonitoring(), and cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->BXNCount(); }

cathodeShowerDigi()

CSCShowerDigi CSCTMBHeader::cathodeShowerDigi ( uint32_t  idlayer ) const

inline

returns Run3 cathode Shower Digi for HMT

Definition at line 98 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->cathodeShowerDigi(idlayer); }

check()

bool CSCTMBHeader::check ( ) const

inline

Definition at line 119 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCTMBData::UnpackTMB().

{ return theHeaderFormat->check(); }

clct0_ComparatorCode()

uint16_t CSCTMBHeader::clct0_ComparatorCode ( ) const

inline

== Run 3 CSC-GEM Trigger Format

Definition at line 78 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->clct0_ComparatorCode(); }

clct0_xky()

uint16_t CSCTMBHeader::clct0_xky ( ) const

inline

Definition at line 80 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->clct0_xky(); }

clct1_ComparatorCode()

uint16_t CSCTMBHeader::clct1_ComparatorCode ( ) const

inline

Definition at line 79 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->clct1_ComparatorCode(); }

clct1_xky()

uint16_t CSCTMBHeader::clct1_xky ( ) const

inline

Definition at line 81 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->clct1_xky(); }

CLCTDigis()

std::vector<CSCCLCTDigi> CSCTMBHeader::CLCTDigis ( uint32_t  idlayer )

inline

returns CLCT digis

Definition at line 101 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC(), CSCEventData::selfTest(), and selfTest().

{ return theHeaderFormat->CLCTDigis(idlayer); }

clctHMT()

uint16_t CSCTMBHeader::clctHMT ( ) const

inline

Definition at line 85 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->clctHMT(); }

CLCTOnly()

uint16_t CSCTMBHeader::CLCTOnly ( ) const

inline

Definition at line 46 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->CLCTOnly(); }

CorrelatedLCTDigis()

std::vector<CSCCorrelatedLCTDigi> CSCTMBHeader::CorrelatedLCTDigis ( uint32_t  idlayer ) const

inline

returns CorrelatedLCT digis

Definition at line 104 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC(), CSCEventData::selfTest(), and selfTest().

                                                                             {
    return theHeaderFormat->CorrelatedLCTDigis(idlayer);
  }

data()

unsigned short* CSCTMBHeader::data ( )

inline

Definition at line 114 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCTMBData::pack(), and selfTest().

{ return theHeaderFormat->data(); }

FirmwareRevision()

int CSCTMBHeader::FirmwareRevision ( ) const

inline

Definition at line 41 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->firmwareRevision(); }

FirmwareVersion()

int CSCTMBHeader::FirmwareVersion ( ) const

inline

Definition at line 40 of file CSCTMBHeader.h.

References theFirmwareVersion.

Referenced by CSCComparatorData::CSCComparatorData(), cscdqm::EventProcessor::processCSC(), and CSCTMBData::UnpackTMB().

{ return theFirmwareVersion; }

gem_enabled_fibers()

uint16_t CSCTMBHeader::gem_enabled_fibers ( ) const

inline

Definition at line 86 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->gem_enabled_fibers(); }

gem_fifo_pretrig()

uint16_t CSCTMBHeader::gem_fifo_pretrig ( ) const

inline

Definition at line 88 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->gem_fifo_pretrig(); }

gem_fifo_tbins()

uint16_t CSCTMBHeader::gem_fifo_tbins ( ) const

inline

Definition at line 87 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->gem_fifo_tbins(); }

gem_sync_dataword()

uint16_t CSCTMBHeader::gem_sync_dataword ( ) const

inline

Definition at line 90 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->gem_sync_dataword(); }

gem_timing_dataword()

uint16_t CSCTMBHeader::gem_timing_dataword ( ) const

inline

Definition at line 91 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->gem_timing_dataword(); }

gem_zero_suppress()

uint16_t CSCTMBHeader::gem_zero_suppress ( ) const

inline

Definition at line 89 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->gem_zero_suppress(); }

hmt_ALCTMatchTime()

uint16_t CSCTMBHeader::hmt_ALCTMatchTime ( ) const

inline

Definition at line 83 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->hmt_ALCTMatchTime(); }

hmt_nhits()

uint16_t CSCTMBHeader::hmt_nhits ( ) const

inline

Definition at line 82 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->hmt_nhits(); }

L1ANumber()

uint16_t CSCTMBHeader::L1ANumber ( ) const

inline

Definition at line 53 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->L1ANumber(); }

NCFEBs()

uint16_t CSCTMBHeader::NCFEBs ( ) const

inline

Definition at line 68 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC(), and CSCTMBData::UnpackTMB().

{ return theHeaderFormat->NCFEBs(); }

NHeaderFrames()

unsigned short int CSCTMBHeader::NHeaderFrames ( ) const

inline

Definition at line 112 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->NHeaderFrames(); }

NTBins()

uint16_t CSCTMBHeader::NTBins ( ) const

inline

Definition at line 67 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCTMBData::UnpackTMB().

{ return theHeaderFormat->NTBins(); }

run3_CLCT_patternID()

uint16_t CSCTMBHeader::run3_CLCT_patternID ( ) const

inline

Definition at line 92 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->run3_CLCT_patternID(); }

selfTest()

void CSCTMBHeader::selfTest ( int  firmwwareVersion, int  firmwareRevision  )

static

tests that packing and unpacking give same results

Definition at line 336 of file CSCTMBHeader.cc.

References addCLCT0(), addCLCT1(), addCorrelatedLCT0(), addCorrelatedLCT1(), cms::cuda::assert(), CLCTDigis(), CorrelatedLCTDigis(), gather_cfg::cout, cscPackerCompare(), data(), debug, simCaloStage2Layer1Digis_cfi::firmwareVersion, DetId::rawId(), CSCCLCTDigi::Run3, CSCCorrelatedLCTDigi::Run3, and relativeConstraints::station.

                                                                     {
  constexpr bool debug = false;

  // tests packing and unpacking
  for (int station = 1; station <= 4; ++station) {
    for (int iendcap = 1; iendcap <= 2; ++iendcap) {
      CSCDetId detId(iendcap, station, 1, 1, 0);

      // the next-to-last is the BX, which only gets
      // saved in two bits and must be the same for clct0 and clct1.
      //CSCCLCTDigi clct0(1, 1, 4, 0, 0, 30, 3, 0, 1); // valid for 2006
      // In 2007 firmware, there are no distrips, so the 4th argument (strip
      // type) should always be set to 1 (halfstrips).
      CSCCLCTDigi clct0(1, 1, 4, 1, 0, 30, 4, 2, 1);  // valid for 2007
      CSCCLCTDigi clct1(1, 1, 3, 1, 1, 31, 1, 2, 2);

      // BX of LCT (8th argument) is 1-bit word (the least-significant bit
      // of ALCT's bx).
      CSCCorrelatedLCTDigi lct0(1, 1, 2, 10, 98, 5, 0, 1, 0, 0, 0, 0);
      CSCCorrelatedLCTDigi lct1(2, 1, 2, 20, 15, 9, 1, 0, 0, 0, 0, 0);

      // Use Run3 format digis for TMB firmwareVersion 2020
      // and revision codes for MEx1 CCLUT, ME11 CCLUT/GEM
      if (firmwareVersion >= 2020) {
        bool isGEM_fw = false;
        bool isCCLUT_HMT_fw = false;
        bool isOTMB_Run2_fw = false;
        bool isTMB_Run3_fw = false;
        bool isTMB_Run2_fw = false;
        bool isTMB_hybrid_fw = false;
        bool isRun2_df = false;
        unsigned df_version = (firmwareRevision >> 9) & 0xF;  // 4-bits Data Format version
        unsigned major_ver = (firmwareRevision >> 5) & 0xF;   // 4-bits major version part
        // unsigned minor_ver = firmwareRevision & 0x1F;         // 5-bits minor version part
        switch (df_version) {
          case 0x4:
            isTMB_hybrid_fw = true;
            break;
          case 0x3:
            isGEM_fw = true;
            break;
          case 0x2:
            isCCLUT_HMT_fw = true;
            break;
          case 0x1:
            isOTMB_Run2_fw = true;
            break;
          case 0x0:
            if (major_ver == 1)
              isTMB_Run2_fw = true;
            else
              isTMB_Run3_fw = true;
            break;
          default:
            isGEM_fw = true;
        }
        if (major_ver == 1) {
          isRun2_df = true;
        }
        if ((isGEM_fw || isCCLUT_HMT_fw || isTMB_Run3_fw) && !isRun2_df && !isOTMB_Run2_fw && !isTMB_Run2_fw &&
            !isTMB_hybrid_fw) {
          clct0 = CSCCLCTDigi(
              1, 6, 6, 1, 0, (120 % 32), (120 / 32), 2, 1, 3, 0xebf, CSCCLCTDigi::Version::Run3, true, false, 2, 6);
          clct1 = CSCCLCTDigi(
              1, 6, 3, 1, 1, (132 % 32), (132 / 32), 2, 2, 3, 0xe54, CSCCLCTDigi::Version::Run3, false, true, 1, 15);
        }
        if ((isGEM_fw || isCCLUT_HMT_fw || isTMB_Run3_fw) && !isRun2_df && !isOTMB_Run2_fw && !isTMB_Run2_fw &&
            !isTMB_hybrid_fw) {
          lct0 = CSCCorrelatedLCTDigi(
              1, 1, 3, 85, 120, 6, 0, 0, 0, 0, 0, 0, CSCCorrelatedLCTDigi::Version::Run3, true, false, 2, 6);
          lct1 = CSCCorrelatedLCTDigi(
              2, 1, 2, 81, 132, 3, 1, 0, 0, 0, 0, 0, CSCCorrelatedLCTDigi::Version::Run3, false, true, 0, 15);
        }
        if (isTMB_hybrid_fw) {
          lct0 = CSCCorrelatedLCTDigi(
              1, 1, 3, 85, 120, 6, 0, 0, 0, 0, 0, 0, CSCCorrelatedLCTDigi::Version::Run3, false, false, 0, 0);
          lct1 = CSCCorrelatedLCTDigi(
              2, 1, 2, 81, 132, 3, 1, 0, 0, 0, 0, 0, CSCCorrelatedLCTDigi::Version::Run3, false, false, 0, 0);
        }
      }

      CSCTMBHeader tmbHeader(firmwareVersion, firmwareRevision);
      tmbHeader.addCLCT0(clct0);
      tmbHeader.addCLCT1(clct1);
      tmbHeader.addCorrelatedLCT0(lct0);
      tmbHeader.addCorrelatedLCT1(lct1);
      std::vector<CSCCLCTDigi> clcts = tmbHeader.CLCTDigis(detId.rawId());
      // guess they got reordered
      assert(cscPackerCompare(clcts[0], clct0));
      assert(cscPackerCompare(clcts[1], clct1));
      if (debug) {
        std::cout << "Match for: " << clct0 << "\n";
        std::cout << "           " << clct1 << "\n \n";
      }

      std::vector<CSCCorrelatedLCTDigi> lcts = tmbHeader.CorrelatedLCTDigis(detId.rawId());
      assert(cscPackerCompare(lcts[0], lct0));
      assert(cscPackerCompare(lcts[1], lct1));
      if (debug) {
        std::cout << "Match for: " << lct0 << "\n";
        std::cout << "           " << lct1 << "\n";
      }

      // try packing and re-packing, to make sure they're the same
      unsigned short int *data = tmbHeader.data();
      CSCTMBHeader newHeader(data);
      clcts = newHeader.CLCTDigis(detId.rawId());
      assert(cscPackerCompare(clcts[0], clct0));
      assert(cscPackerCompare(clcts[1], clct1));
      lcts = newHeader.CorrelatedLCTDigis(detId.rawId());
      assert(cscPackerCompare(lcts[0], lct0));
      assert(cscPackerCompare(lcts[1], lct1));
    }
  }
}

setALCTMatchTime()

void CSCTMBHeader::setALCTMatchTime ( uint16_t  alctmatchtime )

inline

Definition at line 45 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCEventData::add().

{ theHeaderFormat->setALCTMatchTime(alctmatchtime); }

setDebug()

static void CSCTMBHeader::setDebug ( const bool  value )

inlinestatic

turns on/off debug flag for this class

Definition at line 117 of file CSCTMBHeader.h.

References debug, and relativeConstraints::value.

Referenced by CSCDCCUnpacker::CSCDCCUnpacker().

{ debug = value; }

setEventInformation()

void CSCTMBHeader::setEventInformation ( const CSCDMBHeader &  dmbHeader )

inline

fills fields like bxn and l1a

Definition at line 38 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCEventData::checkTMBClasses(), and CSCEventData::setEventInformation().

{ theHeaderFormat->setEventInformation(dmbHeader); }

setNCFEBs()

void CSCTMBHeader::setNCFEBs ( uint16_t  ncfebs )

inline

Definition at line 75 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCEventData::checkTMBClasses(), CSCTMBData::CSCTMBData(), and CSCEventData::setEventInformation().

{ theHeaderFormat->setNCFEBs(ncfebs); }

showerDigi()

CSCShowerDigi CSCTMBHeader::showerDigi ( uint32_t  idlayer ) const

inline

returns Run3 lct Shower Digi for HMT

Definition at line 94 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->showerDigi(idlayer); }

sizeInBytes()

uint16_t CSCTMBHeader::sizeInBytes ( ) const

inline

Definition at line 55 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->sizeInWords() * 2; }

sizeInWords()

unsigned short int CSCTMBHeader::sizeInWords ( ) const

inline

in 16-bit words. Add olne because we include beginning(b0c) and end (e0c) flags

Definition at line 110 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by CSCTMBData::CSCTMBData(), CSCTMBData::pack(), and CSCTMBData::UnpackTMB().

{ return theHeaderFormat->sizeInWords(); }

syncError()

uint16_t CSCTMBHeader::syncError ( ) const

inline

Definition at line 70 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->syncError(); }

syncErrorCLCT()

uint16_t CSCTMBHeader::syncErrorCLCT ( ) const

inline

Definition at line 71 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->syncErrorCLCT(); }

syncErrorMPC0()

uint16_t CSCTMBHeader::syncErrorMPC0 ( ) const

inline

Definition at line 72 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->syncErrorMPC0(); }

syncErrorMPC1()

uint16_t CSCTMBHeader::syncErrorMPC1 ( ) const

inline

Definition at line 73 of file CSCTMBHeader.h.

References theHeaderFormat.

{ return theHeaderFormat->syncErrorMPC1(); }

tmbHeader2006()

CSCTMBHeader2006 CSCTMBHeader::tmbHeader2006

(

)

const

Definition at line 328 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

                                                   {
  CSCTMBHeader2006 *result = dynamic_cast<CSCTMBHeader2006 *>(theHeaderFormat.get());
  if (result == nullptr) {
    throw cms::Exception("Could not get 2006 TMB header format");
  }
  return *result;
}

tmbHeader2007()

CSCTMBHeader2007 CSCTMBHeader::tmbHeader2007

(

)

const

will throw if the cast fails

Definition at line 272 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

                                                   {
  CSCTMBHeader2007 *result = dynamic_cast<CSCTMBHeader2007 *>(theHeaderFormat.get());
  if (result == nullptr) {
    throw cms::Exception("Could not get 2007 TMB header format");
  }
  return *result;
}

tmbHeader2007_rev0x50c3()

CSCTMBHeader2007_rev0x50c3 CSCTMBHeader::tmbHeader2007_rev0x50c3

(

)

const

Definition at line 280 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

                                                                       {
  CSCTMBHeader2007_rev0x50c3 *result = dynamic_cast<CSCTMBHeader2007_rev0x50c3 *>(theHeaderFormat.get());
  if (result == nullptr) {
    throw cms::Exception("Could not get 2007 rev0x50c3 TMB header format");
  }
  return *result;
}

tmbHeader2013()

CSCTMBHeader2013 CSCTMBHeader::tmbHeader2013

(

)

const

Definition at line 288 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

                                                   {
  CSCTMBHeader2013 *result = dynamic_cast<CSCTMBHeader2013 *>(theHeaderFormat.get());
  if (result == nullptr) {
    throw cms::Exception("Could not get 2013 TMB header format");
  }
  return *result;
}

tmbHeader2020_CCLUT()

CSCTMBHeader2020_CCLUT CSCTMBHeader::tmbHeader2020_CCLUT

(

)

const

Definition at line 304 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

                                                               {
  CSCTMBHeader2020_CCLUT *result = dynamic_cast<CSCTMBHeader2020_CCLUT *>(theHeaderFormat.get());
  if (result == nullptr) {
    throw cms::Exception("Could not get 2020 (O)TMB CCLUT header format");
  }
  return *result;
}

tmbHeader2020_GEM()

CSCTMBHeader2020_GEM CSCTMBHeader::tmbHeader2020_GEM

(

)

const

Definition at line 312 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

                                                           {
  CSCTMBHeader2020_GEM *result = dynamic_cast<CSCTMBHeader2020_GEM *>(theHeaderFormat.get());
  if (result == nullptr) {
    throw cms::Exception("Could not get 2020 (O)TMB GEM header format");
  }
  return *result;
}

tmbHeader2020_Run2()

CSCTMBHeader2020_Run2 CSCTMBHeader::tmbHeader2020_Run2

(

)

const

Definition at line 320 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

                                                             {
  CSCTMBHeader2020_Run2 *result = dynamic_cast<CSCTMBHeader2020_Run2 *>(theHeaderFormat.get());
  if (result == nullptr) {
    throw cms::Exception("Could not get 2020 (O)TMB legacy Run2 header format");
  }
  return *result;
}

tmbHeader2020_TMB()

CSCTMBHeader2020_TMB CSCTMBHeader::tmbHeader2020_TMB

(

)

const

Definition at line 296 of file CSCTMBHeader.cc.

References Exception, mps_fire::result, and theHeaderFormat.

                                                           {
  CSCTMBHeader2020_TMB *result = dynamic_cast<CSCTMBHeader2020_TMB *>(theHeaderFormat.get());
  if (result == nullptr) {
    throw cms::Exception("Could not get 2020 TMB Run3 header format");
  }
  return *result;
}

TMBMatch()

uint16_t CSCTMBHeader::TMBMatch ( ) const

inline

Definition at line 48 of file CSCTMBHeader.h.

References theHeaderFormat.

Referenced by cscdqm::EventProcessor::processCSC().

{ return theHeaderFormat->TMBMatch(); }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const CSCTMBHeader &  hdr  )

friend

Definition at line 452 of file CSCTMBHeader.cc.

                                                                {
  hdr.theHeaderFormat->print(os);
  return os;
}

Member Data Documentation

debug

std::atomic< bool > CSCTMBHeader::debug {false}

staticprivate

Definition at line 151 of file CSCTMBHeader.h.

Referenced by util.rrapi.RRApi::dprint(), rrapi.RRApi::dprint(), pkg.AbstractPkg::generate(), util.rrapi.RRApi::get(), rrapi.RRApi::get(), pkg.AbstractPkg::get_kwds(), runTauIdMVA.TauIDEmbedder::loadMVA_WPs_run2_2017(), runTauIdMVA.TauIDEmbedder::runTauID(), selfTest(), setDebug(), and pkg.AbstractPkg::write().

theFirmwareVersion

int CSCTMBHeader::theFirmwareVersion

private

Definition at line 155 of file CSCTMBHeader.h.

Referenced by CSCTMBHeader(), and FirmwareVersion().

theHeaderFormat

std::shared_ptr<CSCVTMBHeaderFormat> CSCTMBHeader::theHeaderFormat

private

Definition at line 154 of file CSCTMBHeader.h.

Referenced by add(), addALCT0(), addALCT1(), addAnodeShower(), addCathodeShower(), addCLCT0(), addCLCT1(), addCorrelatedLCT0(), addCorrelatedLCT1(), addShower(), alctHMT(), ALCTMatchTime(), ALCTOnly(), anodeShowerDigi(), Bxn0Diff(), Bxn1Diff(), BXNCount(), cathodeShowerDigi(), check(), clct0_ComparatorCode(), clct0_xky(), clct1_ComparatorCode(), clct1_xky(), CLCTDigis(), clctHMT(), CLCTOnly(), CorrelatedLCTDigis(), CSCTMBHeader(), data(), FirmwareRevision(), gem_enabled_fibers(), gem_fifo_pretrig(), gem_fifo_tbins(), gem_sync_dataword(), gem_timing_dataword(), gem_zero_suppress(), hmt_ALCTMatchTime(), hmt_nhits(), L1ANumber(), NCFEBs(), NHeaderFrames(), NTBins(), operator<<(), run3_CLCT_patternID(), setALCTMatchTime(), setEventInformation(), setNCFEBs(), showerDigi(), sizeInBytes(), sizeInWords(), syncError(), syncErrorCLCT(), syncErrorMPC0(), syncErrorMPC1(), tmbHeader2006(), tmbHeader2007(), tmbHeader2007_rev0x50c3(), tmbHeader2013(), tmbHeader2020_CCLUT(), tmbHeader2020_GEM(), tmbHeader2020_Run2(), tmbHeader2020_TMB(), and TMBMatch().