IFastRecoVisualizationTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
#ifndef MUONRECTOOLINTERFACESR4_IPATTERNVISUALIZATIONTOOL_H
#define MUONRECTOOLINTERFACESR4_IPATTERNVISUALIZATIONTOOL_H
 
#include <GaudiKernel/IAlgTool.h>
 
#include <MuonFastRecoEvent/GlobalPattern.h>
#include "MuonSpacePoint/SpacePointContainer.h"
#include "xAODMeasurementBase/UncalibratedMeasurement.h"
#include <xAODMuon/MuonSegment.h>
#include <TObject.h>
 
#include <memory>
 
#include "Acts/Utilities/CloneablePtr.hpp"
class EventContext;
class TObject;
 
namespace MuonR4 {
    class SpacePointBucket;
    class GlobalPattern;
    class SpacePoint;
}
 
namespace MuonValR4{
 
    class IFastRecoVisualizationTool : virtual public IAlgTool {
        public:
            DeclareInterfaceID(IFastRecoVisualizationTool, 1, 0);
            
            using PrimitivePtr = std::unique_ptr<TObject>;
            using PrimitiveVec = std::vector<PrimitivePtr>;
            using GlobalPatternPtr = Acts::CloneablePtr<MuonR4::GlobalPattern>;
 
            virtual ~IFastRecoVisualizationTool() = default;
            struct PatternHitVisualInfo {
                enum class PatternStatus : std::uint32_t {
                    eSuccessful,
                    eOverlap,
                    eFailed
                };
                enum class HitStatus : std::uint32_t {
                    eKept,
                    eReplaced,
                    eDiscarded
                };

                explicit PatternHitVisualInfo(const MuonR4::SpacePoint* seed, double thetaMin, double thetaMax) : 
                    seed{seed}, thetaSearchMin{thetaMin}, thetaSearchMax{thetaMax} {}                

                const MuonR4::SpacePoint* seed{nullptr};
                std::vector<const MuonR4::SpacePointBucket*> parentBuckets{};
                std::unordered_map<const MuonR4::SpacePoint*, std::pair<double, double>> hitLineInfo{};
                std::vector<const MuonR4::SpacePoint*> replacedHits{};
                std::vector<const MuonR4::SpacePoint*> discardedHits{};
                double thetaSearchMin{};
                double thetaSearchMax{};
                GlobalPatternPtr patternCopy{nullptr};
                PatternStatus status{PatternStatus::eOverlap};
            };
            using PatternHitVisualInfoVec = std::vector<PatternHitVisualInfo>;
            virtual void plotPatternBuckets(const EventContext& ctx,
                                            const std::string& extraLabel,
                                            PatternHitVisualInfoVec&& patternVisual) const = 0;
            virtual void plotPatternBuckets(const EventContext& ctx,
                                           const std::string& extraLabel,
                                           PatternHitVisualInfoVec&& patternVisual,
                                           PrimitiveVec&& extraPaints) const = 0;
            virtual void plotPatternBuckets(const EventContext& ctx,
                                            const std::string& extraLabel,
                                            PatternHitVisualInfo&& patternVisual) const = 0;
            virtual void plotPatternBuckets(const EventContext& ctx,
                                            const std::string& extraLabel,
                                            PatternHitVisualInfo&& patternVisual,
                                            PrimitiveVec&& extraPaints) const = 0;

            virtual bool isLabeled(const MuonR4::SpacePoint& hit) const = 0;
            virtual bool isLabeled(const xAOD::UncalibratedMeasurement& hit) const = 0;
 
            using LabeledSegmentSet = std::unordered_set<const xAOD::MuonSegment*>;
            virtual LabeledSegmentSet getLabeledSegments(const std::vector<const MuonR4::SpacePoint*>& hits) const = 0;
            virtual LabeledSegmentSet getLabeledSegments(const std::vector<const xAOD::UncalibratedMeasurement*>& hits) const = 0;
 
    };
}
#endif