JRoIsUnpackingTool Class Reference

#include <JRoIsUnpackingTool.h>

Inheritance diagram for JRoIsUnpackingTool:

Collaboration diagram for JRoIsUnpackingTool:

Public Member Functions
	JRoIsUnpackingTool (const std::string &type, const std::string &name, const IInterface *parent)
StatusCode	unpack (const EventContext &ctx, const ROIB::RoIBResult &roib, const HLT::IDSet &activeChains) const override
virtual StatusCode	initialize () override
virtual StatusCode	start () override
virtual StatusCode	unpack (const EventContext &, const ROIB::RoIBResult &, const HLT::IDSet &) const override
virtual StatusCode	unpack (const EventContext &, const xAOD::TrigComposite &, const HLT::IDSet &) const override
virtual StatusCode	unpack (const EventContext &, const xAOD::TrigComposite &, const HLT::IDSet &) const override

Protected Types
using	ThrVec = std::vector< std::shared_ptr< TrigConf::L1Threshold > >
using	ThrVecRef = std::reference_wrapper< const ThrVec >

Protected Member Functions
StatusCode	getL1Thresholds (const TrigConf::L1Menu &l1Menu, const std::string &thrType, std::optional< ThrVecRef > &thrVec) const
	Retrieve a vector of thresholds with type thrType from L1Menu. More...
StatusCode	decodeMapping (std::function< bool(const std::string &)> &&filter)
	Fills mapping from L1 threshold -> to HLT chain. More...
void	addChainsToDecision (HLT::Identifier thresholdId, TrigCompositeUtils::Decision *d, const HLT::IDSet &activeChains) const

Static Protected Member Functions
static std::string	getProbeThresholdName (const std::string &thresholdName)
	Concatenate the probe identifier string with the threshold name string. More...

Protected Attributes
ToolHandle< GenericMonitoringTool >	m_monTool { this, "MonTool", "", "Monitoring tool" }
ToolHandle< IRoiUpdaterTool >	m_roiupdater { this, "RoiUpdater", "", "Roi Updater" }
std::map< HLT::Identifier, HLT::IDVec >	m_thresholdToChainMapping
std::map< HLT::Identifier, HLT::Identifier >	m_legToChainMapping

Private Attributes
SG::WriteHandleKey< DataVector< LVL1::RecJetRoI > >	m_recRoIsKey
Gaudi::Property< float >	m_roIWidth
Gaudi::Property< std::string >	m_fsRoIKey
LVL1::JEPRoIDecoder	m_jepDecoder

Detailed Description

Definition at line 13 of file JRoIsUnpackingTool.h.

Member Typedef Documentation

ThrVec

using RoIsUnpackingToolBase::ThrVec = std::vector<std::shared_ptr<TrigConf::L1Threshold> >

protectedinherited

Definition at line 73 of file RoIsUnpackingToolBase.h.

ThrVecRef

using RoIsUnpackingToolBase::ThrVecRef = std::reference_wrapper<const ThrVec>

protectedinherited

Definition at line 74 of file RoIsUnpackingToolBase.h.

Constructor & Destructor Documentation

JRoIsUnpackingTool()

JRoIsUnpackingTool::JRoIsUnpackingTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 11 of file JRoIsUnpackingTool.cxx.

  : RoIsUnpackingToolBase(type, name, parent) {}

Member Function Documentation

addChainsToDecision()

void RoIsUnpackingToolBase::addChainsToDecision ( HLT::Identifier  thresholdId, TrigCompositeUtils::Decision *  d, const HLT::IDSet &  activeChains  ) const

protectedinherited

Definition at line 88 of file RoIsUnpackingToolBase.cxx.

                                                                                      {
  auto chains = m_thresholdToChainMapping.find( thresholdId );
  if ( chains == m_thresholdToChainMapping.end() ) {
    ATH_MSG_DEBUG("Threshold not known " << thresholdId);
    return;
  }
 
  TrigCompositeUtils::DecisionIDContainer ids;
  for ( auto chainId: chains->second ) {
    if ( activeChains.find(chainId) != activeChains.end() ) {
      ids.insert( chainId.numeric() );
      ATH_MSG_DEBUG( "Added " << chainId << " to the RoI/threshold decision " << thresholdId );
    } else {    // maybe it is a leg?
      auto legIterator = m_legToChainMapping.find( chainId );
      if ( legIterator != m_legToChainMapping.end() ) {
        // this is a leg we care about, need to check if respective chain was active, and activate
        if ( activeChains.find( legIterator->second ) != activeChains.end() ) {
          ids.insert( chainId.numeric() );
          ATH_MSG_DEBUG( "Added " << chainId << " to the RoI/threshold decision " << thresholdId );
        }
      }
    }
  }
  TrigCompositeUtils::insertDecisionIDs(ids, d);
  ATH_MSG_DEBUG( "Number of decisions in this RoI after adding chains using threshold " << thresholdId
                 << " " << TrigCompositeUtils::decisionIDs( d ).size() );
}

decodeMapping()

StatusCode RoIsUnpackingToolBase::decodeMapping ( std::function< bool(const std::string &)> &&  filter )

protectedinherited

Fills mapping from L1 threshold -> to HLT chain.

• filter Function that, using the threshold name, defines if this decoder instance should take care of this threshold

Definition at line 52 of file RoIsUnpackingToolBase.cxx.

                                                                                              {
  SG::ReadHandle<TrigConf::HLTMenu>  hltMenuHandle = SG::makeHandle( m_HLTMenuKey );
  ATH_CHECK( hltMenuHandle.isValid() );
  // Cleanup in case there was a stop/start transition
  m_thresholdToChainMapping.clear();
  
  for ( const TrigConf::Chain& chain: *hltMenuHandle ) {
    const HLT::Identifier chainIdentifier(chain.name());
    const std::vector<std::string> thresholds{ chain.l1thresholds() };
    const std::vector<size_t> legMultiplicities{ chain.legMultiplicities() };
    if (thresholds.size() != legMultiplicities.size()) {
      ATH_MSG_ERROR("Encountered a chain " << chain.name() << " with " << legMultiplicities.size()
                    << " legs but only " << thresholds.size() << " thresholds. These should be the same.");
      return StatusCode::FAILURE;
    }
    size_t counter = 0;
    for ( const std::string& th: thresholds ) {
      if ( filter(th) ) {
        const HLT::Identifier thresholdIdentifier(th);
        m_thresholdToChainMapping[ thresholdIdentifier ].push_back( chainIdentifier );
        ATH_MSG_DEBUG( "Associating " << chainIdentifier << " with threshold " << th );
        if ( thresholds.size() > 1 ) {
          HLT::Identifier legIdentifier = TrigCompositeUtils::createLegName(chainIdentifier, counter);
          m_thresholdToChainMapping[ thresholdIdentifier ].push_back( legIdentifier );
          m_legToChainMapping.insert( std::make_pair( legIdentifier,  chainIdentifier ) );
          ATH_MSG_DEBUG( "Associating additional chain leg " << legIdentifier
                        << " with threshold " << thresholdIdentifier );
        }
      }
      ++counter;
    }
  }
  return StatusCode::SUCCESS;
}

getL1Thresholds()

StatusCode RoIsUnpackingToolBase::getL1Thresholds ( const TrigConf::L1Menu &  l1Menu, const std::string &  thrType, std::optional< ThrVecRef > &  thrVec  ) const

protectedinherited

Retrieve a vector of thresholds with type thrType from L1Menu.

Parameters

[in]	l1Menu	The L1Menu object
[in]	thrType	The threshold type, e.g. EM, MU, eTAU
[out]	thrVec	The output will be passed into this parameter

Returns

FAILURE on exception reading the menu (e.g. thrType not in menu), SUCCESS otherwise

Definition at line 33 of file RoIsUnpackingToolBase.cxx.

                                                                                        {
  try {
    thrVec = ThrVecRef(l1Menu.thresholds(thrType));
  }
  catch (const std::exception& ex) {
    ATH_MSG_ERROR("Failed to retrieve " << thrType << " thresholds from L1 menu. Exception:" << ex.what());
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

getProbeThresholdName()

std::string RoIsUnpackingToolBase::getProbeThresholdName ( const std::string &  thresholdName )

staticprotectedinherited

Concatenate the probe identifier string with the threshold name string.

Creates an alternate threshold name, used by lower pT probe legs of tag+probe chains.

Definition at line 47 of file RoIsUnpackingToolBase.cxx.

                                                                                     {
  return "PROBE" + thresholdName;
}

initialize()

StatusCode JRoIsUnpackingTool::initialize ( )

overridevirtual

Reimplemented from RoIsUnpackingToolBase.

Definition at line 17 of file JRoIsUnpackingTool.cxx.

                                          {
  ATH_CHECK( RoIsUnpackingToolBase::initialize() );
  ATH_CHECK( m_recRoIsKey.initialize() );
 
  return StatusCode::SUCCESS;
}

start()

StatusCode JRoIsUnpackingTool::start ( )

overridevirtual

Definition at line 25 of file JRoIsUnpackingTool.cxx.

                                     {
  ATH_CHECK(decodeMapping([](const std::string& name){
    return name.find('J') == 0 or name.find("JF") == 0 or name.find("JB") == 0;
  }));
  return StatusCode::SUCCESS;
}

unpack() [1/4]

virtual StatusCode RoIsUnpackingToolBase::unpack

inlineoverride

Definition at line 40 of file RoIsUnpackingToolBase.h.

                                                              { return StatusCode::SUCCESS; }

unpack() [2/4]

virtual StatusCode RoIsUnpackingToolBase::unpack

inlineoverride

Definition at line 44 of file RoIsUnpackingToolBase.h.

                                                              { return StatusCode::SUCCESS; }

unpack() [3/4]

virtual StatusCode RoIsUnpackingToolBase::unpack ( const EventContext &  , const xAOD::TrigComposite &  , const HLT::IDSet &    ) const

inlineoverridevirtualinherited

Definition at line 44 of file RoIsUnpackingToolBase.h.

                                                              { return StatusCode::SUCCESS; }

unpack() [4/4]

StatusCode JRoIsUnpackingTool::unpack ( const EventContext &  ctx, const ROIB::RoIBResult &  roib, const HLT::IDSet &  activeChains  ) const

overridevirtual

Reimplemented from RoIsUnpackingToolBase.

Definition at line 33 of file JRoIsUnpackingTool.cxx.

                                                                          {
  using namespace TrigCompositeUtils;
  // create and record the collections needed
  SG::WriteHandle<TrigRoiDescriptorCollection> trigRoIs = createAndStoreNoAux(m_trigRoIsKey, ctx );
  SG::WriteHandle< DataVector<LVL1::RecJetRoI> > recRoIs = createAndStoreNoAux( m_recRoIsKey, ctx );
  SG::WriteHandle<DecisionContainer> decisionOutput = createAndStore(m_decisionsKey, ctx );
 
  // Retrieve the L1 menu configuration
  SG::ReadHandle<TrigConf::L1Menu> l1Menu = SG::makeHandle(m_l1MenuKey, ctx);
  ATH_CHECK(l1Menu.isValid());
  std::optional<ThrVecRef> jetThresholds;
  ATH_CHECK(getL1Thresholds(*l1Menu, "JET", jetThresholds));
 
  // Flag if there was an overflow in the TOB transmission to CMX (there were more TOBs than can be transferred)
  bool overflow{false};
  constexpr static unsigned int s_maxJetTOBs{4}; // Hardcoded in L1Calo firmware, see ATR-23697 and ATR-12285
  std::unordered_map<unsigned int, std::unordered_map<unsigned int, unsigned int>> tobCounts; // {crate, {module, count}}
 
  // RoIBResult contains vector of jet fragments
  for ( const auto & jetFragment : roib.jetEnergyResult() ) {
    for ( const auto & roi : jetFragment.roIVec() ) {
      uint32_t roIWord = roi.roIWord();
      if ( not ( LVL1::TrigT1CaloDefs::JetRoIWordType == roi.roIType() ) )  {
        ATH_MSG_DEBUG( "Skipping RoI as it is not JET threshold " << roIWord <<" Type "<< roi.roIType() );
        continue;
      }
 
      if (!overflow) {
        unsigned int crate = m_jepDecoder.crate(roIWord);
        unsigned int module = m_jepDecoder.module(roIWord);
        overflow = (++tobCounts[crate][module] > s_maxJetTOBs);
      }
 
      recRoIs->push_back( std::make_unique<LVL1::RecJetRoI>(roIWord, l1Menu.cptr()) );
      const LVL1::RecJetRoI* recRoI = recRoIs->back();
 
      trigRoIs->push_back( std::make_unique<TrigRoiDescriptor>(
        roIWord, 0u ,0u,
        recRoI->eta(), recRoI->eta()-m_roIWidth, recRoI->eta()+m_roIWidth,
        recRoI->phi(), recRoI->phi()-m_roIWidth, recRoI->phi()+m_roIWidth) );
 
      ATH_MSG_DEBUG( "RoI word: 0x" << MSG::hex << std::setw( 8 ) << roIWord << MSG::dec );
 
      // The hltSeedingNodeName denotes an initial node with no parents
      Decision* decision = TrigCompositeUtils::newDecisionIn( decisionOutput.ptr(), hltSeedingNodeName() );
 
      std::vector<unsigned> passedThresholdIDs;
 
      for (const auto& th : jetThresholds.value().get()) {
        ATH_MSG_VERBOSE( "Checking if the threshold " << th->name() << " passed" );
        if ( recRoI->passedThreshold(th->mapping()) ) {
          passedThresholdIDs.push_back( HLT::Identifier( th->name() ) );
          ATH_MSG_DEBUG( "Passed Threshold name " << th->name() );
          addChainsToDecision( HLT::Identifier( th->name() ), decision, activeChains );
          ATH_MSG_DEBUG( "Labeled object with chains: " << [&](){
            TrigCompositeUtils::DecisionIDContainer ids;
            TrigCompositeUtils::decisionIDs( decision, ids );
            return std::vector<TrigCompositeUtils::DecisionID>( ids.begin(), ids.end() ); }() );
        }
      }
 
      decision->setDetail( "thresholds", passedThresholdIDs );
      decision->setObjectLink( initialRoIString(),
                               ElementLink<TrigRoiDescriptorCollection>(m_trigRoIsKey.key(), trigRoIs->size()-1, ctx) );
      decision->setObjectLink( initialRecRoIString(),
                               ElementLink<DataVector<LVL1::RecJetRoI>>(m_recRoIsKey.key(), recRoIs->size()-1, ctx) );
    }
  }
 
  // Decorate the decisions with overflow information
  if (overflow) {
    ATH_MSG_WARNING("L1Calo overflow for JET TOBs to CMX detected");
  }
  for (Decision* decision : *decisionOutput) {
    decision->setDetail("overflow", static_cast<char>(overflow));
  }
 
  if ( msgLvl(MSG::DEBUG) ) {
    for ( auto roi: *trigRoIs ) {
      ATH_MSG_DEBUG( "RoI Eta: " << roi->eta() << " Phi: " << roi->phi() << " RoIWord: " << roi->roiWord() );
    }
  }
 
  // monitoring
  {
    auto RoIsCount = Monitored::Scalar( "count", trigRoIs->size() );
    auto RoIsPhi   = Monitored::Collection( "phi", *trigRoIs, &TrigRoiDescriptor::phi );
    auto RoIsEta   = Monitored::Collection( "eta", *trigRoIs, &TrigRoiDescriptor::eta );
    Monitored::Group( m_monTool,  RoIsCount, RoIsEta, RoIsPhi );
  }
 
  ATH_MSG_DEBUG( "Unpacked " << trigRoIs->size() << " RoIs" );
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_decisionsKey

SG::WriteHandleKey<TrigCompositeUtils::DecisionContainer> RoIsUnpackingToolBase::m_decisionsKey

protectedinherited

Initial value:

{
    this, "Decisions", "RoIDecisions", "Decisions for each RoI"}

Definition at line 51 of file RoIsUnpackingToolBase.h.

m_decisionsKeyProbe

SG::WriteHandleKey<TrigCompositeUtils::DecisionContainer> RoIsUnpackingToolBase::m_decisionsKeyProbe

protectedinherited

Initial value:

{
    this, "DecisionsProbe", "", "Optional secondary set of Decisions for each RoI for probe a.k.a. delayed a.k.a. rerun chains"}

Definition at line 54 of file RoIsUnpackingToolBase.h.

m_fsRoIKey

Gaudi::Property<std::string> JRoIsUnpackingTool::m_fsRoIKey

private

Initial value:

{
    this, "FSRoIKey", "HLT_FSRoI", "The key of FS RoI made earlier by the HLTSeeding" }

Definition at line 35 of file JRoIsUnpackingTool.h.

m_HLTMenuKey

SG::ReadHandleKey<TrigConf::HLTMenu> RoIsUnpackingToolBase::m_HLTMenuKey

protectedinherited

Initial value:

{
    this, "HLTTriggerMenu", "DetectorStore+HLTTriggerMenu", "Name of the HLTMenu object to read configuration from"}

Definition at line 63 of file RoIsUnpackingToolBase.h.

m_jepDecoder

LVL1::JEPRoIDecoder JRoIsUnpackingTool::m_jepDecoder

private

Definition at line 38 of file JRoIsUnpackingTool.h.

m_l1MenuKey

SG::ReadHandleKey<TrigConf::L1Menu> RoIsUnpackingToolBase::m_l1MenuKey

protectedinherited

Initial value:

{
    this, "L1TriggerMenu", "DetectorStore+L1TriggerMenu", "Name of the L1Menu object to read configuration from"}

Definition at line 60 of file RoIsUnpackingToolBase.h.

m_legToChainMapping

std::map<HLT::Identifier, HLT::Identifier> RoIsUnpackingToolBase::m_legToChainMapping

protectedinherited

Definition at line 71 of file RoIsUnpackingToolBase.h.

m_monTool

ToolHandle<GenericMonitoringTool> RoIsUnpackingToolBase::m_monTool { this, "MonTool", "", "Monitoring tool" }

protectedinherited

Definition at line 67 of file RoIsUnpackingToolBase.h.

m_recRoIsKey

SG::WriteHandleKey< DataVector<LVL1::RecJetRoI> > JRoIsUnpackingTool::m_recRoIsKey

private

Initial value:

{
    this, "OutputRecRoIs", "HLT_RecJETRoIs", "Name of the RoIs object produced by the unpacker"}

Definition at line 29 of file JRoIsUnpackingTool.h.

m_roiupdater

ToolHandle<IRoiUpdaterTool> RoIsUnpackingToolBase::m_roiupdater { this, "RoiUpdater", "", "Roi Updater" }

protectedinherited

Definition at line 68 of file RoIsUnpackingToolBase.h.

m_roIWidth

Gaudi::Property<float> JRoIsUnpackingTool::m_roIWidth

private

Initial value:

{
    this, "RoIWidth", 0.4, "Size of RoI in eta/phi"}

Definition at line 32 of file JRoIsUnpackingTool.h.

m_thresholdToChainMapping

std::map<HLT::Identifier, HLT::IDVec> RoIsUnpackingToolBase::m_thresholdToChainMapping

protectedinherited

Definition at line 70 of file RoIsUnpackingToolBase.h.

m_trigRoIsKey

SG::WriteHandleKey<TrigRoiDescriptorCollection> RoIsUnpackingToolBase::m_trigRoIsKey

protectedinherited

Initial value:

{
    this, "OutputTrigRoIs", "", "Name of the RoIs collection produced by the unpacker"}

Definition at line 57 of file RoIsUnpackingToolBase.h.

---

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

• JRoIsUnpackingTool.h
• JRoIsUnpackingTool.cxx