l1t::L1TGlobalUtilHelper Class Reference

#include <L1TGlobalUtilHelper.h>

Public Member Functions
edm::InputTag const &	l1tAlgBlkInputTag () const
edm::EDGetTokenT< GlobalAlgBlkBxCollection > const &	l1tAlgBlkToken () const
edm::InputTag const &	l1tExtBlkInputTag () const
edm::EDGetTokenT< GlobalExtBlkBxCollection > const &	l1tExtBlkToken () const
	L1TGlobalUtilHelper (edm::ParameterSet const &pset, edm::ConsumesCollector &iC)
template<typename T >
	L1TGlobalUtilHelper (edm::ParameterSet const &pset, edm::ConsumesCollector &iC, T &module)
template<typename T >
	L1TGlobalUtilHelper (edm::ParameterSet const &pset, edm::ConsumesCollector &iC, T &module, edm::InputTag const &l1tAlgBlkInputTag, edm::InputTag const &l1tExtBlkInputTag)
void	operator() (edm::BranchDescription const &branchDescription)
bool const &	readPrescalesFromFile () const

Static Public Member Functions
static void	fillDescription (edm::ParameterSetDescription &desc)

Private Attributes
edm::ConsumesCollector	m_consumesCollector
bool	m_findL1TAlgBlk
bool	m_findL1TExtBlk
bool	m_foundMultipleL1TAlgBlk
bool	m_foundMultipleL1TExtBlk
bool	m_foundPreferredL1TAlgBlk
bool	m_foundPreferredL1TExtBlk
std::vector< edm::InputTag >	m_inputTagsL1TAlgBlk
std::vector< edm::InputTag >	m_inputTagsL1TExtBlk
edm::InputTag	m_l1tAlgBlkInputTag
edm::EDGetTokenT< GlobalAlgBlkBxCollection >	m_l1tAlgBlkToken
edm::InputTag	m_l1tExtBlkInputTag
edm::EDGetTokenT< GlobalExtBlkBxCollection >	m_l1tExtBlkToken
bool	m_readPrescalesFromFile

Detailed Description

Definition at line 38 of file L1TGlobalUtilHelper.h.

Constructor & Destructor Documentation

L1TGlobalUtilHelper() [1/3]

L1TGlobalUtilHelper::L1TGlobalUtilHelper	(	edm::ParameterSet const &	pset,
		edm::ConsumesCollector &	iC
	)

Definition at line 9 of file L1TGlobalUtilHelper.cc.

    : m_consumesCollector(iC),
      m_l1tAlgBlkInputTag(pset.getParameter<edm::InputTag>("l1tAlgBlkInputTag")),
      m_l1tExtBlkInputTag(pset.getParameter<edm::InputTag>("l1tExtBlkInputTag")),
      m_findL1TAlgBlk(false),
      m_findL1TExtBlk(false),
      m_readPrescalesFromFile(pset.getParameter<bool>("ReadPrescalesFromFile")),
      m_foundPreferredL1TAlgBlk(false),
      m_foundPreferredL1TExtBlk(false) {
  m_l1tAlgBlkToken = iC.consumes<GlobalAlgBlkBxCollection>(m_l1tAlgBlkInputTag);
  m_l1tExtBlkToken = iC.consumes<GlobalExtBlkBxCollection>(m_l1tExtBlkInputTag);
}

References edm::ConsumesCollector::consumes(), m_l1tAlgBlkInputTag, m_l1tAlgBlkToken, m_l1tExtBlkInputTag, and m_l1tExtBlkToken.

L1TGlobalUtilHelper() [2/3]

template<typename T >

L1TGlobalUtilHelper::L1TGlobalUtilHelper	(	edm::ParameterSet const &	pset,
		edm::ConsumesCollector &	iC,
		T &	module
	)

Definition at line 106 of file L1TGlobalUtilHelper.h.

      : L1TGlobalUtilHelper(pset, iC, module, edm::InputTag(), edm::InputTag()) {}

L1TGlobalUtilHelper() [3/3]

template<typename T >

L1TGlobalUtilHelper::L1TGlobalUtilHelper	(	edm::ParameterSet const &	pset,
		edm::ConsumesCollector &	iC,
		T &	module,
		edm::InputTag const &	l1tAlgBlkInputTag,
		edm::InputTag const &	l1tExtBlkInputTag
	)

Definition at line 110 of file L1TGlobalUtilHelper.h.

      : m_consumesCollector(iC),
 
        // Set InputTags from arguments
        m_l1tAlgBlkInputTag(l1tAlgBlkInputTag),
        m_l1tExtBlkInputTag(l1tExtBlkInputTag),
 
        m_findL1TAlgBlk(false),
        m_findL1TExtBlk(false),
 
        m_readPrescalesFromFile(false),
 
        m_foundPreferredL1TAlgBlk(false),
        m_foundPreferredL1TExtBlk(false),
 
        m_foundMultipleL1TAlgBlk(false),
        m_foundMultipleL1TExtBlk(false) {
    if (pset.existsAs<bool>("ReadPrescalesFromFile")) {
      m_readPrescalesFromFile = pset.getParameter<bool>("ReadPrescalesFromFile");
    }
    // If the InputTags are not set to valid values by the arguments, then
    // try to set them from the configuration.
    if (m_l1tAlgBlkInputTag.label().empty() && pset.existsAs<edm::InputTag>("l1tAlgBlkInputTag")) {
      m_l1tAlgBlkInputTag = pset.getParameter<edm::InputTag>("l1tAlgBlkInputTag");
    }
    if (m_l1tExtBlkInputTag.label().empty() && pset.existsAs<edm::InputTag>("l1tExtBlkInputTag")) {
      m_l1tExtBlkInputTag = pset.getParameter<edm::InputTag>("l1tExtBlkInputTag");
    }
 
    // If the InputTags were set to valid values, make the consumes calls.
    if (!m_l1tAlgBlkInputTag.label().empty()) {
      m_l1tAlgBlkToken = iC.consumes<GlobalAlgBlkBxCollection>(m_l1tAlgBlkInputTag);
    }
    if (!m_l1tExtBlkInputTag.label().empty()) {
      m_l1tExtBlkToken = iC.consumes<GlobalExtBlkBxCollection>(m_l1tExtBlkInputTag);
    }
 
    // Do we still need to search for each InputTag?
    m_findL1TAlgBlk = m_l1tAlgBlkInputTag.label().empty();
    m_findL1TExtBlk = m_l1tExtBlkInputTag.label().empty();
 
    // Register the callback function with the Framework
    // if any InputTags still need to be found.
    if (m_findL1TAlgBlk || m_findL1TExtBlk) {
      module.callWhenNewProductsRegistered(std::ref(*this));
    }
  }

References edm::ConsumesCollector::consumes(), edm::InputTag::label(), m_findL1TAlgBlk, m_findL1TExtBlk, m_l1tAlgBlkInputTag, m_l1tAlgBlkToken, m_l1tExtBlkInputTag, m_l1tExtBlkToken, m_readPrescalesFromFile, and muonDTDigis_cfi::pset.

Member Function Documentation

fillDescription()

void L1TGlobalUtilHelper::fillDescription ( edm::ParameterSetDescription &  desc )

static

Definition at line 22 of file L1TGlobalUtilHelper.cc.

                                                                             {
  desc.add<edm::InputTag>("l1tAlgBlkInputTag", edm::InputTag());
  desc.add<edm::InputTag>("l1tExtBlkInputTag", edm::InputTag());
  desc.add<bool>("ReadPrescalesFromFile", false);
}

References edm::ParameterSetDescription::add(), and HLT_2018_cff::InputTag.

Referenced by l1t::L1TGlobalUtil::fillDescription().

l1tAlgBlkInputTag()

edm::InputTag const& l1t::L1TGlobalUtilHelper::l1tAlgBlkInputTag ( ) const

inline

Definition at line 72 of file L1TGlobalUtilHelper.h.

{ return m_l1tAlgBlkInputTag; }

References m_l1tAlgBlkInputTag.

l1tAlgBlkToken()

edm::EDGetTokenT<GlobalAlgBlkBxCollection> const& l1t::L1TGlobalUtilHelper::l1tAlgBlkToken ( ) const

inline

Definition at line 77 of file L1TGlobalUtilHelper.h.

{ return m_l1tAlgBlkToken; }

References m_l1tAlgBlkToken.

l1tExtBlkInputTag()

edm::InputTag const& l1t::L1TGlobalUtilHelper::l1tExtBlkInputTag ( ) const

inline

Definition at line 73 of file L1TGlobalUtilHelper.h.

{ return m_l1tExtBlkInputTag; }

References m_l1tExtBlkInputTag.

l1tExtBlkToken()

edm::EDGetTokenT<GlobalExtBlkBxCollection> const& l1t::L1TGlobalUtilHelper::l1tExtBlkToken ( ) const

inline

Definition at line 78 of file L1TGlobalUtilHelper.h.

{ return m_l1tExtBlkToken; }

References m_l1tExtBlkToken.

operator()()

void L1TGlobalUtilHelper::operator()

(

edm::BranchDescription const &

branchDescription

)

Definition at line 28 of file L1TGlobalUtilHelper.cc.

                                                                                     {
  // This is only used if required InputTags were not specified already.
  // This is called early in the process, once for each product in the ProductRegistry.
  // The callback is registered when callWhenNewProductsRegistered is called.
  // It finds products by type and sets the token so that it can be used
  // later when getting the product.
 
  // The code will look for the corresponding product in ProductRegistry.
  // If the product is found, it checks the product label in
  // a vector of preferred input tags (hardwired now to "gtDigis" and
  // "hltGtDigis"). The first input tag from the vector of preferred input tags, with the
  // same label as the input tag found from provenance, is kept as input tag, if there are no
  // multiple products with the same label.
 
  // If multiple products are found and no one has a label in the vector of preferred input tags,
  // or if multiple products are found with the label in the vector of preferred input tags
  // (with different instance or process) the input tag is set to empty input tag, and L1GtUtil
  // will produce an error, as it is not possible to safely choose a product. In this case, one must
  // provide explicitly the correct input tag via configuration or in the constructor.
 
  // TODO decide if the preferred input tags must be given as input parameters
  // or stay hardwired
 
  if (branchDescription.dropped()) {
    return;
  }
 
  std::vector<edm::InputTag> preferredL1TAlgBlkInputTag = {edm::InputTag("gtStage2Digis"),
                                                           edm::InputTag("hltGtStage2Digis")};
 
  std::vector<edm::InputTag> preferredL1TExtBlkInputTag = {edm::InputTag("gtStage2Digis"),
                                                           edm::InputTag("hltGtStage2Digis")};
 
  // GlobalAlgBlkBxCollection
 
  if (m_findL1TAlgBlk && (!m_foundMultipleL1TAlgBlk) &&
      (branchDescription.unwrappedTypeID() == edm::TypeID(typeid(GlobalAlgBlkBxCollection))) &&
      (branchDescription.branchType() == edm::InEvent)) {
    edm::InputTag tag{
        branchDescription.moduleLabel(), branchDescription.productInstanceName(), branchDescription.processName()};
 
    if (m_foundPreferredL1TAlgBlk) {
      // check if a preferred input tag was already found and compare it with the actual tag
      // if the instance or the process names are different, one has incompatible tags - set
      // the tag to empty input tag and indicate that multiple preferred input tags are found
      // so it is not possibly to choose safely an input tag
 
      if ((m_l1tAlgBlkInputTag.label() == branchDescription.moduleLabel()) &&
          ((m_l1tAlgBlkInputTag.instance() != branchDescription.productInstanceName()) ||
           (m_l1tAlgBlkInputTag.process() != branchDescription.processName()))) {
        LogDebug("L1TGlobalUtil") << "\nWARNING: Found multiple preferred input tags for GlobalAlgBlkBxCollection, "
                                  << "\nwith different instaces or processes."
                                  << "\nInput tag already found: " << (m_l1tAlgBlkInputTag) << "\nActual tag: " << (tag)
                                  << "\nInput tag set to empty tag." << std::endl;
 
        m_foundMultipleL1TAlgBlk = true;
        m_l1tAlgBlkInputTag = edm::InputTag();
      }
    } else {
      // no preferred input tag found yet, check now with the actual tag
      for (std::vector<edm::InputTag>::const_iterator itPrefTag = preferredL1TAlgBlkInputTag.begin(),
                                                      itPrefTagEnd = preferredL1TAlgBlkInputTag.end();
           itPrefTag != itPrefTagEnd;
           ++itPrefTag) {
        if (branchDescription.moduleLabel() == itPrefTag->label()) {
          m_l1tAlgBlkInputTag = tag;
          m_l1tAlgBlkToken = m_consumesCollector.consumes<GlobalAlgBlkBxCollection>(tag);
          m_foundPreferredL1TAlgBlk = true;
          m_inputTagsL1TAlgBlk.push_back(tag);
 
          LogDebug("L1TGlobalUtil")
              << "\nWARNING: Input tag for GlobalAlgBlkBxCollection product set to preferred input tag" << (tag)
              << std::endl;
          break;
        }
      }
    }
 
    if (!m_foundPreferredL1TAlgBlk) {
      // check if other input tag was found - if true, there are multiple input tags in the event,
      // none in the preferred input tags, so it is not possibly to choose safely an input tag
 
      if (m_inputTagsL1TAlgBlk.size() > 1) {
        LogDebug("L1TGlobalUtil") << "\nWARNING: Found multiple input tags for GlobalAlgBlkBxCollection product."
                                  << "\nNone is in the preferred input tags - no safe choice."
                                  << "\nInput tag already found: " << (m_l1tAlgBlkInputTag) << "\nActual tag: " << (tag)
                                  << "\nInput tag set to empty tag." << std::endl;
        m_l1tAlgBlkInputTag = edm::InputTag();
        m_foundMultipleL1TAlgBlk = true;
 
      } else {
        if (m_l1tAlgBlkToken.isUninitialized()) {
          m_l1tAlgBlkInputTag = tag;
          m_inputTagsL1TAlgBlk.push_back(tag);
          m_l1tAlgBlkToken = m_consumesCollector.consumes<GlobalAlgBlkBxCollection>(tag);
 
          LogDebug("L1TGlobalUtil") << "\nWARNING: No preferred input tag found for GlobalAlgBlkBxCollection."
                                    << "\nInput tag set to " << (tag) << std::endl;
        }
      }
    }
  }
 
  // GlobalExtBlkBxCollection
 
  if (m_findL1TExtBlk && (!m_foundMultipleL1TExtBlk) &&
      (branchDescription.unwrappedTypeID() == edm::TypeID(typeid(GlobalExtBlkBxCollection))) &&
      (branchDescription.branchType() == edm::InEvent)) {
    edm::InputTag tag{
        branchDescription.moduleLabel(), branchDescription.productInstanceName(), branchDescription.processName()};
 
    if (m_foundPreferredL1TExtBlk) {
      // check if a preferred input tag was already found and compare it with the actual tag
      // if the instance or the process names are different, one has incompatible tags - set
      // the tag to empty input tag and indicate that multiple preferred input tags are found
      // so it is not possibly to choose safely an input tag
 
      if ((m_l1tExtBlkInputTag.label() == branchDescription.moduleLabel()) &&
          ((m_l1tExtBlkInputTag.instance() != branchDescription.productInstanceName()) ||
           (m_l1tExtBlkInputTag.process() != branchDescription.processName()))) {
        LogDebug("L1TGlobalUtil") << "\nWARNING: Found multiple preferred input tags for GlobalExtBlkBxCollection, "
                                  << "\nwith different instaces or processes."
                                  << "\nInput tag already found: " << (m_l1tExtBlkInputTag) << "\nActual tag: " << (tag)
                                  << "\nInput tag set to empty tag." << std::endl;
 
        m_foundMultipleL1TExtBlk = true;
        m_l1tExtBlkInputTag = edm::InputTag();
      }
    } else {
      // no preferred input tag found yet, check now with the actual tag
 
      for (std::vector<edm::InputTag>::const_iterator itPrefTag = preferredL1TExtBlkInputTag.begin(),
                                                      itPrefTagEnd = preferredL1TExtBlkInputTag.end();
           itPrefTag != itPrefTagEnd;
           ++itPrefTag) {
        if (branchDescription.moduleLabel() == itPrefTag->label()) {
          m_l1tExtBlkInputTag = tag;
          m_l1tExtBlkToken = m_consumesCollector.consumes<GlobalExtBlkBxCollection>(tag);
          m_foundPreferredL1TExtBlk = true;
          m_inputTagsL1TExtBlk.push_back(tag);
 
          LogDebug("L1TGlobalUtil")
              << "\nWARNING: Input tag for GlobalExtBlkBxCollection product set to preferred input tag" << (tag)
              << std::endl;
          break;
        }
      }
    }
 
    if (!m_foundPreferredL1TExtBlk) {
      // check if other input tag was found - if true, there are multiple input tags in the event,
      // none in the preferred input tags, so it is not possibly to choose safely an input tag
 
      if (m_inputTagsL1TExtBlk.size() > 1) {
        LogDebug("L1TGlobalUtil") << "\nWARNING: Found multiple input tags for GlobalExtBlkBxCollection."
                                  << "\nNone is in the preferred input tags - no safe choice."
                                  << "\nInput tag already found: " << (m_l1tExtBlkInputTag) << "\nActual tag: " << (tag)
                                  << "\nInput tag set to empty tag." << std::endl;
        m_l1tExtBlkInputTag = edm::InputTag();
        m_foundMultipleL1TExtBlk = true;
 
      } else {
        if (m_l1tExtBlkToken.isUninitialized()) {
          m_l1tExtBlkInputTag = tag;
          m_inputTagsL1TExtBlk.push_back(tag);
          m_l1tExtBlkToken = m_consumesCollector.consumes<GlobalExtBlkBxCollection>(tag);
 
          LogDebug("L1TGlobalUtil") << "\nWARNING: No preferred input tag found for GlobalExtBlkBxCollection product."
                                    << "\nInput tag set to " << (tag) << std::endl;
        }
      }
    }
  }
}

References edm::BranchDescription::branchType(), edm::BranchDescription::dropped(), edm::InEvent, HLT_2018_cff::InputTag, LogDebug, edm::BranchDescription::moduleLabel(), edm::BranchDescription::processName(), edm::BranchDescription::productInstanceName(), BXVector< T >::push_back(), GlobalPosition_Frontier_DevDB_cff::tag, and edm::BranchDescription::unwrappedTypeID().

readPrescalesFromFile()

bool const& l1t::L1TGlobalUtilHelper::readPrescalesFromFile ( ) const

inline

Definition at line 75 of file L1TGlobalUtilHelper.h.

{ return m_readPrescalesFromFile; }

References m_readPrescalesFromFile.

Member Data Documentation

m_consumesCollector

edm::ConsumesCollector l1t::L1TGlobalUtilHelper::m_consumesCollector

private

Definition at line 81 of file L1TGlobalUtilHelper.h.

m_findL1TAlgBlk

bool l1t::L1TGlobalUtilHelper::m_findL1TAlgBlk

private

Definition at line 89 of file L1TGlobalUtilHelper.h.

Referenced by L1TGlobalUtilHelper().

m_findL1TExtBlk

bool l1t::L1TGlobalUtilHelper::m_findL1TExtBlk

private

Definition at line 90 of file L1TGlobalUtilHelper.h.

Referenced by L1TGlobalUtilHelper().

m_foundMultipleL1TAlgBlk

bool l1t::L1TGlobalUtilHelper::m_foundMultipleL1TAlgBlk

private

Definition at line 97 of file L1TGlobalUtilHelper.h.

m_foundMultipleL1TExtBlk

bool l1t::L1TGlobalUtilHelper::m_foundMultipleL1TExtBlk

private

Definition at line 98 of file L1TGlobalUtilHelper.h.

m_foundPreferredL1TAlgBlk

bool l1t::L1TGlobalUtilHelper::m_foundPreferredL1TAlgBlk

private

Definition at line 94 of file L1TGlobalUtilHelper.h.

m_foundPreferredL1TExtBlk

bool l1t::L1TGlobalUtilHelper::m_foundPreferredL1TExtBlk

private

Definition at line 95 of file L1TGlobalUtilHelper.h.

m_inputTagsL1TAlgBlk

std::vector<edm::InputTag> l1t::L1TGlobalUtilHelper::m_inputTagsL1TAlgBlk

private

Definition at line 101 of file L1TGlobalUtilHelper.h.

m_inputTagsL1TExtBlk

std::vector<edm::InputTag> l1t::L1TGlobalUtilHelper::m_inputTagsL1TExtBlk

private

Definition at line 102 of file L1TGlobalUtilHelper.h.

m_l1tAlgBlkInputTag

edm::InputTag l1t::L1TGlobalUtilHelper::m_l1tAlgBlkInputTag

private

Definition at line 83 of file L1TGlobalUtilHelper.h.

Referenced by l1tAlgBlkInputTag(), and L1TGlobalUtilHelper().

m_l1tAlgBlkToken

edm::EDGetTokenT<GlobalAlgBlkBxCollection> l1t::L1TGlobalUtilHelper::m_l1tAlgBlkToken

private

Definition at line 86 of file L1TGlobalUtilHelper.h.

Referenced by l1tAlgBlkToken(), and L1TGlobalUtilHelper().

m_l1tExtBlkInputTag

edm::InputTag l1t::L1TGlobalUtilHelper::m_l1tExtBlkInputTag

private

Definition at line 84 of file L1TGlobalUtilHelper.h.

Referenced by l1tExtBlkInputTag(), and L1TGlobalUtilHelper().

m_l1tExtBlkToken

edm::EDGetTokenT<GlobalExtBlkBxCollection> l1t::L1TGlobalUtilHelper::m_l1tExtBlkToken

private

Definition at line 87 of file L1TGlobalUtilHelper.h.

Referenced by l1tExtBlkToken(), and L1TGlobalUtilHelper().

m_readPrescalesFromFile

bool l1t::L1TGlobalUtilHelper::m_readPrescalesFromFile

private

Definition at line 92 of file L1TGlobalUtilHelper.h.

Referenced by L1TGlobalUtilHelper(), and readPrescalesFromFile().