DerivationFramework::TriggerMatchingTool Class Reference

Tool to perform trigger matching in the derivation framework. More...

#include <TriggerMatchingTool.h>

Inheritance diagram for DerivationFramework::TriggerMatchingTool:

Collaboration diagram for DerivationFramework::TriggerMatchingTool:

Public Types
using	particleVec_t = std::vector<const xAOD::IParticle *>
	Helper typedefs.

Public Member Functions
	TriggerMatchingTool (const std::string &type, const std::string &name, const IInterface *pSvcLocator)
	Constructor.
virtual StatusCode	initialize () override
	Initialize the tool.
virtual StatusCode	addBranches (const EventContext &ctx) const override
	Calculate the matchings.

Private Member Functions
StatusCode	createOutputContainer (xAOD::TrigCompositeContainer *&container, const std::string &chain) const
	Create an output container for the named chain.
const particleVec_t &	getCandidateMatchesFor (const xAOD::IParticle *part, std::map< xAOD::Type::ObjectType, particleVec_t > &offlineParticles, std::map< const xAOD::IParticle *, particleVec_t > &cache) const
	Get all offline particles that could match a given online one.
bool	matchParticles (const xAOD::IParticle *lhs, const xAOD::IParticle *rhs) const
	Check if the dR between two particles is below threshold.

Private Attributes
std::vector< std::string > m_chainNames	ATLAS_THREAD_SAFE
	The list of chain names to match.
ToolHandle< Trig::IIParticleRetrievalTool >	m_trigParticleTool {"Trig::IParticleRetrievalTool/OnlineParticleTool"}
	The tool to retrieve the online candidates.
std::map< xAOD::Type::ObjectType, SG::ReadHandleKey< xAOD::IParticleContainer > >	m_offlineInputs
	The input containers to use. These are keyed by xAOD object type.
float	m_drThreshold
	The DR threshold to use.
bool	m_rerun
	Whether to match in rerun mode or not.
std::string	m_outputPrefix
	The prefix to place at the beginning of the output containers.
bool	m_checkEmptyChainGroups
	If set, discard any triggers with empty chain groups (break the job otherwise).
bool	m_inputDependentConfig
	If using an input-file-dependent config then we warn when triggers are removed.
ToolHandle< Trig::TrigDecisionTool >	m_tdt {"Trig::TrigDecisionTool/TrigDecisionTool"}
	The trig decision tool.
ToolHandle< Trig::IMatchScoringTool >	m_scoreTool
	The pair scoring tool.

Detailed Description

Tool to perform trigger matching in the derivation framework.

Trigger matching in the derivation framework has to take the reverse approach to matching in analysis code. There, the matching tool is provided with a list of analysis particles to match to a given trigger. The navigation then proceeds to search out all features that match the types of those particles. In the derivation framework however, we need to get the full list of all particles that a user could ask for in their analysis code. To do this, we ask the navigation for all the relevant xAOD objects and then use those to query the available offline objects.

Author

Jon Burr

Definition at line 38 of file TriggerMatchingTool.h.

Member Typedef Documentation

particleVec_t

using DerivationFramework::TriggerMatchingTool::particleVec_t = std::vector<const xAOD::IParticle *>

Helper typedefs.

Definition at line 42 of file TriggerMatchingTool.h.

Constructor & Destructor Documentation

TriggerMatchingTool()

DerivationFramework::TriggerMatchingTool::TriggerMatchingTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	pSvcLocator )

Constructor.

Definition at line 41 of file TriggerMatchingTool.cxx.

                                     :
    base_class(type, name, pSvcLocator)
  {
    declareProperty("ChainNames", m_chainNames, 
        "The list of trigger chains to match.");
    declareProperty("OnlineParticleTool", m_trigParticleTool,
        "The tool to retrieve online particles from the navigation.");
    declareProperty("InputElectrons",
        m_offlineInputs[xAOD::Type::Electron] = "Electrons",
        "Offline electron candidates for matching.");
    declareProperty("InputPhotons",
        m_offlineInputs[xAOD::Type::Photon] = "Photons",
        "Offline photon candidates for matching.");
    declareProperty("InputMuons",
        m_offlineInputs[xAOD::Type::Muon] = "Muons",
        "Offline muon candidates for matching.");
    declareProperty("InputTaus",
        m_offlineInputs[xAOD::Type::Tau] = "TauJets",
        "Offline tau candidates for matching.");
    declareProperty("DRThreshold", m_drThreshold = 0.1,
        "The maximum dR between an offline and an online particle to consider "
        "a match between them.");
    declareProperty("Rerun", m_rerun = true,
        "Whether to match triggers in rerun mode.");
    declareProperty("OutputContainerPrefix", m_outputPrefix="TrigMatch_",
        "The prefix to add to the output containers.");
    declareProperty("CheckEmptyChainGroups", m_checkEmptyChainGroups = true,
        "If set, discard any empty chain groups. Otherwise these will cause "
        "a job failure.");
    declareProperty("InputDependentConfig", m_inputDependentConfig=false,
        "Warn when a trigger is removed (if the configuration is dependent "
        "on the inputs, removal is not expected).");
  }

Member Function Documentation

addBranches()

StatusCode DerivationFramework::TriggerMatchingTool::addBranches ( const EventContext & ctx ) const

overridevirtual

Calculate the matchings.

Definition at line 95 of file TriggerMatchingTool.cxx.

  {
    [[maybe_unused]] static const bool firstEvent = [&](){
      auto itr = m_chainNames.begin();
      while (itr != m_chainNames.end() ) {
        const Trig::ChainGroup* cg = m_tdt->getChainGroup(*itr);
        if (cg->getListOfTriggers().size() == 0){
          if (m_inputDependentConfig)
            ATH_MSG_WARNING("Removing trigger " << (*itr) << " -- suggests a bad tool configuration (asking for triggers not in the menu)");
          // We are now modifying the mutable m_chainNames but since it is done
          // within this static initialization this is thread-safe:
          itr = m_chainNames.erase(itr);
        } else
          ++itr;
      }
      return false;
    }();
 
    const Atlas::ExtendedEventContext &extendedCtx = Atlas::getExtendedEventContext(ctx);
 
    // Now, get all the possible offline candidates
    std::map<xAOD::Type::ObjectType, const xAOD::IParticleContainer *> offlineContainers;
    std::map<xAOD::Type::ObjectType, particleVec_t> offlineCandidates;
    for (const auto& p : m_offlineInputs) {
      // Skip any that may have been disabled by providing an empty string to
      // the corresponding property
      if (p.second.empty() )
        continue;
      auto handle = SG::makeHandle(p.second, ctx);
      if (!handle.isValid())
      {
        ATH_MSG_ERROR("Failed to retrieve " << p.second);
        return StatusCode::FAILURE;
      }
      offlineContainers[p.first] = handle.ptr();
      offlineCandidates.emplace(std::make_pair(
          p.first, 
          particleVec_t(handle->begin(), handle->end() )
      ) );
    }
 
    // Store possible matches from online to offline particles here
    // We do this as multiple chains may use the same online particles so we can
    // reuse this information.
    std::map<const xAOD::IParticle*, particleVec_t> matches;
 
    // Iterate through the chains to get the matchings
    for (const std::string& chain : m_chainNames) {
      // Create the output
      xAOD::TrigCompositeContainer* container(nullptr);
      ATH_CHECK( createOutputContainer(container, chain) );
 
      // Get the list of online combinations
      std::vector<particleVec_t> onlineCombinations;
      ATH_CHECK( m_trigParticleTool->retrieveParticles(onlineCombinations, chain, m_rerun) );
 
      ATH_MSG_DEBUG(
          onlineCombinations.size() << " combinations found for chain" << chain);
      
      // If no combinations were found (because the trigger was not passed) then
      // we can skip this trigger
      if (onlineCombinations.size() == 0)
        continue;
 
      using particleRange_t = TriggerMatchingUtils::RangedItr<typename particleVec_t::const_iterator>;
      // Now build up the list of offline combinations;
      std::vector<particleVec_t> offlineCombinations;
 
      // Projection operator to use for comparing vectors
      // of IParticle*.  Compare by using the sum of the pts
      // of all particles in the vector.
      struct outerproj {
        double operator() (const particleVec_t& v) const
        {
          // Unfortunately std::ranges::accumulate hasn't made it into C++
          // as of C++23 or we could use that directly.
          auto r = std::views::transform (v, &xAOD::IParticle::pt);
          return std::accumulate (std::begin(r), std::end(r), 0);
        }
      };
 
      for (const particleVec_t& combination : onlineCombinations) {
        // Here we store the possible candidates for the matching. We use the
        // range type as a lightweight method to carry around a view of a vector
        // without copying it (the RangedItr is essentially a combination of 3
        // iterators).
        std::vector<particleRange_t> matchCandidates;
        for (const xAOD::IParticle* part : combination) {
          const particleVec_t& possibleMatches = getCandidateMatchesFor(
              part, offlineCandidates, matches);
          matchCandidates.emplace_back(possibleMatches.begin(), possibleMatches.end() );
        } //> end loop over particles
        // Get all possible combinations of offline objects that could match to
        // this particular online combination.
        auto theseOfflineCombinations = 
          TriggerMatchingUtils::getAllDistinctCombinations<const xAOD::IParticle*>(
              matchCandidates,
              &xAOD::IParticle::pt,
              outerproj());
        if (msgLvl(MSG::VERBOSE) ) {
          // Spit out some verbose information
          ATH_MSG_VERBOSE(
              "Checking matching for chain " << chain
              << " with " << matchCandidates.size() << " legs");
          std::size_t idx = 0;
          for (const particleRange_t& range : matchCandidates)
            ATH_MSG_VERBOSE( "Leg #" << idx++ << " has " << range.size()
                << " offline candidates." );
          ATH_MSG_VERBOSE(
              "Matching generated " << theseOfflineCombinations.size()
              << " offline combinations");
        }
        // Now push them back into the output. Use a specialised function for
        // inserting into a sorted vector that ensures that we only output
        // unique combinations
        for (const particleVec_t& vec : theseOfflineCombinations)
          TriggerMatchingUtils::insertIntoSortedVector(offlineCombinations, vec, outerproj());
      } //> end loop over combinations
 
 
      // Decorate the found combinations onto trigger composites.
      for (const particleVec_t& foundCombination : offlineCombinations) {
        xAOD::TrigComposite* composite = new xAOD::TrigComposite();
        container->push_back(composite);
        static const acc_t<vecLink_t<xAOD::IParticleContainer>> dec_links(
            "TrigMatchedObjects");
        vecLink_t<xAOD::IParticleContainer>& links = dec_links(*composite);
        for (const xAOD::IParticle* part : foundCombination) {
          const xAOD::IParticleContainer *container = offlineContainers.at(part->type());
          // If we have an owning container then things are relatively simple:
          // we can just construct the element link from its SG key and the
          // index. Otherwise we have to locate the correct proxy from the element
          if (container->trackIndices())
            links.emplace_back(
                m_offlineInputs.at(part->type()).key(),
                part->index(),
                extendedCtx.proxy());
          else
            links.push_back(makeLink<xAOD::IParticleContainer>(part, extendedCtx.proxy()));
        }
      } //> end loop over the found combinations
    } //> end loop over chains
    return StatusCode::SUCCESS;
  }

createOutputContainer()

StatusCode DerivationFramework::TriggerMatchingTool::createOutputContainer ( xAOD::TrigCompositeContainer *& container, const std::string & chain ) const

private

Create an output container for the named chain.

Parameters

[out]	container	A pointer to the created container
	chain	The name of the chain to create the container for The container will be recorded in the StoreGate using the name of the chain as a key.

Definition at line 240 of file TriggerMatchingTool.cxx.

  {
    auto uniqueContainer = std::make_unique<xAOD::TrigCompositeContainer>();
    auto aux = std::make_unique<xAOD::AuxContainerBase>();
    uniqueContainer->setStore(aux.get() );
    container = uniqueContainer.get();
    std::string name = m_outputPrefix+chain;
    // We have to replace '.' characters with '_' characters so that these are
    // valid container names...
    std::replace(name.begin(), name.end(), '.', '_');
    ATH_CHECK( evtStore()->record(std::move(uniqueContainer), name) );
    ATH_CHECK( evtStore()->record(std::move(aux), name+"Aux.") );
    return StatusCode::SUCCESS;
  }

getCandidateMatchesFor()

const TriggerMatchingTool::particleVec_t & DerivationFramework::TriggerMatchingTool::getCandidateMatchesFor ( const xAOD::IParticle * part, std::map< xAOD::Type::ObjectType, particleVec_t > & offlineParticles, std::map< const xAOD::IParticle *, particleVec_t > & cache ) const

private

Get all offline particles that could match a given online one.

Parameters

part	The online particle to match against.
offlineParticles	The offline particles, key by xAOD type.
cache	Store past matches here to speed up future look ups.

Definition at line 257 of file TriggerMatchingTool.cxx.

  {
    // Build up all the possible matches between online and offline particles
    auto cacheItr = cache.find(part);
    if (cacheItr == cache.end() ) {
      xAOD::Type::ObjectType type = part->type();
      particleVec_t candidates;
      if (type == xAOD::Type::CaloCluster) {
        // If it's a calo cluster then we need to get the cluster from the
        // egamma types.
        static const constAcc_t<vecLink_t<xAOD::CaloClusterContainer>> acc_calo("caloClusterLinks");
        for (xAOD::Type::ObjectType egType : {
            xAOD::Type::Electron, xAOD::Type::Photon})
        {
          for (const xAOD::IParticle* cand : offlineParticles[egType]) {
            const vecLink_t<xAOD::CaloClusterContainer>& links = acc_calo(*cand);
            if (links.size() == 0 || !links.at(0).isValid() )
              continue;
            const xAOD::CaloCluster* clus = *links.at(0);
            if (matchParticles(part, clus) )
              candidates.push_back(cand);
          }
        }
      }
      else {
        for (const xAOD::IParticle* cand : offlineParticles[type])
          if (matchParticles(part, cand) )
            candidates.push_back(cand);
      }
      cacheItr = cache.emplace(
          std::make_pair(part, std::move(candidates) ) ).first;
    }
    return cacheItr->second;
  }

initialize()

StatusCode DerivationFramework::TriggerMatchingTool::initialize ( )

overridevirtual

Initialize the tool.

Definition at line 78 of file TriggerMatchingTool.cxx.

  {
    ATH_MSG_INFO( "Initializing " << name() );
 
    // Remove any duplicates from the list of chain names
    std::sort(m_chainNames.begin(), m_chainNames.end() );
    m_chainNames.erase(std::unique(m_chainNames.begin(), m_chainNames.end() ), m_chainNames.end() );
 
    ATH_CHECK( m_trigParticleTool.retrieve() );
    ATH_CHECK( m_scoreTool.retrieve() );
    for (auto &p : m_offlineInputs)
    {
      ATH_CHECK(p.second.initialize(SG::AllowEmpty));
    }
    return StatusCode::SUCCESS;
  }

matchParticles()

bool DerivationFramework::TriggerMatchingTool::matchParticles ( const xAOD::IParticle * lhs, const xAOD::IParticle * rhs ) const

private

Check if the dR between two particles is below threshold.

Definition at line 295 of file TriggerMatchingTool.cxx.

  {
    return m_scoreTool->score(*lhs, *rhs) < m_drThreshold;
  }

Member Data Documentation

ATLAS_THREAD_SAFE

std::vector<std::string> m_chainNames DerivationFramework::TriggerMatchingTool::ATLAS_THREAD_SAFE

mutableprivate

The list of chain names to match.

Definition at line 58 of file TriggerMatchingTool.h.

m_checkEmptyChainGroups

bool DerivationFramework::TriggerMatchingTool::m_checkEmptyChainGroups

private

If set, discard any triggers with empty chain groups (break the job otherwise).

Definition at line 83 of file TriggerMatchingTool.h.

m_drThreshold

float DerivationFramework::TriggerMatchingTool::m_drThreshold

private

The DR threshold to use.

Definition at line 73 of file TriggerMatchingTool.h.

m_inputDependentConfig

bool DerivationFramework::TriggerMatchingTool::m_inputDependentConfig

private

If using an input-file-dependent config then we warn when triggers are removed.

Definition at line 87 of file TriggerMatchingTool.h.

m_offlineInputs

std::map<xAOD::Type::ObjectType, SG::ReadHandleKey<xAOD::IParticleContainer> > DerivationFramework::TriggerMatchingTool::m_offlineInputs

private

The input containers to use. These are keyed by xAOD object type.

Definition at line 70 of file TriggerMatchingTool.h.

m_outputPrefix

std::string DerivationFramework::TriggerMatchingTool::m_outputPrefix

private

The prefix to place at the beginning of the output containers.

Definition at line 79 of file TriggerMatchingTool.h.

m_rerun

bool DerivationFramework::TriggerMatchingTool::m_rerun

private

Whether to match in rerun mode or not.

Definition at line 76 of file TriggerMatchingTool.h.

m_scoreTool

ToolHandle<Trig::IMatchScoringTool> DerivationFramework::TriggerMatchingTool::m_scoreTool

private

Initial value:

{
        this, "ScoringTool", "Trig::DRScoringTool", "The pair scoring tool"}

The pair scoring tool.

Definition at line 93 of file TriggerMatchingTool.h.

                                                 {
        this, "ScoringTool", "Trig::DRScoringTool", "The pair scoring tool"};

m_tdt

ToolHandle<Trig::TrigDecisionTool> DerivationFramework::TriggerMatchingTool::m_tdt {"Trig::TrigDecisionTool/TrigDecisionTool"}

private

The trig decision tool.

Definition at line 90 of file TriggerMatchingTool.h.

{"Trig::TrigDecisionTool/TrigDecisionTool"};

m_trigParticleTool

ToolHandle<Trig::IIParticleRetrievalTool> DerivationFramework::TriggerMatchingTool::m_trigParticleTool {"Trig::IParticleRetrievalTool/OnlineParticleTool"}

private

The tool to retrieve the online candidates.

Definition at line 67 of file TriggerMatchingTool.h.

{"Trig::IParticleRetrievalTool/OnlineParticleTool"};

---

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

• TriggerMatchingTool.h
• TriggerMatchingTool.cxx