ComboHypoToolBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef DECISIONHANDLING_COMBOHYPOTOOLBASE_H
#define DECISIONHANDLING_COMBOHYPOTOOLBASE_H
 
// Package includes
#include "DecisionHandling/IComboHypoTool.h"
 
// Framework includes
#include "AthenaBaseComps/AthAlgTool.h"
#include "TrigCompositeUtils/HLTIdentifier.h"
#include "TrigCompositeUtils/TrigCompositeUtils.h"
 
// STL includes
#include <string>
#include <vector>

 
class ComboHypoToolBase : public extends<AthAlgTool, IComboHypoTool> {
 
public:
  ComboHypoToolBase(const std::string& type, const std::string& name, const IInterface* parent);
    
  virtual StatusCode decide(Combo::LegDecisionsMap& passingLegs, const EventContext& ctx) const override;
    
  virtual HLT::Identifier decisionId() const { return m_decisionId; }

  StatusCode setLegMultiplicity(const Combo::MultiplicityReqMap& multiplicityRequiredMap);

  const std::vector<int>& legMultiplicity() const { return m_legMultiplicities; }

  HLT::Identifier legDecisionId(size_t i) const { return m_legDecisionIds.at(i); }

  const std::vector<HLT::Identifier>& legDecisionIds() const { return m_legDecisionIds; }

  virtual StatusCode decideOnSingleObject(TrigCompositeUtils::Decision*, const std::vector<const TrigCompositeUtils::DecisionIDContainer*>&) const;
    
 protected:

  virtual bool executeAlg(const std::vector<Combo::LegDecision>& combination, const EventContext& ctx) const;

  StatusCode selectLegs(const Combo::LegDecisionsMap& IDCombMap, std::vector<std::vector<Combo::LegDecision>>& leg_decisions) const;

  void updateLegDecisionsMap(const std::vector<std::vector<Combo::LegDecision>>& passing_comb, Combo::LegDecisionsMap & passingLegs) const;

  void eraseFromLegDecisionsMap(Combo::LegDecisionsMap &passingLegs) const;

  void printDebugInformation(const Combo::LegDecisionsMap & passingLegs) const;
 
  Gaudi::Property<size_t> m_combinationsThresholdWarn {this, "CombinationsThresholdWarn", 1000,
    "Events processing this many combinations will generate a WARNING message."};
 
  Gaudi::Property<size_t> m_combinationsThresholdBreak {this, "CombinationsThresholdBreak", 10000,
    "Events processing this many combinations will generate a second WARNING message, and the loop over combinations will be terminated at this point."};  
 
  Gaudi::Property<bool> m_modeOR {this, "ModeOR", true,
    "Accepts based on the logical OR over all calls to executeAlg. If this flag is set to false then the logical AND is required instead."}; 
 
  Gaudi::Property<bool> m_enableOverride {this, "EnableOverride", false,
    "Stops processing combinations as soon as a valid combination is found in OR mode, or as soon as an invalid combination is found in AND mode. This is to save CPU."}; 
 
  // TODO - add optional write out of the data stored in passingCombinations in the decide function.
  
private:
 
  HLT::Identifier m_decisionId; 
  std::vector<HLT::Identifier> m_legDecisionIds; 
  std::vector<int> m_legMultiplicities; 
 
};
 
#endif // DECISIONHANDLING_COMBOHYPOTOOLBASE_H