#include <L1Trigger/L1GctAnalzyer/src/GctFibreAnalyzer.cc>

Inheritance diagram for GctFibreAnalyzer:

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

	~GctFibreAnalyzer () override

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

	EDAnalyzer ()

SerialTaskQueue *	globalLuminosityBlocksQueue ()

SerialTaskQueue *	globalRunsQueue ()

ModuleDescription const &	moduleDescription () const

std::string	workerType () const

	~EDAnalyzer () override

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

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const

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

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

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

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

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

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Private Member Functions
void	analyze (const edm::Event &, const edm::EventSetup &) override

void	CheckCounter (const L1GctFibreWord fibre)

bool	CheckFibreWord (const L1GctFibreWord fibre)

bool	CheckForBC0 (const L1GctFibreWord fibre)

void	CheckLogicalID (const L1GctFibreWord fibre)

Private Attributes
bool	m_doCounter

bool	m_doLogicalID

edm::InputTag	m_fibreSource

unsigned int	m_numConsistentEvents

unsigned int	m_numInconsistentPayloadEvents

unsigned int	m_numZeroEvents

Additional Inherited Members
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

static bool	wantsGlobalLuminosityBlocks ()

static bool	wantsGlobalRuns ()

static bool	wantsStreamLuminosityBlocks ()

static bool	wantsStreamRuns ()

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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

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: Analyzer individual fibre channels from the source card.

Definition at line 32 of file GctFibreAnalyzer.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 26 of file GctFibreAnalyzer.cc.

                                                                 :
   m_fibreSource(iConfig.getUntrackedParameter<edm::InputTag>("FibreSource")),
   m_doLogicalID(iConfig.getUntrackedParameter<bool>("doLogicalID")),
   m_doCounter(iConfig.getUntrackedParameter<bool>("doCounter")),
   m_numZeroEvents(0),
   m_numInconsistentPayloadEvents(0),
   m_numConsistentEvents(0)
 {
 }

GctFibreAnalyzer::~GctFibreAnalyzer ( )

override

Definition at line 36 of file GctFibreAnalyzer.cc.

References m_doCounter, m_numConsistentEvents, m_numInconsistentPayloadEvents, and m_numZeroEvents.

 {
   edm::LogInfo("Zero Fibreword events") << "Total number of events with zero fibrewords: " << m_numZeroEvents;
   edm::LogInfo("Inconsistent Payload events") << "Total number of events with inconsistent payloads: " << m_numInconsistentPayloadEvents;
   if(m_doCounter){edm::LogInfo("Successful events") << "Total number of Successful events: " << m_numConsistentEvents;}
 }

Member Function Documentation

void GctFibreAnalyzer::analyze	(	const edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overrideprivate

Definition at line 43 of file GctFibreAnalyzer.cc.

References CheckCounter(), CheckFibreWord(), CheckForBC0(), CheckLogicalID(), f, edm::Event::getByLabel(), m_doCounter, m_doLogicalID, m_fibreSource, m_numConsistentEvents, m_numInconsistentPayloadEvents, and m_numZeroEvents.

 {
   using namespace edm;
   
   Handle<L1GctFibreCollection> fibre;
   iEvent.getByLabel(m_fibreSource,fibre);
 
   bool bc0= false;
   int flag_for_zeroes = 0;
   int flag_for_inconsistent_events = 0;
   unsigned int flag_for_consistency = 0;
   int flag_for_consistent_events = 0;
 
   for (L1GctFibreCollection::const_iterator f=fibre->begin(); f!=fibre->end(); f++){
     
     if (f->data()!=0)
       {
         if(m_doCounter) 
           {
             if(f==fibre->begin()) {flag_for_consistency = f->data();}
             else if(flag_for_consistency == f->data()){flag_for_consistent_events++;}
           }
 
         // Check for corrupt fibre data
         if (!CheckFibreWord(*f)){
           edm::LogInfo("GCT fibre data error") << "Missing phase bit (clock) in fibre data " << (*f);
         }
     
         // Check for BC0
         if (CheckForBC0(*f) && (f==fibre->begin())) {
           bc0=true;
         }
 
         // Check for mismatch between fibres
         if ((bc0 && !CheckForBC0(*f)) ||
             (!bc0 && CheckForBC0(*f))){
           edm::LogInfo("GCT fibre data error") << "BC0 mismatch in fibre data " << (*f);
         }
 
         // Check logical ID pattern
         if (m_doLogicalID) CheckLogicalID(*f);
 
         // Check counter pattern
         if (m_doCounter) CheckCounter(*f);
 
         flag_for_zeroes = 1;    
       }
     else 
       {
     //this basically checks that all the data is 0s by the time it gets to the last iteration
         if(flag_for_zeroes == 0 && f==(fibre->end()-1)) {m_numZeroEvents++;}
     //if the zero flag is set to 1 and it managed to find its way into here then something is wrong!
         if(flag_for_zeroes == 1) {flag_for_inconsistent_events++;}
       }
 
   }
   //check for inconsistent events i.e. those with one(or more) zeroes, and the rest data
   if(flag_for_inconsistent_events != 0) {m_numInconsistentPayloadEvents++;}
   //check for consistent events with the counter
   if(m_doCounter && flag_for_consistent_events != 0) {m_numConsistentEvents++;}
 }

void GctFibreAnalyzer::CheckCounter ( const L1GctFibreWord fibre )

private

Definition at line 125 of file GctFibreAnalyzer.cc.

References L1GctFibreWord::data().

Referenced by analyze().

 {
   // Remove MSB from both cycles
   int cycle0Data, cycle1Data;
   
   cycle0Data = fibre.data() & 0x7FFF;
   cycle1Data = (fibre.data() >> 16) & 0x7FFF;
 
   // Check to see if fibre numbers are consistent
   if ((cycle0Data+1)!=cycle1Data){
     edm::LogInfo("GCT fibre data error") << "Fibre data not incrementing in cycles 0 and 1 "
                                          << " Cycle 0 data=" << cycle0Data
                                          << " Cycle 1 data=" << cycle1Data
                                          << " " << fibre;      
   }  
   
   // For now just write out the data
   edm::LogInfo("GCT fibre counter data") << " Fibre data: cycle0=" << cycle0Data 
                                          << " cycle1=" << cycle1Data
                                          << " " << fibre;
 }

bool GctFibreAnalyzer::CheckFibreWord ( const L1GctFibreWord fibre )

private

Definition at line 115 of file GctFibreAnalyzer.cc.

References L1GctFibreWord::data().

Referenced by analyze().

 {
   // Check that the phase or clock bit (MSB bit on cycle 1) is set as it should be
   if (fibre.data() & 0x80000000){
     return true;
   } else {
     return false;
   }
 }

bool GctFibreAnalyzer::CheckForBC0 ( const L1GctFibreWord fibre )

private

Definition at line 105 of file GctFibreAnalyzer.cc.

References L1GctFibreWord::data().

Referenced by analyze().

 {
   // Check for BC0 on this event
   if (fibre.data() & 0x8000){
     return true;
   } else {
     return false;
   }
 }

void GctFibreAnalyzer::CheckLogicalID ( const L1GctFibreWord fibre )

private

Definition at line 147 of file GctFibreAnalyzer.cc.

References L1GctFibreWord::block(), L1GctFibreWord::data(), Exception, L1GctFibreWord::index(), and globals_cff::x1.

Referenced by analyze().

 {
   //added by Jad Marrouche, May 08
 
   unsigned ref_jf_link[] = {1,2,3,4,1,2,3,4};
   //this array lists the link number ordering we expect from the 3 JFs in positive eta
   //below, we modify indices 2 and 3 from 3,4 to 1,2 to represent negative eta
 
   unsigned ref_eta0_link[] = {3,4,3,4,3,4};
   //this array lists the link number ordering we expect from the ETA0
 
   unsigned ref_jf_type[] = {2,2,3,3,1,1,1,1};
   //this array lists the SC_type ordering we expect for the JFs
 
   unsigned ref_eta0_type[] = {2,2,2,2,2,2};
   //this array lists the SC_type ordering we expect for the ETA0 (for consistency)
 
   int eta_region, rct_phi_region, leaf_phi_region, jf_type, elec_type, local_source_card_id, source_card_id_read, source_card_id_expected;
 
   // Check that data in cycle 0 and cycle 1 are equal
   if ((fibre.data()&0x7FFF)!=((fibre.data()&0x7FFF0000)>>16)){
     edm::LogInfo("GCT fibre data error") << "Fibre data different on cycles 0 and 1 " << fibre;
   }
 
   //fibre.block() gives 0x90c etc
   //fibre.index() runs from 0 to 6/8
 
   if((fibre.block() >> 10) & 0x1 ) 
     {
       eta_region = 0;       //negative eta region       
       ref_jf_link[2] = 1; //modify indices to represent neg_eta fibre mapping
       ref_jf_link[3] = 2;   
     }   
   else eta_region = 1;  //positive eta region 
 
   if(((fibre.block() >> 8) & 0x7) == 0 || ((fibre.block() >> 8) & 0x7) == 4)    //i.e. electron leaf cards
     {
     
       if((fibre.block() & 0xFF)==0x04)      elec_type=1;
       else if((fibre.block() & 0xFF)==0x84) elec_type=0;
       else throw cms::Exception("Unknown GCT fibre data block ") << fibre.block(); //else something screwed up   
     
       rct_phi_region = (fibre.index() / 3) + (4*elec_type);
 
       local_source_card_id = (4*eta_region);
     
       source_card_id_expected = (8 * rct_phi_region) + local_source_card_id;
     
       source_card_id_read = (fibre.data() >> 8) & 0x7F;
         
       if(source_card_id_expected != source_card_id_read ) 
         {
           edm::LogInfo("GCT fibre data error") << "Electron Source Card IDs do not match "  
                                                << "Expected ID = " << source_card_id_expected
                                                << " ID read from data = " << source_card_id_read
                                                << " " << fibre; //screwed up
         }
 
       if( (fibre.data() & 0xFF) != (unsigned int)(2 + fibre.index()%3))
         {
           edm::LogInfo("GCT fibre data error") << "Electron Fibres do not match "  
                                                << "Expected Fibre = " << (2 + fibre.index()%3)
                                                << " Fibre read from data = " << (fibre.data() & 0xFF)
                                                << " " << fibre; //screwed up
         }
 
 
     }
   else  //i.e. jet leaf cards
     {
       //the reason we use these values for eta_region is so it is easy to add 4 to the local source card ID
       //remember that 0x9.. 0xA.. and 0xB.. are +ve eta block headers
       //whereas 0xD.., 0xE.. and 0xF.. are -ve eta
       //can distinguish between them using the above mask and shift
 
       if((fibre.block() & 0xFF)==0x04)      jf_type=1;  //JF2
       else if((fibre.block() & 0xFF)==0x0C) jf_type=2;  //JF3
       else if((fibre.block() & 0xFF)==0x84) jf_type=-1; //ETA0
       else if((fibre.block() & 0xFF)==0x8C) jf_type=0;  //JF1
       else throw cms::Exception("Unknown GCT fibre data block ") << fibre.block(); //else something screwed up   
 
       //edm::LogInfo("JF Type Info") << "JF TYPE = " << jf_type << " block = " << fibre;    //INFO ONLY
 
       leaf_phi_region = ((fibre.block() >> 8) & 0x7)-1;     //0,1,2,3,4,5 for leaf cards
       if(eta_region == 0) leaf_phi_region--;        //need to do this because block index goes 9.. A.. B.. D.. E.. F.. - 8 and C are reserved for electron leafs which are dealt with above
       if(leaf_phi_region <0 || leaf_phi_region >5) throw cms::Exception("Unknown Leaf Card ") << fibre.block(); 
       //throw exception if number is outside 0-5 which means something screwed up
       //if(leaf_phi_region <0 || leaf_phi_region >5) edm::LogInfo("GCT fibre data error") << "Unknown leaf card " << fibre;
       //write to logger if number is outside 0-5 which means something screwed up
 
       if(jf_type == -1)
         {
           //in this case fibre.index() runs from 0-5
           //JF1 comes first, followed by JF2 and JF3
     
           if(fibre.index() <=5 )    //the compiler warning is because fibre.index() is unsigned int and hence is always >=0
             {
               rct_phi_region = ( (8 + ((leaf_phi_region%3)*3) + (fibre.index() / 2) ) % 9);
               //fibre.index()/2 will give 0 for 0,1 1 for 2,3 and 2 for 4,5
         
               //local_source_card_id = ref_eta0_type[ fibre.index() ] + (4 * (1 % eta_region));
               //take the ones complement of the eta_region because this is the shared part (i.e. other eta0 region)
               //this is done by (1 % eta_region) since 1%0 = 1 and 1%1=0
               //FLAWED - since 1%0 is a floating point exception you idiot!
 
               local_source_card_id = ref_eta0_type[ fibre.index() ] + (4 + (eta_region * -4));
               //this gives what you want - adds 4 when eta_region = 0 (neg) and adds 0 when eta_region = 1 (pos)
     
               source_card_id_expected = (8 * rct_phi_region) + local_source_card_id;
               //from GCT_refdoc_v2_2.pdf
         
               source_card_id_read = (fibre.data() >> 8) & 0x7F;
         
               if(source_card_id_expected != source_card_id_read ) 
                 {
                   edm::LogInfo("GCT fibre data error") << "ETA0 Source Card IDs do not match "  
                                                        << "Expected ID = " << source_card_id_expected
                                                        << " ID read from data = " << source_card_id_read
                                                        << " " << fibre; //screwed up
                 }
 
               if( (fibre.data() & 0xFF) != ref_eta0_link[fibre.index()])
                 {
                   edm::LogInfo("GCT fibre data error") << "ETA0 Fibres do not match "  
                                                        << "Expected Fibre = " << ref_eta0_link[fibre.index()]
                                                        << " Fibre read from data = " << (fibre.data() & 0xFF)
                                                        << " " << fibre; //screwed up
                 }
             }
           else edm::LogInfo("GCT fibre data error") << "ETA0 Fibre index out of bounds " << fibre;
           //edm::LogInfo("Fibre Index Info") << "ETA0 Fibre index = " << fibre.index();
         }
 
 
       if(jf_type >=0) 
         {
           if(fibre.index() <=7 )
             {
               rct_phi_region = ( (8 + ((leaf_phi_region%3)*3) + jf_type ) % 9);     //see table below
 
               /*
         Leaf Card   |   RCT crate   |   Jet Finder
         ___________________________________________
         LC3 |   LC0 |   17  |   8   |   JF1
                 |       |   9   |   0   |   JF2
                 |       |   10  |   1   |   JF3
         ___________________________________________
         LC4 |   LC1 |   11  |   2   |   JF1
                 |       |   12  |   3   |   JF2
                 |       |   13  |   4   |   JF3
         ___________________________________________
         LC5 |   LC2 |   14  |   5   |   JF1
                 |       |   15  |   6   |   JF2
                 |       |   16  |   7   |   JF3
         ___________________________________________
         The phase results in the 17/8 being at the top
         This can be adjusted as necessary by changing
         the number 8 added before modulo 9 operation
               */
 
               local_source_card_id = ref_jf_type[ fibre.index() ] + (4 * eta_region);
 
               //since the SC sharing scheme renumbers SC 7 as SC3:
               if(local_source_card_id == 7) local_source_card_id = 3;
               //there is probably a more elegant way to do this
 
               source_card_id_expected = (8 * rct_phi_region) + local_source_card_id;
 
               source_card_id_read = (fibre.data() >> 8) & 0x7F;
 
               if(source_card_id_expected != source_card_id_read ) 
                 {
                   edm::LogInfo("GCT fibre data error") << "Source Card IDs do not match "  
                                                        << "Expected ID = " << source_card_id_expected
                                                        << " ID read from data = " << source_card_id_read
                                                        << " " << fibre; //screwed up
                 }
 
               if( (fibre.data() & 0xFF) != ref_jf_link[fibre.index()])
                 {
                   edm::LogInfo("GCT fibre data error") << "Fibres do not match "  
                                                        << "Expected Fibre = " << ref_jf_link[fibre.index()]
                                                        << " Fibre read from data = " << (fibre.data() & 0xFF)
                                                        << " " << fibre; //screwed up
                 }
             }
           else edm::LogInfo("GCT fibre data error") << "Fibre index out of bounds " << fibre;
         }
 
     }
 
 
 }

Member Data Documentation

bool GctFibreAnalyzer::m_doCounter

private

Definition at line 50 of file GctFibreAnalyzer.h.

Referenced by analyze(), and ~GctFibreAnalyzer().

bool GctFibreAnalyzer::m_doLogicalID

private

Definition at line 49 of file GctFibreAnalyzer.h.

Referenced by analyze().

edm::InputTag GctFibreAnalyzer::m_fibreSource

private

Definition at line 48 of file GctFibreAnalyzer.h.

Referenced by analyze().

unsigned int GctFibreAnalyzer::m_numConsistentEvents

private

Definition at line 53 of file GctFibreAnalyzer.h.

Referenced by analyze(), and ~GctFibreAnalyzer().

unsigned int GctFibreAnalyzer::m_numInconsistentPayloadEvents

private

Definition at line 52 of file GctFibreAnalyzer.h.

Referenced by analyze(), and ~GctFibreAnalyzer().

unsigned int GctFibreAnalyzer::m_numZeroEvents

private

Definition at line 51 of file GctFibreAnalyzer.h.

Referenced by analyze(), and ~GctFibreAnalyzer().

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation