TrigGlobEffCorr::CheckConfig Class Reference

#include <CheckConfig.h>

Inheritance diagram for TrigGlobEffCorr::CheckConfig:

Collaboration diagram for TrigGlobEffCorr::CheckConfig:

Public Member Functions
	CheckConfig (TrigGlobalEfficiencyCorrectionTool &parent)
bool	basicConfigChecks ()
bool	advancedConfigChecks ()
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Functions providing the same interface as AthMessaging
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Static Private Member Functions
template<class CPTool>
static ToolHandle< CPTool > *	findToolByName (ToolHandleArray< CPTool > &suppliedTools, const std::string &name)

Private Attributes
TrigGlobalEfficiencyCorrectionTool &	m_parent
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels).
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging).

Detailed Description

Definition at line 18 of file CheckConfig.h.

Constructor & Destructor Documentation

CheckConfig()

CheckConfig::CheckConfig

(

TrigGlobalEfficiencyCorrectionTool &

parent

)

Definition at line 18 of file CheckConfig.cxx.

    : asg::AsgMessaging(&parent), m_parent(parent) {
  msg().setLevel(parent.msg().level());
}

Member Function Documentation

advancedConfigChecks()

bool CheckConfig::advancedConfigChecks

(

)

This method requires all (most) of TrigGlobalEfficiencyCorrectionTool internal variables to have been properly initialized already -> to be called as the last step of TrigGlobalEfficiencyCorrectionTool::initialize()

Check that for each electron/photon efficiency tool there is an associated scale factor tool with the same associated legs and tags. And vice versa.

A suitable CP tool must be available for each entry of 'ListOfLegsPerTag'

Periods don't overlap

Definition at line 241 of file CheckConfig.cxx.

                                       {
  bool success = true;
 
  using ToolKey = TrigGlobalEfficiencyCorrectionTool::ToolKey;

  auto checkConsistency = [this](auto& effToolIndex, auto& sfToolIndex,
                                 const char* type) {
    bool mismatch = (effToolIndex.size() != sfToolIndex.size());
    if (!mismatch) {
      for (auto& kv : sfToolIndex) {
        auto itr = effToolIndex.find(kv.first);
        if (itr != effToolIndex.end()) {
          std::size_t index1 = kv.second, index2 = itr->second;
          std::flat_set<ToolKey> pairs1, pairs2;
          for (auto& kv : sfToolIndex)
            if (kv.second == index1)
              pairs1.insert(kv.first);
          for (auto& kv : effToolIndex)
            if (kv.second == index2)
              pairs2.insert(kv.first);
          if (pairs1 != pairs2)
            mismatch = true;
        } else
          mismatch = true;
      }
    }
    if (mismatch) {
      ATH_MSG_ERROR(
          "There must be a one-to-one correspondence between the "
          << type
          << " efficiency and scale factor tools "
             "(including their associated trigger legs and selection tags)");
      return false;
    }
    return true;
  };
  if (!checkConsistency(m_parent.m_electronEffToolIndex,
                        m_parent.m_electronSfToolIndex, "electron"))
    return false;
  if (!checkConsistency(m_parent.m_photonEffToolIndex,
                        m_parent.m_photonSfToolIndex, "photon"))
    return false;

  for (auto& kv : m_parent.m_legsPerTag) {
    std::size_t tag = (kv.first != "*") ? m_parent.m_hasher(kv.first) : 0;
    for (std::size_t leg :
         m_parent.listNonOrderedCSValues(kv.second, success)) {
      auto type = ImportData::associatedLeptonFlavour(
          m_parent.m_dictionary[leg], success);
      if (type == xAOD::Type::Electron) {
        if (m_parent.m_electronEffToolIndex.find(ToolKey(leg, tag)) ==
            m_parent.m_electronEffToolIndex.end()) {
          ATH_MSG_ERROR(
              "No electron tool provided for the combination of trigger leg '"
              << m_parent.m_dictionary[leg] << "' and selection tag '"
              << kv.first << "' mentioned in the property 'ListOfLegsPerTag'");
          success = false;
        }
      } else if (type == xAOD::Type::Muon) {
        if (m_parent.m_muonToolIndex.find(ToolKey(0, tag)) ==
            m_parent.m_muonToolIndex.end()) {
          ATH_MSG_ERROR(
              "No muon tool provided for the combination of trigger leg '"
              << m_parent.m_dictionary[leg] << "' and selection tag '"
              << kv.first << "' mentioned in the property 'ListOfLegsPerTag'");
          success = false;
        }
      } else if (type == xAOD::Type::Photon) {
        if (m_parent.m_photonEffToolIndex.find(ToolKey(leg, tag)) ==
            m_parent.m_photonEffToolIndex.end()) {
          ATH_MSG_ERROR(
              "No photon tool provided for the combination of trigger leg '"
              << m_parent.m_dictionary[leg] << "' and selection tag '"
              << kv.first << "' mentioned in the property 'ListOfLegsPerTag'");
          success = false;
        }
      } else {
        ATH_MSG_ERROR(
            "Unable to determine which lepton flavour is associated to the "
            "trigger leg '"
            << m_parent.m_dictionary[leg]
            << "' in the property 'ListOfLegsPerTag'");
        success = false;
      }
    }
  }
  if (!success)
    return false;

  auto periods = m_parent.m_calculator->m_periods;
  const auto periods_end = periods.end();
  for (auto itr1 = periods.begin(); itr1 != periods_end; ++itr1) {
    auto& x = itr1->m_boundaries;
    if (x.second < x.first) {
      ATH_MSG_ERROR(
          "One of the periods specified in TriggerCombination has runMin ("
          << x.first << ") > runMax (" << x.second << ")");
      success = false;
    }
    for (auto itr2 = itr1 + 1; itr2 != periods_end; ++itr2) {
      auto& y = itr2->m_boundaries;
      if ((x.first >= y.first && x.first <= y.second) ||
          (x.second >= y.first && x.second <= y.second)) {
        ATH_MSG_ERROR("The periods specified in TriggerCombination overlap");
        success = false;
      }
    }
  }
  if (!success)
    return false;
 
  return success;
}

basicConfigChecks()

bool CheckConfig::basicConfigChecks

(

)

All tools mentioned in 'ListOfLegsPerTool' must be in 'ElectronEfficiencyTools' or 'ElectronScaleFactorTools' (or equivalent photon tools)

All electron/photon tools must be associated to trigger legs (except when there's only one tool)

Additional checks when tags are used

All tools mentioned in 'ListOfTagsPerTool' must be known

Either all muon tools are associated to tags, either none

Either all electron tools are associated to tags, either none

Either all photon tools are associated to tags, either none

Definition at line 36 of file CheckConfig.cxx.

                                    {
  bool success = true;
 
  if (m_parent.m_suppliedElectronEfficiencyTools.size() !=
      m_parent.m_suppliedElectronScaleFactorTools.size()) {
    ATH_MSG_ERROR(
        "The numbers of electron tools supplied via the "
        "'ElectronEfficiencyTools' and 'ElectronScaleFactorTools' properties "
        "should be identical");
    return false;
  }
 
  if (m_parent.m_suppliedPhotonEfficiencyTools.size() !=
      m_parent.m_suppliedPhotonScaleFactorTools.size()) {
    ATH_MSG_ERROR(
        "The numbers of photon tools supplied via the 'PhotonEfficiencyTools' "
        "and 'PhotonScaleFactorTools' properties should be identical");
    return false;
  }

  for (auto& kv : m_parent.m_legsPerTool) {
    auto& name = kv.first;
    if (name ==
        ITrigGlobalEfficiencyCorrectionTool::toolnameForDefaultScaleFactor())
      continue;
    if (findToolByName(m_parent.m_suppliedElectronEfficiencyTools, name) ||
        findToolByName(m_parent.m_suppliedElectronScaleFactorTools, name) ||
        findToolByName(m_parent.m_suppliedPhotonEfficiencyTools, name) ||
        findToolByName(m_parent.m_suppliedPhotonScaleFactorTools, name))
      continue;
    success = false;
    if (findToolByName(m_parent.m_suppliedMuonTools, name)) {
      ATH_MSG_ERROR("Muon tool "
                    << name
                    << " mentioned in property 'ListOfLegsPerTool', which is "
                       "only aimed at electron and photon tools");
    } else {
      std::string known_tools = "; the known tools are";
      for (auto& tool : m_parent.m_suppliedElectronEfficiencyTools)
        known_tools += " " + tool.name();
      for (auto& tool : m_parent.m_suppliedElectronScaleFactorTools)
        known_tools += " " + tool.name();
      for (auto& tool : m_parent.m_suppliedPhotonEfficiencyTools)
        known_tools += " " + tool.name();
      for (auto& tool : m_parent.m_suppliedPhotonScaleFactorTools)
        known_tools += " " + tool.name();
      ATH_MSG_ERROR("Unknown tool "
                    << name << " mentioned in property 'ListOfLegsPerTool'"
                    << known_tools);
    }
  }
  if (!success)
    return false;

  auto toolsHaveLegInfo = [this](auto& effTools, auto& sfTools,
                                 const char* type) {
    if (effTools.size() < 2)
      return true;
    bool success = true;
    for (int i = 0; i < 2; ++i) {
      for (auto& tool : (i ? effTools : sfTools)) {
        const std::string& name = tool.name();
        if (m_parent.m_legsPerTool.find(name) == m_parent.m_legsPerTool.end()) {
          ATH_MSG_ERROR(type
                        << " tool " << name
                        << " associated trigger legs are not indicated in "
                           "'ListOfLegsPerTool', "
                           "doing so is mandatory when several tools are used");
          success = false;
        }
      }
    }
    return success;
  };
  success &=
      toolsHaveLegInfo(m_parent.m_suppliedElectronEfficiencyTools,
                       m_parent.m_suppliedElectronScaleFactorTools, "Electron");
  success &=
      toolsHaveLegInfo(m_parent.m_suppliedPhotonEfficiencyTools,
                       m_parent.m_suppliedPhotonScaleFactorTools, "Photon");
  if (!success)
    return false;

 
  if (m_parent.m_leptonTagDecorations == "") {
    if (m_parent.m_muonLegsPerTag.size() ||
        m_parent.m_electronLegsPerTag.size() || m_parent.m_legsPerTag.size() ||
        m_parent.m_tagsPerTool.size()) {
      ATH_MSG_ERROR(
          "the property 'LeptonTagDecorations' must be filled when any of "
          "'ListOfTagsPerTool'"
          " / 'ListOfLegsPerTag' / 'MuonLegsPerTag' / 'ElectronLegsPerTag' "
          "is.");
      return false;
    }
    return true;
  }

  unsigned nElectronToolsWithTags = 0, nMuonToolsWithTags = 0,
           nPhotonToolsWithTags = 0;
  for (auto& kv : m_parent.m_tagsPerTool) {
    auto& name = kv.first;
    if (findToolByName(m_parent.m_suppliedElectronEfficiencyTools, name) ||
        findToolByName(m_parent.m_suppliedElectronScaleFactorTools, name))
      ++nElectronToolsWithTags;
    else if (findToolByName(m_parent.m_suppliedMuonTools, name))
      ++nMuonToolsWithTags;
    else if (findToolByName(m_parent.m_suppliedPhotonEfficiencyTools, name) ||
             findToolByName(m_parent.m_suppliedPhotonScaleFactorTools, name))
      ++nPhotonToolsWithTags;
    else {
      success = false;
      std::string all_tools = "; the known tools are";
      for (auto& tool : m_parent.m_suppliedElectronEfficiencyTools)
        all_tools += " " + tool.name();
      for (auto& tool : m_parent.m_suppliedElectronScaleFactorTools)
        all_tools += " " + tool.name();
      for (auto& tool : m_parent.m_suppliedPhotonEfficiencyTools)
        all_tools += " " + tool.name();
      for (auto& tool : m_parent.m_suppliedPhotonScaleFactorTools)
        all_tools += " " + tool.name();
      ATH_MSG_ERROR("Unknown tool "
                    << name << " mentioned in property 'ListOfTagsPerTool'");
    }
  }
  if (nMuonToolsWithTags &&
      (nMuonToolsWithTags != m_parent.m_suppliedMuonTools.size())) {
    ATH_MSG_ERROR(
        "Not all muon tools have been associated with tags in the "
        "'ListOfTagsPerTool' property");
    success = false;
  }
  unsigned nSupplied = m_parent.m_suppliedElectronEfficiencyTools.size() +
                       m_parent.m_suppliedElectronScaleFactorTools.size();
  if (nElectronToolsWithTags && (nElectronToolsWithTags != nSupplied)) {
    ATH_MSG_ERROR(
        "Not all electron tools have been associated with tags in the "
        "'ListOfTagsPerTool' property");
    success = false;
  }
  if (!success)
    return false;
  nSupplied = m_parent.m_suppliedPhotonEfficiencyTools.size() +
              m_parent.m_suppliedPhotonScaleFactorTools.size();
  if (nPhotonToolsWithTags && (nPhotonToolsWithTags != nSupplied)) {
    ATH_MSG_ERROR(
        "Not all photon tools have been associated with tags in the "
        "'ListOfTagsPerTool' property");
    success = false;
  }
  if (!success)
    return false;
 
  /*
   *  More checks that are done in other places (or still need to be
   * implemented!):
   *
   * - [advancedConfigChecks()] for each entry in ListOfLegsPerTag there must be
   * a suitable tool for that tag and leg(s)
   * - [enumerateTools()] no two electron/photon tools share the same {leg,tag}
   * combination
   * - [enumerateTools()] no two muon tools share the same tag
   * - [advancedConfigChecks()] electron efficiency and scale factors have
   * identical configurations: for each eff. tool leg/tag we must find a SF
   * tool, and the other leg/tag pairs associated to those tools must be
   * identical.
   * - [UNCHECKED] if tags are used with electron (resp. muon, photon) tools,
   * then all electron (muon, photon) tools must have an entry in
   * ListOfTagsPerTool. Done partially in this function, but the case where no
   * tools are tagged (yet tags are used, according to ListOfLegsPerTag or
   * LeptonTagDecorations) escapes detection.
   * - [loadTagsConfiguration()] each entry of ListOfLegsPerTag can be matched
   * to a suitable tool
   * - [UNCHECKED] suffixed tag read from a lepton must correspond to a know tag
   * - [enumerateTools()] list of legs associated to each tool contains only
   * known legs
   * - [UNCHECKED TrigGlobEffCorrImportData import* functions] various
   * consistency checks of the configuration files
   * - [advancedConfigChecks()] user-specified periods are orthogonal
   * - [ImportData::parseTriggerString()] no duplicated triggers in the
   * combination
   * - [UNCHECKED] for each configured electron/photon tool there is at least
   * one associated tag^leg pair in 'ListOfLegsPerTag' (unless no
   * electron/photon tags used)
   * - [UNCHECKED] for each configured muon tool there is at least one
   * associated tag in 'MuonLegsPerTag' (unless empty)
   * - [enumerateTools()] electron tools can't be associated to photon legs; and
   * reciprocally
   */
 
  return success;
}

findToolByName()

template<class CPTool>

ToolHandle< CPTool > * CheckConfig::findToolByName ( ToolHandleArray< CPTool > & suppliedTools, const std::string & name )

staticprivate

Definition at line 24 of file CheckConfig.cxx.

                                                                   {
  for (auto& tool : suppliedTools) {
    if (tool.name() == name ||
        tool->name() == name)  // athena: not always the same
    {
      return &tool;
    }
  }
  return nullptr;
}

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const

inherited

The standard message stream.

Returns

A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

                                      {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg();
#else // not XAOD_STANDALONE
      return m_msg;
#endif // not XAOD_STANDALONE
   }

msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns

A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

                                                          {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg( lvl );
#else // not XAOD_STANDALONE
      m_msg << lvl;
      return m_msg;
#endif // not XAOD_STANDALONE
   }

msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns

boolean Indicting if messages at given level will be printed

true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

                                                       {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msgLvl( lvl );
#else // not XAOD_STANDALONE
      return m_msg.msgLevel( lvl );
#endif // not XAOD_STANDALONE
   }

setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging).

Definition at line 141 of file AthMessaging.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels).

Definition at line 132 of file AthMessaging.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_parent

TrigGlobalEfficiencyCorrectionTool& TrigGlobEffCorr::CheckConfig::m_parent

private

Definition at line 26 of file CheckConfig.h.

---

The documentation for this class was generated from the following files:

• CheckConfig.h
• CheckConfig.cxx