ViewCreatorExtraPrefetchROITool Class Reference

RoI provider wrapper tool which calls another RoI provider tool first, and then uses its output RoI to create a new RoI using the RoiUpdaterTool. More...

#include <ViewCreatorExtraPrefetchROITool.h>

Inheritance diagram for ViewCreatorExtraPrefetchROITool:

Collaboration diagram for ViewCreatorExtraPrefetchROITool:

Public Member Functions
	ViewCreatorExtraPrefetchROITool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override
virtual StatusCode	attachROILinks (TrigCompositeUtils::DecisionContainer &decisions, const EventContext &eventContext) const override

Private Attributes
SG::WriteHandleKey< TrigRoiDescriptorCollection >	m_extraRoiWHK
Gaudi::Property< std::string >	m_extraRoiLinkName
Gaudi::Property< bool >	m_mergeWithOriginal
ToolHandle< IViewCreatorROITool >	m_roiCreator { this, "RoiCreator", "", "The main RoI creator tool" }
ToolHandle< IRoiUpdaterTool >	m_roiUpdater { this, "RoiUpdater", "", "RoI Updater" }

Detailed Description

RoI provider wrapper tool which calls another RoI provider tool first, and then uses its output RoI to create a new RoI using the RoiUpdaterTool.

This new RoI is saved in a different output container and can be used to prefetch ROBs instead of the original one. This solution was invented to prefetch ROBs for the second Tau reco step already during the first Tau reco step, see ATR-26419.

Definition at line 21 of file ViewCreatorExtraPrefetchROITool.h.

Constructor & Destructor Documentation

ViewCreatorExtraPrefetchROITool()

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

Definition at line 6 of file ViewCreatorExtraPrefetchROITool.cxx.

: base_class(type, name, parent) {}

Member Function Documentation

attachROILinks()

StatusCode ViewCreatorExtraPrefetchROITool::attachROILinks ( TrigCompositeUtils::DecisionContainer & decisions, const EventContext & eventContext ) const

overridevirtual

Definition at line 16 of file ViewCreatorExtraPrefetchROITool.cxx.

                                                                                                                                                 {
  using namespace TrigCompositeUtils;
 
  // Call the main RoI creator tool
  ATH_CHECK(m_roiCreator->attachROILinks(decisions, eventContext));
 
  // Record the updated RoI container
  SG::WriteHandle<TrigRoiDescriptorCollection> outputRois = createAndStoreNoAux(m_extraRoiWHK, eventContext);
 
  // Loop over all decisions and create updated RoI for each RoI linked by the main tool
  for (Decision* decision : decisions) {
    // Get the original RoI from the main tool
    const ElementLink<TrigRoiDescriptorCollection> roiEL = decision->objectLink<TrigRoiDescriptorCollection>(roiString());
    ATH_CHECK(roiEL.isValid());
    const TrigRoiDescriptor* originalRoi = *roiEL;
 
    // Execute the updater tool
    std::unique_ptr<TrigRoiDescriptor> updatedRoi = m_roiUpdater->execute(originalRoi, eventContext);
 
    // Add the updated (and merged if requested) RoI to the output container
    if (m_mergeWithOriginal.value()) {
      outputRois->push_back(std::make_unique<TrigRoiDescriptor>());
      outputRois->back()->setComposite(true);
      outputRois->back()->manageConstituents(true); // take ownership of the two objects added below
      outputRois->back()->push_back(new TrigRoiDescriptor(*originalRoi));
      outputRois->back()->push_back(updatedRoi.release());
    } else {
      outputRois->push_back(std::move(updatedRoi));
    }
 
    // Link the last element of the output container to the current decision object
    const ElementLink<TrigRoiDescriptorCollection> newRoiEL{*outputRois, outputRois->size()-1, eventContext};
    decision->setObjectLink(m_extraRoiLinkName, newRoiEL);
  }
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode ViewCreatorExtraPrefetchROITool::initialize ( )

overridevirtual

Definition at line 9 of file ViewCreatorExtraPrefetchROITool.cxx.

                                                       {
  ATH_CHECK(m_extraRoiWHK.initialize());
  ATH_CHECK(m_roiCreator.retrieve());
  ATH_CHECK(m_roiUpdater.retrieve());
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_extraRoiLinkName

Gaudi::Property<std::string> ViewCreatorExtraPrefetchROITool::m_extraRoiLinkName

private

Initial value:

{
    this, "PrefetchRoIsLinkName", "prefetchRoI", "Name of the link from a decision object to the RoI for prefetching"}

Definition at line 30 of file ViewCreatorExtraPrefetchROITool.h.

                                             {
    this, "PrefetchRoIsLinkName", "prefetchRoI", "Name of the link from a decision object to the RoI for prefetching"};

m_extraRoiWHK

SG::WriteHandleKey<TrigRoiDescriptorCollection> ViewCreatorExtraPrefetchROITool::m_extraRoiWHK

private

Initial value:

{
    this, "ExtraPrefetchRoIsKey", "", "Name of the extra RoI collection to be used for prefetching"}

Definition at line 28 of file ViewCreatorExtraPrefetchROITool.h.

                                                             {
    this, "ExtraPrefetchRoIsKey", "", "Name of the extra RoI collection to be used for prefetching"};

m_mergeWithOriginal

Gaudi::Property<bool> ViewCreatorExtraPrefetchROITool::m_mergeWithOriginal

private

Initial value:

{
    this, "MergeWithOriginal", true, "Make the output RoI be a super-RoI combining the original and updated ones"}

Definition at line 32 of file ViewCreatorExtraPrefetchROITool.h.

                                         {
    this, "MergeWithOriginal", true, "Make the output RoI be a super-RoI combining the original and updated ones"};

m_roiCreator

ToolHandle<IViewCreatorROITool> ViewCreatorExtraPrefetchROITool::m_roiCreator { this, "RoiCreator", "", "The main RoI creator tool" }

private

Definition at line 35 of file ViewCreatorExtraPrefetchROITool.h.

{ this, "RoiCreator", "", "The main RoI creator tool" };

m_roiUpdater

ToolHandle<IRoiUpdaterTool> ViewCreatorExtraPrefetchROITool::m_roiUpdater { this, "RoiUpdater", "", "RoI Updater" }

private

Definition at line 36 of file ViewCreatorExtraPrefetchROITool.h.

{ this, "RoiUpdater", "", "RoI Updater" };

---

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

• ViewCreatorExtraPrefetchROITool.h
• ViewCreatorExtraPrefetchROITool.cxx