Base class for RoI unpackers. More...

#include <RoIsUnpackingToolBase.h>

Inherits extends< AthAlgTool, IRoIsUnpackingTool >.

Inherited by RoIsUnpackingToolPhase1< T_RoI, T_RoIContainer, F_RoIWordGetter, ContainerName, ThresholdType >, EMRoIsUnpackingTool, FSRoIsUnpackingTool, JRoIsUnpackingTool, METRoIsUnpackingTool, MURoIsUnpackingTool, RoIsUnpackingEmulationTool, RoIsUnpackingToolPhase1< T_RoI, T_RoIContainer, F_RoIWordGetter, N_RoIContainer, N_ThresholdType >, and TAURoIsUnpackingTool.

Collaboration diagram for RoIsUnpackingToolBase:

Public Member Functions
	RoIsUnpackingToolBase (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () 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

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.
StatusCode	decodeMapping (std::function< bool(const std::string &)> &&filter)
	Fills mapping from L1 threshold -> to HLT chain.
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.

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
Data dependencies
SG::WriteHandleKey< TrigCompositeUtils::DecisionContainer >	m_decisionsKey
SG::WriteHandleKey< TrigCompositeUtils::DecisionContainer >	m_decisionsKeyProbe
SG::WriteHandleKey< TrigRoiDescriptorCollection >	m_trigRoIsKey
SG::ReadHandleKey< TrigConf::L1Menu >	m_l1MenuKey
SG::ReadHandleKey< TrigConf::HLTMenu >	m_HLTMenuKey

Detailed Description

Base class for RoI unpackers.

Provides common features needed by all unpackers. By itself it does not do anything useful.

Definition at line 32 of file RoIsUnpackingToolBase.h.

Member Typedef Documentation

◆ ThrVec

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

protected

Definition at line 73 of file RoIsUnpackingToolBase.h.

◆ ThrVecRef

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

protected

Definition at line 74 of file RoIsUnpackingToolBase.h.

Constructor & Destructor Documentation

◆ RoIsUnpackingToolBase()

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

Definition at line 10 of file RoIsUnpackingToolBase.cxx.

13 : base_class(type, name, parent) {}

Member Function Documentation

◆ addChainsToDecision()

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

protected

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 )

protected

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

protected

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 )

staticprotected

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 RoIsUnpackingToolBase::initialize ( )

overridevirtual

should this really be here if it is only accessed in derived classes ?

Reimplemented in EMRoIsUnpackingTool, FSRoIsUnpackingTool, JRoIsUnpackingTool, METRoIsUnpackingTool, MURoIsUnpackingTool, RoIsUnpackingEmulationTool, RoIsUnpackingToolPhase1< T_RoI, T_RoIContainer, F_RoIWordGetter, N_RoIContainer, N_ThresholdType >, RoIsUnpackingToolPhase1< T_RoI, T_RoIContainer, F_RoIWordGetter, ContainerName, ThresholdType >, and TAURoIsUnpackingTool.

Definition at line 16 of file RoIsUnpackingToolBase.cxx.

                                             {
 
  if ( !m_monTool.empty() )     ATH_CHECK( m_monTool.retrieve() );
  if ( !m_roiupdater.empty() )  ATH_CHECK( m_roiupdater.retrieve() );
 
  ATH_CHECK( m_decisionsKey.initialize() );
  ATH_CHECK( m_decisionsKeyProbe.initialize(SG::AllowEmpty) );
  ATH_CHECK( m_trigRoIsKey.initialize(SG::AllowEmpty) );
  ATH_CHECK( m_l1MenuKey.initialize() );
  ATH_CHECK( m_HLTMenuKey.initialize() );
 
  return StatusCode::SUCCESS;
}

◆ unpack() [1/2]

virtual StatusCode RoIsUnpackingToolBase::unpack	(	const EventContext &	,
		const ROIB::RoIBResult &	,
		const HLT::IDSet &	) const

inlineoverridevirtual

Reimplemented in EMRoIsUnpackingTool, FSRoIsUnpackingTool, JRoIsUnpackingTool, METRoIsUnpackingTool, MURoIsUnpackingTool, RoIsUnpackingEmulationTool, RoIsUnpackingToolPhase1< T_RoI, T_RoIContainer, F_RoIWordGetter, N_RoIContainer, N_ThresholdType >, RoIsUnpackingToolPhase1< T_RoI, T_RoIContainer, F_RoIWordGetter, ContainerName, ThresholdType >, and TAURoIsUnpackingTool.

Definition at line 40 of file RoIsUnpackingToolBase.h.

42 { return StatusCode::SUCCESS; }

◆ unpack() [2/2]

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

inlineoverridevirtual

Reimplemented in EMRoIsUnpackingTool, FSRoIsUnpackingTool, JRoIsUnpackingTool, METRoIsUnpackingTool, MURoIsUnpackingTool, RoIsUnpackingEmulationTool, RoIsUnpackingToolPhase1< T_RoI, T_RoIContainer, F_RoIWordGetter, N_RoIContainer, N_ThresholdType >, RoIsUnpackingToolPhase1< T_RoI, T_RoIContainer, F_RoIWordGetter, ContainerName, ThresholdType >, and TAURoIsUnpackingTool.

Definition at line 44 of file RoIsUnpackingToolBase.h.

46 { return StatusCode::SUCCESS; }

Member Data Documentation

◆ m_decisionsKey

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

protected

Initial value:

{

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

Definition at line 51 of file RoIsUnpackingToolBase.h.

51 {

52 this, "Decisions", "RoIDecisions", "Decisions for each RoI"};

◆ m_decisionsKeyProbe

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

protected

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.

54 {

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

◆ m_HLTMenuKey

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

protected

Initial value:

{

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

Definition at line 63 of file RoIsUnpackingToolBase.h.

63 {

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

◆ m_l1MenuKey

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

protected

Initial value:

{

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

Definition at line 60 of file RoIsUnpackingToolBase.h.

60 {

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

◆ m_legToChainMapping

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

protected

Definition at line 71 of file RoIsUnpackingToolBase.h.

◆ m_monTool

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

protected

Definition at line 67 of file RoIsUnpackingToolBase.h.

67{ this, "MonTool", "", "Monitoring tool" };

◆ m_roiupdater

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

protected

Definition at line 68 of file RoIsUnpackingToolBase.h.

68{ this, "RoiUpdater", "", "Roi Updater" };

◆ m_thresholdToChainMapping

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

protected

Definition at line 70 of file RoIsUnpackingToolBase.h.

◆ m_trigRoIsKey

SG::WriteHandleKey<TrigRoiDescriptorCollection> RoIsUnpackingToolBase::m_trigRoIsKey

protected

Initial value:

{

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

Definition at line 57 of file RoIsUnpackingToolBase.h.

57 {

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

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

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ThrVec

◆ ThrVecRef

Constructor & Destructor Documentation

◆ RoIsUnpackingToolBase()

Member Function Documentation

◆ addChainsToDecision()

◆ decodeMapping()

◆ getL1Thresholds()

◆ getProbeThresholdName()

◆ initialize()

◆ unpack() [1/2]

◆ unpack() [2/2]

Member Data Documentation

◆ m_decisionsKey

◆ m_decisionsKeyProbe

◆ m_HLTMenuKey

◆ m_l1MenuKey

◆ m_legToChainMapping

◆ m_monTool

◆ m_roiupdater

◆ m_thresholdToChainMapping

◆ m_trigRoIsKey