CompetingMuonClustersOnTrack.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/

// CompetingRpcClustersOnTrack.h, (c) ATLAS Detector software
 
#ifndef COMPETINGRPCCLUSTERSONTRACK_H
#define COMPETINGRPCCLUSTERSONTRACK_H
 
// Trk
#include "TrkCompetingRIOsOnTrack/CompetingRIOsOnTrack.h"
#include "TrkRIO_OnTrack/RIO_OnTrack.h"
#include "TrkSurfaces/SurfaceHolders.h"
// Identifier
#include "Identifier/Identifier.h"
#include "Identifier/IdentifierHash.h"
// Muon
#include "MuonRIO_OnTrack/MuonClusterOnTrack.h"
 
#include "CxxUtils/CachedUniquePtr.h"
 
#include <ostream>
#include <utility>
 
class MsgStream;
 
namespace Trk {
class PrepRawData;
class TrkDetElementBase;
}
 
namespace Muon {

 
class CompetingMuonClustersOnTrack
  : public Trk::CompetingRIOsOnTrack
  , public Trk::SurfacePtrHolderDetEl
{
 
public:
  friend class CompetingMuonClustersOnTrackTool;

  CompetingMuonClustersOnTrack() = default;
  CompetingMuonClustersOnTrack(const CompetingMuonClustersOnTrack& compROT);
  CompetingMuonClustersOnTrack(CompetingMuonClustersOnTrack&& compROT) = default;
  CompetingMuonClustersOnTrack& operator=(const CompetingMuonClustersOnTrack& compROT) noexcept;
  CompetingMuonClustersOnTrack& operator=(CompetingMuonClustersOnTrack&& compROT) noexcept = default;

  CompetingMuonClustersOnTrack(
    std::vector<std::unique_ptr<const MuonClusterOnTrack>>&& childrots,
    std::vector<AssignmentProb>&& assgnProb);

  CompetingMuonClustersOnTrack(
    Trk::LocalParameters&& locPars,
    Amg::MatrixX&& error,
    const Trk::Surface* assSurf,
    std::vector<std::unique_ptr<const MuonClusterOnTrack>>&& childrots,
    std::vector<AssignmentProb>&& assgnProb);

  virtual ~CompetingMuonClustersOnTrack() = default;

  CompetingMuonClustersOnTrack* clone() const;

  const Trk::Surface& associatedSurface() const;
  const Trk::Surface* associatedSurfaceRaw() const;

  const Amg::Vector3D& globalPosition() const;

  unsigned int numberOfContainedROTs() const;

  const std::vector<std::unique_ptr<const MuonClusterOnTrack>>& containedROTs() const;

  const MuonClusterOnTrack& rioOnTrack(unsigned int) const;

  MsgStream& dump(MsgStream& out) const;
  std::ostream& dump(std::ostream& out) const;
 
private:
  CxxUtils::CachedUniquePtr<const Amg::Vector3D> m_globalPosition{};

  std::vector<std::unique_ptr<const MuonClusterOnTrack>> m_containedChildRots{};

  bool ROTsHaveCommonSurface(
    const bool withNonVanishingAssignProb = true) const;
};
 
inline CompetingMuonClustersOnTrack*
CompetingMuonClustersOnTrack::clone() const
{
  return new CompetingMuonClustersOnTrack(*this);
}
 
inline const Trk::Surface&
CompetingMuonClustersOnTrack::associatedSurface() const
{
  if (m_associatedSurface) {
    return *m_associatedSurface;
  }
  return m_containedChildRots.front()->associatedSurface();
}
 
inline const Trk::Surface*
CompetingMuonClustersOnTrack::associatedSurfaceRaw() const
{
  return m_associatedSurface;
}
 
inline unsigned int
CompetingMuonClustersOnTrack::numberOfContainedROTs() const
{
  return m_containedChildRots.size();
}
 
inline const std::vector<std::unique_ptr<const MuonClusterOnTrack>>&
CompetingMuonClustersOnTrack::containedROTs() const{
  return m_containedChildRots;
}
 
inline const MuonClusterOnTrack&
CompetingMuonClustersOnTrack::rioOnTrack(unsigned int indx) const
{
  return *m_containedChildRots.at(indx).get();
}
 
inline const Amg::Vector3D&
CompetingMuonClustersOnTrack::globalPosition() const
{
  if (not m_globalPosition) {
    m_globalPosition.set(std::make_unique<const Amg::Vector3D>(
      associatedSurface().localToGlobal(localParameters())));
  }
  return (*m_globalPosition);
}
}
 
#endif // COMPETINGRPCCLUSTERSONTRACK_H