DecisionAccess.h

Go to the documentation of this file.

// -*- c++ -*-
 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGGER_DECISION_TOOL_DecisionAccess_H
#define TRIGGER_DECISION_TOOL_DecisionAccess_H
 
/**********************************************************************************
 * @Project: TrigDecisionTool
 * @Package: TrigDecisionTool
 * @class  : DecisionAccess
 *
 * @brief access to information about the trigger decision
 *
 * @author Michael Begel   <michael.begel@cern.ch>  - Brookhaven National Laboratory
 * @author Nicolas Berger  <Nicolas.Berger@cern.ch> - LAPP Annecy
 * @author Tomasz Bold     <Tomasz.Bold@cern.ch>    - UC Irvine - AGH Krakow
 *
 ***********************************************************************************/
 
 
#include "TrigNavStructure/TriggerElement.h"
#include "TrigDecisionTool/Logger.h"
#include "TrigDecisionTool/Conditions.h"
#include "TrigDecisionTool/Combination.h"
#include "TrigDecisionTool/Feature.h"
#include "TrigDecisionTool/FeatureContainer.h"
#include "TrigDecisionTool/ChainGroup.h"
 
#include "TrigAnalysisHelpers/FeatureRequestDescriptor.h"
#include "TrigSteeringEvent/TrigRoiDescriptorCollection.h"
#include "TrigCompositeUtils/TrigCompositeUtils.h"
 
#include "AsgDataHandles/ReadHandle.h"
#include <string>
#include <sstream>
#include <vector>
 
namespace HLT {
  class Chain;
}
namespace TrigConf {
  class HLTChain;
  class HLTTriggerElement;
}
 
class LVL1_ROI;
 
namespace Trig {
 
  class CacheGlobalMemory;
   
  class DecisionAccess : public virtual Logger {
  public:      
 
    DecisionAccess();
    virtual ~DecisionAccess();

    bool isPassed(const Trig::ChainGroup* chaingroup,
                  unsigned int condition = TrigDefs::Physics) const; 
    bool isPassed(std::string_view chain,
                  unsigned int condition) const;
 
    bool isPassed(std::string_view chain) const;

    std::vector<bool> isPassedForEach(const Trig::ChainGroup* chainGroup,
                                      unsigned int condition = TrigDefs::Physics) const;

    std::vector<bool> isPassedForEach(const std::string& chain,
                                      unsigned int condition = TrigDefs::Physics) const;

    unsigned int isPassedBits(const Trig::ChainGroup* chaingroup) const;
    unsigned int isPassedBits(const std::string& chain) const;

    std::vector<unsigned int> isPassedBitsForEach(const Trig::ChainGroup* chaingroup) const;
    std::vector<unsigned int> isPassedBitsForEach(const std::string& chain) const;
 

    char getBGCode() const;
    
    FeatureContainer features(const Trig::ChainGroup* group, 
                              unsigned int condition = TrigDefs::Physics) const;

    FeatureContainer features(const std::string& chainName = "EF_.*", 
                              unsigned int condition = TrigDefs::Physics) const;


    template<class CONTAINER>
    std::vector< TrigCompositeUtils::LinkInfo<CONTAINER> > 
    features(const Trig::FeatureRequestDescriptor& featureRequest) const;

    template<class CONTAINER>
    std::vector< TrigCompositeUtils::LinkInfo<CONTAINER> > 
    features(const Trig::ChainGroup* group,
             const unsigned int condition = TrigDefs::Physics,
             std::string_view containerSGKey = "",
             const unsigned int featureCollectionMode = TrigDefs::lastFeatureOfType,
             const std::string& navElementLinkKey = TrigCompositeUtils::featureString(),
             const int          restrictToLegIndex = -1) const;

    template<class CONTAINER>
    std::vector< TrigCompositeUtils::LinkInfo<CONTAINER> >
    features(const std::string& chainGroupName,
             const unsigned int condition = TrigDefs::Physics,
             std::string_view containerSGKey = "",
             const unsigned int featureCollectionMode = TrigDefs::lastFeatureOfType,
             const std::string& navElementLinkKey = TrigCompositeUtils::featureString(),
             const int          restrictToLegIndex = -1) const;

    template<class CONTAINER, class FEATURE_CONTAINER>
    std::pair< typename CONTAINER::const_iterator, typename CONTAINER::const_iterator > 
    associateToEventView(typename SG::ReadHandle<CONTAINER>& inViewContainer,
                         const TrigCompositeUtils::LinkInfo<FEATURE_CONTAINER> linkInfo,
                         const std::string& roiName = TrigCompositeUtils::roiString()) const;

    template<class CONTAINER>
    std::pair< typename CONTAINER::const_iterator, typename CONTAINER::const_iterator > 
    associateToEventView(typename SG::ReadHandle<CONTAINER>& inViewContainer,
                         const TrigCompositeUtils::Decision* decisionObject,
                         const std::string& roiName = TrigCompositeUtils::roiString()) const;

    template<class CONTAINER>
    std::pair< typename CONTAINER::const_iterator, typename CONTAINER::const_iterator > 
    associateToEventView(typename SG::ReadHandle<CONTAINER>& inViewContainer,
                         const ElementLink<TrigRoiDescriptorCollection>& matchROI) const;

    template<class CONTAINER>
    std::pair< typename CONTAINER::const_iterator, typename CONTAINER::const_iterator > 
    associateToEventView(typename SG::ReadHandle<CONTAINER>& inViewContainer,
                         const uint32_t matchIndex,
                         const uint32_t matchKey = 0,
                         const bool isFullscan = false) const;


    template<class T> 
    Feature<T> ancestor(const HLT::TriggerElement* te, std::string label = "") const;

    template<class T>
    std::vector<Trig::Feature<T> > ancestors(const HLT::TriggerElement* te, std::string label = "", unsigned int condition=TrigDefs::Physics, const std::string& teName = "") const;
 
  protected:
 
    friend class Combination;    
 
 
  private:
 
    virtual Trig::CacheGlobalMemory* cgm() = 0;
    virtual const Trig::CacheGlobalMemory* cgm() const = 0;
 
    //    template<class T> 
    //    const T* getL1RoI(const std::vector<T>& rois, unsigned int id) const;
 
 
    //unsigned int initRoIWord(const HLT::TriggerElement* te) const;
 
  };
} // End of namespace
 
#include "DecisionAccess.icc"
 
#endif