Inheritance diagram for L1TGlobalPrescaler:

Public Member Functions
bool	filter (edm::Event &event, edm::EventSetup const &setup) override

	L1TGlobalPrescaler (edm::ParameterSet const &config)

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

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

bool	hasAbilityToProduceInLumis () const final

bool	hasAbilityToProduceInRuns () const final

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

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

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~EDFilterBase () 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

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)

	~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

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)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Types
enum	Mode { Mode::ApplyPrescaleValues, Mode::ApplyPrescaleRatios, Mode::ApplyColumnValues, Mode::ApplyColumnRatios, Mode::ForcePrescaleValues, Mode::ForceColumnValues, Mode::Invalid = -1 }

Private Attributes
std::array< unsigned int, GlobalAlgBlk::maxPhysicsTriggers >	m_counters

const int	m_l1tPrescaleColumn

const std::array< double, GlobalAlgBlk::maxPhysicsTriggers >	m_l1tPrescales

const edm::EDGetTokenT< GlobalAlgBlkBxCollection >	m_l1tResultsToken

const Mode	m_mode

int	m_oldIndex

std::array< double, GlobalAlgBlk::maxPhysicsTriggers >	m_prescales

Static Private Attributes
static const Entry< Mode >	s_modes []

Additional Inherited Members
Public Types inherited from edm::one::EDFilterBase
typedef EDFilterBase	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

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

Definition at line 129 of file L1TGlobalPrescaler.cc.

Member Enumeration Documentation

enum L1TGlobalPrescaler::Mode

strongprivate

Enumerator
ApplyPrescaleValues
ApplyPrescaleRatios
ApplyColumnValues
ApplyColumnRatios
ForcePrescaleValues
ForceColumnValues
Invalid

Definition at line 138 of file L1TGlobalPrescaler.cc.

                   {
     ApplyPrescaleValues,    // apply the given prescale values
     ApplyPrescaleRatios,    // apply prescales equal to ratio between the given values and the ones read from the EventSetup
     ApplyColumnValues,      // apply the prescale values from the EventSetup corresponding to the given column index
     ApplyColumnRatios,      // apply prescales equal to ratio between the values corresponsing to the given column index, and the ones read from the EventSetup
     ForcePrescaleValues,    // apply the given prescale values, ignoring the prescales and masks already applied
     ForceColumnValues,      // apply the prescale values from the EventSetup corresponding to the given column index, ignoring the prescales and masks already applied
     Invalid = -1
   };

Constructor & Destructor Documentation

L1TGlobalPrescaler::L1TGlobalPrescaler ( edm::ParameterSet const & config )

Definition at line 173 of file L1TGlobalPrescaler.cc.

References ApplyColumnRatios, ApplyColumnValues, ApplyPrescaleRatios, ApplyPrescaleValues, edm::errors::Configuration, Exception, ForceColumnValues, ForcePrescaleValues, edm::ParameterSet::getParameter(), Invalid, m_counters, m_l1tPrescales, m_mode, m_prescales, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                     :
   m_mode( get_enum_value(s_modes, config.getParameter<std::string>("mode").c_str(), Mode::Invalid) ),
   m_l1tResultsToken( consumes<GlobalAlgBlkBxCollection>(config.getParameter<edm::InputTag>("l1tResults")) ),
   m_l1tPrescales( m_mode == Mode::ApplyPrescaleValues or m_mode == Mode::ApplyPrescaleRatios or m_mode == Mode::ForcePrescaleValues ?
       getParameterArray<double, GlobalAlgBlk::maxPhysicsTriggers>(config, "l1tPrescales") :
       std::array<double, GlobalAlgBlk::maxPhysicsTriggers>() ),
   m_l1tPrescaleColumn( m_mode == Mode::ApplyColumnValues or m_mode == Mode::ApplyColumnRatios or m_mode == Mode::ForceColumnValues ?
       config.getParameter<uint32_t>("l1tPrescaleColumn") : 0 ),
   m_oldIndex(-1)
 {
   switch (m_mode) {
     // if the mode is "applyPrescaleValues", use the given values
     case Mode::ApplyPrescaleValues:
     case Mode::ForcePrescaleValues:
       m_prescales = m_l1tPrescales;
       break;
 
     // otherwise we need to read the prescale values from the EventSetup
     case Mode::ApplyColumnValues:
     case Mode::ApplyPrescaleRatios:
     case Mode::ApplyColumnRatios:
     case Mode::ForceColumnValues:
       break;
 
     // this should never happen
     case Mode::Invalid:
       throw edm::Exception(edm::errors::Configuration) << "invalid mode \"" << config.getParameter<std::string>("mode") << "\"";
   }
 
   m_counters.fill(0);
   produces<GlobalAlgBlkBxCollection>();
 }

Member Function Documentation

void L1TGlobalPrescaler::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 350 of file L1TGlobalPrescaler.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), edm::ParameterSetDescription::addNode(), DEFINE_FWK_MODULE, edm::ParameterSetDescription::ifValue(), SelectingProcedure_cff::l1tResults, GlobalAlgBlk::maxPhysicsTriggers, ALCARECOPromptCalibProdSiPixelAli0T_cff::mode, or, s_modes, edm::ParameterDescriptionNode::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                      {
   // collection with the original uGT results
   edm::ParameterDescription<edm::InputTag> l1tResults("l1tResults", edm::InputTag("gtStage2Digis"), true);
   l1tResults.setComment("Collection with the original uGT results");
 
   // define how to apply the prescale values
   edm::ParameterDescription<std::string> mode("mode", "applyPrescaleValues", true);
   mode.setComment(build_comment_from_entries("Define how to apply the prescale values:", s_modes));
 
   // target prescale values (for modes "applyPrescaleValues" or "applyPrescaleRatios")
   edm::ParameterDescription<std::vector<double>> l1tPrescales("l1tPrescales", std::vector<double>(GlobalAlgBlk::maxPhysicsTriggers, 1.), true);
   l1tPrescales.setComment("Target prescale values (for modes \"applyPrescaleValues\", \"applyPrescaleRatios\" or \"forcePrescaleValues\")");
 
   // target prescale column (for modes "applyColumnValues" or "applyColumnRatios")
   edm::ParameterDescription<uint32_t> l1tPrescaleColumn("l1tPrescaleColumn", 0, true);
   l1tPrescaleColumn.setComment("Target prescale column (for modes \"applyColumnValues\", \"applyColumnRatios\" or \"forceColumnValues\")");
 
   // validaton of all possible configurations and applyPrescaleValues example
   {
     edm::ParameterSetDescription desc;
     desc.addNode(l1tResults);
     desc.ifValue(mode,
       // if mode is "applyPrescaleValues", "applyPrescaleRatios" or "forcePrescaleValues", read the target prescales
       "applyPrescaleValues" >> l1tPrescales or
       "applyPrescaleRatios" >> l1tPrescales or
       "forcePrescaleValues" >> l1tPrescales or
       // if mode is "applyColumnValues", "applyColumnRatios" or "forceColumnValues", read the target column
       "applyColumnValues"   >> l1tPrescaleColumn or
       "applyColumnRatios"   >> l1tPrescaleColumn or
       "forceColumnValues"   >> l1tPrescaleColumn );
     descriptions.add("l1tGlobalPrescaler", desc);
   }
 
   // applyColumnRatios example
   {
     edm::ParameterSetDescription desc;
     desc.addNode(l1tResults);
     desc.add<std::string>("mode", "applyColumnRatios")->setComment("apply prescales equal to ratio between the values corresponsing to the given column index, and the ones read from the EventSetup");
     desc.addNode(l1tPrescaleColumn);
     descriptions.add("l1tGlobalPrescalerTargetColumn", desc);
   }
 }

bool L1TGlobalPrescaler::filter	(	edm::Event &	event,
		edm::EventSetup const &	setup
	)

overridevirtual

Implements edm::one::EDFilterBase.

Definition at line 206 of file L1TGlobalPrescaler.cc.

References ApplyColumnRatios, ApplyColumnValues, ApplyPrescaleRatios, BXVector< T >::at(), edm::errors::Configuration, ForceColumnValues, ForcePrescaleValues, cmsPerfStripChart::format, edm::EventSetup::get(), GlobalAlgBlk::getAlgoDecisionFinal(), GlobalAlgBlk::getAlgoDecisionInitial(), GlobalAlgBlk::getFinalORVeto(), h, cmsBatch::handle, mps_fire::i, BXVector< T >::isEmpty(), edm::errors::LogicError, m_counters, m_l1tPrescaleColumn, m_l1tPrescales, m_l1tResultsToken, m_mode, m_oldIndex, m_prescales, GlobalAlgBlk::maxPhysicsTriggers, min(), eostools::move(), or, L1TGlobalPrescalesVetos::prescale_table_, mps_fire::result, GlobalAlgBlk::setAlgoDecisionFinal(), GlobalAlgBlk::setFinalOR(), GlobalAlgBlk::setFinalORPreVeto(), and GlobalAlgBlk::setPreScColumn().

                                                                            {
   edm::Handle<GlobalAlgBlkBxCollection> handle;
   event.getByToken(m_l1tResultsToken, handle);
 
   // if the input collection does not have any information for bx 0,
   // produce an empty collection, and fail
   if (handle->isEmpty(0)) {
     std::unique_ptr<GlobalAlgBlkBxCollection> result(new GlobalAlgBlkBxCollection());
     event.put(std::move(result));
     return false;
   }
 
   // read the prescale index
   int index = handle->at(0,0).getPreScColumn();
   assert(index >= 0);
 
   // Mode::ApplyPrescaleRatios
   // apply prescales equal to ratio between the given values and the ones read from the EventSetup
   if (m_mode == Mode::ApplyPrescaleRatios and m_oldIndex != index) {
     edm::ESHandle<L1TGlobalPrescalesVetos> h;
     setup.get<L1TGlobalPrescalesVetosRcd>().get(h);
     auto const & prescaleTable = h->prescale_table_;
     if (index >= (int) prescaleTable.size())
       throw edm::Exception(edm::errors::LogicError) << boost::format("The prescale index %d is invalid, it should be smaller than the prescale table size %d.") % index % prescaleTable.size();
     auto const & prescales = prescaleTable[index];
     unsigned long i = 0;
     for (; i < std::min(prescales.size(), (unsigned long) GlobalAlgBlk::maxPhysicsTriggers); ++i)
       if (m_l1tPrescales[i] == 0) {
         // if the trigger is requested to be disabled, just do it
         m_prescales[i] = 0.;
       } else if (prescales[i] == 0) {
         // othersie, if the trigger was originally disabled, warn the user and keep it that way
         m_prescales[i] = 0.;
         edm::LogWarning("L1TGlobalPrescaler") << "Request to enable the trigger " << i << " which was originally disabled\nIt will be kept disabled.";
       } else if (m_l1tPrescales[i] < prescales[i]) {
         // if the target prescale is lower than the original prescale, keep the trigger unprescaled
         m_prescales[i] = 1.;
         edm::LogWarning("L1TGlobalPrescaler") << "Request to prescale the trigger " << i << " less than it was originally prescaled\nNo further prescale will be applied.";
       } else {
         // apply the ratio of the new and old prescales
         m_prescales[i] = (double) m_l1tPrescales[i] / prescales[i];
       }
     for (; i < (unsigned long) GlobalAlgBlk::maxPhysicsTriggers; ++i)
       // disable the triggers not included in the prescale table
       m_prescales[i] = 0.;
     // reset the prescales
     m_counters.fill(0);
     m_oldIndex = index;
   }
 
   // Mode::ApplyColumnValues and Mode::ForceColumnValues
   // apply the prescale values from the EventSetup corresponding to the given column index
   if ((m_mode == Mode::ApplyColumnValues or m_mode == Mode::ForceColumnValues) and m_oldIndex != m_l1tPrescaleColumn) {
     edm::ESHandle<L1TGlobalPrescalesVetos> h;
     setup.get<L1TGlobalPrescalesVetosRcd>().get(h);
     auto const & prescaleTable = h->prescale_table_;
     if (m_l1tPrescaleColumn >= (int) prescaleTable.size())
       throw edm::Exception(edm::errors::Configuration) << boost::format("The prescale index %d is invalid, it should be smaller than the prescale table size %d.") % m_l1tPrescaleColumn % prescaleTable.size();
     auto const & targets = prescaleTable[m_l1tPrescaleColumn];
     unsigned long i = 0;
     for (; i < std::min(targets.size(), (unsigned long) GlobalAlgBlk::maxPhysicsTriggers); ++i)
       // read the prescales from the EventSetup
       m_prescales[i] = targets[i];
     for (; i < (unsigned long) GlobalAlgBlk::maxPhysicsTriggers; ++i)
       // disable the triggers not included in the prescale table
       m_prescales[i] = 0.;
     // reset the prescales
     m_counters.fill(0);
     m_oldIndex = m_l1tPrescaleColumn;
   }
 
   // Mode::ApplyColumnRatios
   // apply prescales equal to ratio between the values corresponsing to the given column index, and the ones read from the EventSetup
   if (m_mode == Mode::ApplyColumnRatios and m_oldIndex != index) {
     edm::ESHandle<L1TGlobalPrescalesVetos> h;
     setup.get<L1TGlobalPrescalesVetosRcd>().get(h);
     auto const & prescaleTable = h->prescale_table_;
     if (index >= (int) prescaleTable.size())
       throw edm::Exception(edm::errors::LogicError) << boost::format("The prescale index %d is invalid, it should be smaller than the prescale table size %d.") % index % prescaleTable.size();
     if (m_l1tPrescaleColumn >= (int) prescaleTable.size())
       throw edm::Exception(edm::errors::Configuration) << boost::format("The prescale index %d is invalid, it should be smaller than the prescale table size %d.") % m_l1tPrescaleColumn % prescaleTable.size();
     auto const & prescales = prescaleTable[index];
     auto const & targets = prescaleTable[m_l1tPrescaleColumn];
     unsigned long i = 0;
     for (; i < std::min({prescales.size(), targets.size(), (unsigned long) GlobalAlgBlk::maxPhysicsTriggers}); ++i)
       if (prescales[i] == 0)
         // if the trigger was disabled, keep it disabled
         m_prescales[i] = 0.;
       else
         // if the target prescale is lower than the original prescale, keep the trigger unprescaled
         m_prescales[i] = targets[i] < prescales[i] ? 1. : (double) targets[i] / prescales[i];
     for (; i < (unsigned long) GlobalAlgBlk::maxPhysicsTriggers; ++i)
       // disable the triggers not included in the prescale table
       m_prescales[i] = 0.;
     // reset the prescales
     m_counters.fill(0);
     m_oldIndex = index;
   }
 
   // make a copy of the GlobalAlgBlk for bx 0
   GlobalAlgBlk algoBlock = handle->at(0,0);
 
   bool finalOr = false;
   std::vector<bool> const& decision = (m_mode == Mode::ForceColumnValues or m_mode == Mode::ForcePrescaleValues) ?
     algoBlock.getAlgoDecisionInitial() :
     algoBlock.getAlgoDecisionFinal();
 
   for (unsigned int i = 0; i < GlobalAlgBlk::maxPhysicsTriggers; ++i) {
     if (m_prescales[i] == 0) {
       // mask this trigger: reset the bit
       algoBlock.setAlgoDecisionFinal(i, false);
     } else if (decision[i]) {
       // prescale this trigger
       ++m_counters[i];
       if (std::fmod(m_counters[i], m_prescales[i]) < 1) {
         // the prescale is successful, set the bit
         algoBlock.setAlgoDecisionFinal(i, true);
         finalOr = true;
       } else {
         // the prescale failed, reset the bit
         algoBlock.setAlgoDecisionFinal(i, false);
       }
     }
   }
 
   // set the final OR
   algoBlock.setFinalORPreVeto(finalOr);
   if (algoBlock.getFinalORVeto())
     finalOr = false;
   algoBlock.setFinalOR(finalOr);
 
   // set the new prescale column
   if (m_mode == Mode::ApplyColumnValues or m_mode == Mode::ApplyColumnRatios or m_mode == Mode::ForceColumnValues)
     algoBlock.setPreScColumn(m_l1tPrescaleColumn);
 
   // create a new GlobalAlgBlkBxCollection, and set the new prescaled decisions for bx 0
   std::unique_ptr<GlobalAlgBlkBxCollection> result(new GlobalAlgBlkBxCollection());
   result->push_back(0, algoBlock);
   event.put(std::move(result));
 
   return finalOr;
 }

Member Data Documentation

std::array<unsigned int, GlobalAlgBlk::maxPhysicsTriggers> L1TGlobalPrescaler::m_counters

private

Definition at line 163 of file L1TGlobalPrescaler.cc.

Referenced by filter(), and L1TGlobalPrescaler().

const int L1TGlobalPrescaler::m_l1tPrescaleColumn

private

Definition at line 164 of file L1TGlobalPrescaler.cc.

Referenced by filter().

const std::array<double, GlobalAlgBlk::maxPhysicsTriggers> L1TGlobalPrescaler::m_l1tPrescales

private

Definition at line 161 of file L1TGlobalPrescaler.cc.

Referenced by filter(), and L1TGlobalPrescaler().

const edm::EDGetTokenT<GlobalAlgBlkBxCollection> L1TGlobalPrescaler::m_l1tResultsToken

private

Definition at line 160 of file L1TGlobalPrescaler.cc.

Referenced by filter().

const Mode L1TGlobalPrescaler::m_mode

private

Definition at line 159 of file L1TGlobalPrescaler.cc.

Referenced by filter(), and L1TGlobalPrescaler().

int L1TGlobalPrescaler::m_oldIndex

private

Definition at line 165 of file L1TGlobalPrescaler.cc.

Referenced by filter().

std::array<double, GlobalAlgBlk::maxPhysicsTriggers> L1TGlobalPrescaler::m_prescales

private

Definition at line 162 of file L1TGlobalPrescaler.cc.

Referenced by filter(), and L1TGlobalPrescaler().

const Entry< L1TGlobalPrescaler::Mode > L1TGlobalPrescaler::s_modes

staticprivate

Initial value:

{
    { Mode::ApplyPrescaleValues, "applyPrescaleValues", "apply the given prescale values" },
    { Mode::ApplyPrescaleRatios, "applyPrescaleRatios", "apply prescales equal to ratio between the given values and the ones read from the EventSetup" },
    { Mode::ApplyColumnValues,   "applyColumnValues",   "apply the prescale values from the EventSetup corresponding to the given column index" },
    { Mode::ApplyColumnRatios,   "applyColumnRatios",   "apply prescales equal to ratio between the values corresponsing to the given column index, and the ones read from the EventSetup" },
    { Mode::ForcePrescaleValues, "forcePrescaleValues", "apply the given prescale values, ignoring the prescales and masks already applied" },
    { Mode::ForceColumnValues,   "forceColumnValues",   "apply the prescale values from the EventSetup corresponding to the given column index, ignoring the prescales and masks already applied" },
    { Mode::Invalid,              0 ,                0  }
  }

Definition at line 149 of file L1TGlobalPrescaler.cc.

Referenced by fillDescriptions().

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation