#include <DPGAnalysis/SiStripTools/plugins/APVCyclePhaseProducerFromL1ABC.cc>

Inheritance diagram for APVCyclePhaseProducerFromL1ABC:

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

	~APVCyclePhaseProducerFromL1ABC () override

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

	EDProducer (const EDProducer &)=delete

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginProcessBlocks () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndProcessBlocks () const final

bool	hasAbilityToProduceInEndRuns () const final

const EDProducer &	operator= (const EDProducer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

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

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~EDProducerBase () override

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

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

std::vector< bool > const &	recordProvenanceList () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

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

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

	~ProducerBase () noexcept(false) 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

std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (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::array< std::vector< ModuleDescription const > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, 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

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

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	beginJob () override

void	beginRun (const edm::Run &, const edm::EventSetup &) override

void	endJob () override

void	endRun (const edm::Run &, const edm::EventSetup &) override

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

Private Attributes
edm::EventNumber_t	_curroffevent

long long	_curroffset

const std::vector< std::string >	_defpartnames

const std::vector< int >	_defphases

const unsigned int	_firstgoodrun

const bool	_forceSCAL

TH1F **	_hbx

TH1F **	_hdbx

TH1F **	_hdorbit

edm::EDGetTokenT< L1AcceptBunchCrossingCollection >	_l1abccollectionToken

std::map< edm::EventNumber_t, long long >	_offsets

const int	_orbitoffsetSOR

edm::EDGetTokenT< TCDSRecord >	_tcdsRecordToken

const bool	_wantHistos

RunHistogramManager	m_rhm

Additional Inherited Members
Public Types inherited from edm::one::EDProducerBase
typedef EDProducerBase	ModuleType

Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex > >

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Protected Member Functions inherited from edm::ProducerBase
template<Transition Tr = Transition::Event>
auto	produces (std::string instanceName) noexcept
	declare what type of product will make and with which optional label More...

template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()

template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()

template<Transition Tr = Transition::Event>
auto	produces () noexcept

ProducesCollector	producesCollector ()

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

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

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<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

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)

void	resetItemsToGetFrom (BranchType iType)

Detailed Description

Description: EDproducer for APVCyclePhaseCollection which uses the configuration file to assign a phase to the run

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

Definition at line 54 of file APVCyclePhaseProducerFromL1ABC.cc.

Constructor & Destructor Documentation

◆ APVCyclePhaseProducerFromL1ABC()

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

explicit

Definition at line 97 of file APVCyclePhaseProducerFromL1ABC.cc.

References _hbx, _hdbx, _hdorbit, _wantHistos, m_rhm, and RunHistogramManager::makeTH1F().

     : _l1abccollectionToken(
           mayConsume<L1AcceptBunchCrossingCollection>(iConfig.getParameter<edm::InputTag>("l1ABCCollection"))),
       _tcdsRecordToken(mayConsume<TCDSRecord>(iConfig.getParameter<edm::InputTag>("tcdsRecordLabel"))),
       _defpartnames(iConfig.getParameter<std::vector<std::string> >("defaultPartitionNames")),
       _defphases(iConfig.getParameter<std::vector<int> >("defaultPhases")),
       _orbitoffsetSOR(iConfig.getParameter<int>("StartOfRunOrbitOffset")),
       _wantHistos(iConfig.getUntrackedParameter<bool>("wantHistos", false)),
       _forceSCAL(iConfig.getParameter<bool>("forceSCAL")),
       m_rhm(consumesCollector()),
       _hbx(nullptr),
       _hdbx(nullptr),
       _hdorbit(nullptr),
       _firstgoodrun(110878),
       _offsets(),
       _curroffset(0),
       _curroffevent(0) {
   produces<APVCyclePhaseCollection, edm::InEvent>();
 
   //now do what ever other initialization is needed
 
   if (_wantHistos) {
     _hbx = m_rhm.makeTH1F("l1abcbx", "BX number from TCDS (or L1ABC as fallback)", 4096, -0.5, 4095.5);
     _hdbx = m_rhm.makeTH1F("dbx", "BX number difference", 4096 * 2 - 1, -4095.5, 4095.5);
     _hdorbit = m_rhm.makeTH1F("dorbit", "Orbit Number difference", 9999, -4999.5, 4999.5);
   }
 }

◆ ~APVCyclePhaseProducerFromL1ABC()

APVCyclePhaseProducerFromL1ABC::~APVCyclePhaseProducerFromL1ABC ( )

override

Definition at line 125 of file APVCyclePhaseProducerFromL1ABC.cc.

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

Member Function Documentation

◆ beginJob()

void APVCyclePhaseProducerFromL1ABC::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::one::EDProducerBase.

Definition at line 296 of file APVCyclePhaseProducerFromL1ABC.cc.

296 {}

◆ beginRun()

void APVCyclePhaseProducerFromL1ABC::beginRun	(	const edm::Run &	iRun,
		const edm::EventSetup &	iSetup
	)

overrideprivate

Definition at line 135 of file APVCyclePhaseProducerFromL1ABC.cc.

References _firstgoodrun, _hbx, _hdbx, _hdorbit, _offsets, _wantHistos, RunHistogramManager::beginRun(), m_rhm, and edm::RunBase::run().

 {
   // reset offset vector
 
   _offsets.clear();
   edm::LogInfo("AbsoluteBXOffsetReset") << "Absolute BX offset map reset";
 
   if (_wantHistos) {
     m_rhm.beginRun(iRun);
 
     if (_hbx && *_hbx) {
       (*_hbx)->GetXaxis()->SetTitle("BX");
       (*_hbx)->GetYaxis()->SetTitle("Events");
     }
 
     if (_hdbx && *_hdbx) {
       (*_hdbx)->GetXaxis()->SetTitle("#DeltaBX");
       (*_hdbx)->GetYaxis()->SetTitle("Events");
     }
 
     if (_hdorbit && *_hdorbit) {
       (*_hdorbit)->GetXaxis()->SetTitle("#Deltaorbit");
       (*_hdorbit)->GetYaxis()->SetTitle("Events");
     }
   }
 
   if (iRun.run() < _firstgoodrun) {
     edm::LogInfo("UnreliableMissingL1AcceptBunchCrossingCollection")
         << "In this run L1AcceptBunchCrossingCollection is missing or unreliable: default phases will be used";
   }
 }

◆ endJob()

void APVCyclePhaseProducerFromL1ABC::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::one::EDProducerBase.

Definition at line 299 of file APVCyclePhaseProducerFromL1ABC.cc.

299 {}

◆ endRun()

void APVCyclePhaseProducerFromL1ABC::endRun	(	const edm::Run &	,
		const edm::EventSetup &
	)

overrideprivate

Definition at line 168 of file APVCyclePhaseProducerFromL1ABC.cc.

References _offsets, and hltrates_dqm_sourceclient-live_cfg::offset.

                                                                                {
   // summary of absolute bx offset vector
 
   edm::LogInfo("L1AcceptBunchCrossingAbsoluteBXOffsetSummary") << "Absolute BX offset summary:";
   for (std::map<edm::EventNumber_t, long long>::const_iterator offset = _offsets.begin(); offset != _offsets.end();
        ++offset) {
     edm::LogVerbatim("L1AcceptBunchCrossingAbsoluteBXOffsetSummary") << offset->first << " " << offset->second;
   }
 }

◆ produce()

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

overrideprivatevirtual

Implements edm::one::EDProducerBase.

Definition at line 178 of file APVCyclePhaseProducerFromL1ABC.cc.

References _curroffevent, _curroffset, _defpartnames, _defphases, _firstgoodrun, _forceSCAL, _hbx, _hdbx, _hdorbit, _l1abccollectionToken, _offsets, _orbitoffsetSOR, _tcdsRecordToken, _wantHistos, Exception, iEvent, edm::HandleBase::isValid(), eostools::move(), phases, edm::Handle< T >::product(), and BeamMonitor_cff::tcdsRecord.

                                                                                           {
   using namespace edm;
 
   std::unique_ptr<APVCyclePhaseCollection> apvphases(new APVCyclePhaseCollection());
 
   const std::vector<int>& phases = _defphases;
   const std::vector<std::string>& partnames = _defpartnames;
 
   // Look for the L1AcceptBunchCrossingCollection
 
   int phasechange = 0;
 
   if (iEvent.run() >= _firstgoodrun) {
     Handle<L1AcceptBunchCrossingCollection> pIn;
     iEvent.getByToken(_l1abccollectionToken, pIn);
     Handle<TCDSRecord> tcds_pIn;
     iEvent.getByToken(_tcdsRecordToken, tcds_pIn);
     bool useTCDS(tcds_pIn.isValid() && !_forceSCAL);
     const auto* tcdsRecord = useTCDS ? tcds_pIn.product() : nullptr;
     // offset computation
 
     long long orbitoffset = _orbitoffsetSOR;
     int bxoffset = 0;
 
     if (useTCDS) {
       if (tcdsRecord->getL1aHistoryEntry(0).getIndex() == 0) {
         if (tcdsRecord->getEventType() != 0) {
           orbitoffset = (long long)tcdsRecord->getOrbitNr() - (long long)iEvent.orbitNumber();
           // In EventWithHistoryProducerFromL1ABC, it's -1\times this, following the corresponding L1ABC line below. I keep this difference here, because I am not sure if it should be kept or not
           bxoffset = iEvent.bunchCrossing() - tcdsRecord->getBXID();
           // If I understand correctly, tcdsRecord has no l1AcceptOffset thing, so the control done for l1abc can be safely skipped
           if (_wantHistos) {
             if (_hbx && *_hbx)
               (*_hbx)->Fill(tcdsRecord->getBXID());
             if (_hdbx && *_hdbx)
               (*_hdbx)->Fill(bxoffset);
             if (_hdorbit && *_hdorbit)
               (*_hdorbit)->Fill(orbitoffset);
           }
         }
       } else {
         edm::LogWarning("L1AcceptBunchCrossingNoType") << "L1AcceptBunchCrossing with no type found: ";
         edm::LogPrint("L1AcceptBunchCrossingNoType") << *tcdsRecord;
       }
     } else {
       for (L1AcceptBunchCrossingCollection::const_iterator l1abc = pIn->begin(); l1abc != pIn->end(); ++l1abc) {
         if (l1abc->l1AcceptOffset() == 0) {
           if (l1abc->eventType() != 0) {
             orbitoffset = (long long)iEvent.orbitNumber() - (long long)l1abc->orbitNumber();
             bxoffset =
                 iEvent.bunchCrossing() -
                 l1abc->bunchCrossing();  // In EventWithHistoryProducerFromL1ABC, it's l1abc - iEvent. I keep this difference here, because I am not sure if it should be kept or not
 
             if (_wantHistos) {
               if (_hbx && *_hbx)
                 (*_hbx)->Fill(l1abc->bunchCrossing());
               if (_hdbx && *_hdbx)
                 (*_hdbx)->Fill(bxoffset);
               if (_hdorbit && *_hdorbit)
                 (*_hdorbit)->Fill(orbitoffset);
             }
           } else {
             edm::LogWarning("L1AcceptBunchCrossingNoType") << "L1AcceptBunchCrossing with no type found: ";
             for (L1AcceptBunchCrossingCollection::const_iterator debu = pIn->begin(); debu != pIn->end(); ++debu) {
               edm::LogPrint("L1AcceptBunchCrossingNoType") << *debu;
             }
           }
         }
       }
     }
 
     long long absbxoffset = orbitoffset * 3564 + bxoffset;
 
     if (orbitoffset != _orbitoffsetSOR)
       phasechange = (orbitoffset * 3564) % 70;
 
     if (_offsets.empty()) {
       _curroffset = absbxoffset;
       _curroffevent = iEvent.id().event();
       _offsets[iEvent.id().event()] = absbxoffset;
     } else {
       if (_curroffset != absbxoffset || iEvent.id().event() < _curroffevent) {
         if (_curroffset != absbxoffset) {
           edm::LogInfo("L1AcceptBunchCrossingAbsoluteBXOffsetChanged")
               << "Absolute BX offset changed from " << _curroffset << " to " << absbxoffset << " at orbit "
               << iEvent.orbitNumber() << " and BX " << iEvent.bunchCrossing();
           if (useTCDS) {
             edm::LogVerbatim("AbsoluteBXOffsetChanged") << *tcdsRecord;  // Not sure about this
           } else {
             for (L1AcceptBunchCrossingCollection::const_iterator l1abc = pIn->begin(); l1abc != pIn->end(); ++l1abc) {
               edm::LogVerbatim("L1AcceptBunchCrossingAbsoluteBXOffsetChanged") << *l1abc;
             }
           }
         }
 
         _curroffset = absbxoffset;
         _curroffevent = iEvent.id().event();
         _offsets[iEvent.id().event()] = absbxoffset;
       }
     }
   }
 
   if (phases.size() < partnames.size()) {
     // throw exception
     throw cms::Exception("InvalidAPVCyclePhases")
         << " Inconsistent phases/partitions vector sizes: " << phases.size() << " " << partnames.size();
   }
 
   for (unsigned int ipart = 0; ipart < partnames.size(); ++ipart) {
     if (phases[ipart] >= 0) {
       apvphases->get()[partnames[ipart]] = (phases[ipart] + phasechange) % 70;
     }
   }
 
   iEvent.put(std::move(apvphases));
 }