Trk::CompetingRIOsOnTrack Class Reference

Base class for all CompetingRIOsOnTack implementations, extends the common MeasurementBase. More...

#include <CompetingRIOsOnTrack.h>

Inheritance diagram for Trk::CompetingRIOsOnTrack:

Collaboration diagram for Trk::CompetingRIOsOnTrack:

Public Types
typedef double	AssignmentProb
	Type def of Assignment probability: probability for a certain RIO_OnTrack to be assigned to the track.

Public Member Functions
	CompetingRIOsOnTrack ()
	Default Constructor for POOL.
	CompetingRIOsOnTrack (std::vector< AssignmentProb > &&assgnProb)
	Constructor with parameters.
	CompetingRIOsOnTrack (const CompetingRIOsOnTrack &compROT)=default
	Copy Constructor.
	CompetingRIOsOnTrack (CompetingRIOsOnTrack &&compROT) noexcept=default
CompetingRIOsOnTrack &	operator= (const CompetingRIOsOnTrack &compROT)=default
	Assignment operator.
CompetingRIOsOnTrack &	operator= (CompetingRIOsOnTrack &&compROT) noexcept=default
virtual	~CompetingRIOsOnTrack ()=default
	Destructor.
virtual CompetingRIOsOnTrack *	clone () const override=0
	Pseudo-constructor: needed to avoid excessive RTTI.
std::unique_ptr< CompetingRIOsOnTrack >	uniqueClone () const
	NVI Clone.
virtual unsigned int	numberOfContainedROTs () const =0
	Number of RIO_OnTracks to be contained by this CompetingRIOsOnTrack.
unsigned int	indexOfMaxAssignProb () const
	Index of the ROT with the highest assignment probability.
virtual const RIO_OnTrack &	rioOnTrack (unsigned int) const =0
	returns the RIO_OnTrack (also known as ROT) objects depending on the integer.
AssignmentProb	assignmentProbability (unsigned int indx) const
	returns the AssignmentProbability depending on the integer.
virtual void	setLocalParametersAndErrorMatrix ()
	recalculate the LocalParameters and ErrorMatrix
virtual bool	type (MeasurementBaseType::Type type) const override final
	Extended method checking the type.
const LocalParameters &	localParameters () const
	Interface method to get the LocalParameters.
const Amg::MatrixX &	localCovariance () const
	Interface method to get the localError.
virtual const Surface &	associatedSurface () const =0
	Interface method to get the associated Surface.
virtual const Amg::Vector3D &	globalPosition () const =0
	Interface method to get the global Position.

Protected Member Functions
virtual bool	ROTsHaveCommonSurface (const bool withNonVanishingAssignProb=true) const =0
	query if all the contained ROTs have a common associated surface.
virtual MsgStream &	dump (MsgStream &out) const override
	returns the some information about the base class members (avoid code duplication)
virtual std::ostream &	dump (std::ostream &out) const override
	returns the some information about the base class members (avoid code duplication)

Protected Attributes
std::vector< AssignmentProb >	m_assignProb
	assignment probabilities of the ROTs
LocalParameters	m_localParams
Amg::MatrixX	m_localCovariance

Friends
class	::CompetingRIOsOnTrackCnv_p1

Detailed Description

Base class for all CompetingRIOsOnTack implementations, extends the common MeasurementBase.

This class is used e.g. by the Deterministic Annealing Filter to handle several RIO_OnTracks in one "effective detector layer" (might be more than one DetectorElement), which compete against each other in being assigned to a track. localParameters() and localErrorMatrix() should return the mean values according to the weights (assignment probabilities).

Effective LocalParameters, an ErrorMatrix and a number of competing ROTs with their assignment probabilities are the commonalities of all CompetingRIOsOnTrack.

The derived classes can overwrite the base class definitions of Trk::RIO_OnTrack and Trk::Surface with derived classes for internal use and to avoid extensive RTTI.

The Surface is chosen not to be a private member of the base class, such that dedicated Segments can save specific Surface types and overwrite the return type by a child class to avoid extensive RTTI.

Access to any information of the contained ROTs, such as the underlying Trk::PrepRawData, the pointer to the Trk::DetectorElementBase such as identifiers have to be retrieved from the ROT itself.

Author

Sebas.nosp@m.tian.nosp@m..Flei.nosp@m.schm.nosp@m.ann@c.nosp@m.ern..nosp@m.ch

Chistos Anastopoulos AthenaMT

Definition at line 63 of file CompetingRIOsOnTrack.h.

Member Typedef Documentation

AssignmentProb

typedef double Trk::CompetingRIOsOnTrack::AssignmentProb

Type def of Assignment probability: probability for a certain RIO_OnTrack to be assigned to the track.

Definition at line 69 of file CompetingRIOsOnTrack.h.

Constructor & Destructor Documentation

CompetingRIOsOnTrack() [1/4]

Trk::CompetingRIOsOnTrack::CompetingRIOsOnTrack

(

)

Default Constructor for POOL.

Definition at line 18 of file CompetingRIOsOnTrack.cxx.

  : Trk::MeasurementBase()
  , m_assignProb()
{
}

CompetingRIOsOnTrack() [2/4]

Trk::CompetingRIOsOnTrack::CompetingRIOsOnTrack

(

std::vector< AssignmentProb > &&

assgnProb

)

Constructor with parameters.

Definition at line 24 of file CompetingRIOsOnTrack.cxx.

  : Trk::MeasurementBase()
  , m_assignProb(std::move(assgnProb))
{
}

CompetingRIOsOnTrack() [3/4]

Trk::CompetingRIOsOnTrack::CompetingRIOsOnTrack ( const CompetingRIOsOnTrack & compROT )

default

Copy Constructor.

CompetingRIOsOnTrack() [4/4]

Trk::CompetingRIOsOnTrack::CompetingRIOsOnTrack ( CompetingRIOsOnTrack && compROT )

defaultnoexcept

~CompetingRIOsOnTrack()

virtual Trk::CompetingRIOsOnTrack::~CompetingRIOsOnTrack ( )

virtualdefault

Destructor.

Member Function Documentation

assignmentProbability()

CompetingRIOsOnTrack::AssignmentProb Trk::CompetingRIOsOnTrack::assignmentProbability ( unsigned int indx ) const

inline

returns the AssignmentProbability depending on the integer.

• extends MeasurementBase

Definition at line 139 of file CompetingRIOsOnTrack.h.

{
  assert(indx < numberOfContainedROTs());
  if (indx < numberOfContainedROTs()) {
    return m_assignProb[indx];
  }
  return 0; // could consider throwing an exception here - EJWM
}

associatedSurface()

virtual const Surface & Trk::MeasurementBase::associatedSurface ( ) const

pure virtualinherited

Interface method to get the associated Surface.

Implemented in CscClusterOnTrack, HGTD_ClusterOnTrack, InDet::CompetingPixelClustersOnTrack, InDet::CompetingSCT_ClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, InDet::PixelClusterOnTrack, InDet::SCT_ClusterOnTrack, InDet::TRT_DriftCircleOnTrack, MdtDriftCircleOnTrack, Muon::CompetingMuonClustersOnTrack, Muon::CscClusterOnTrack, Muon::MdtDriftCircleOnTrack, Muon::MMClusterOnTrack, Muon::MuonSegment, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::TgcClusterOnTrack, MuonSegment, RIO_OnTrack, Trk::CaloCluster_OnTrack, Trk::PseudoMeasurementOnTrack, Trk::RIO_OnTrack, Trk::SpacePoint, Trk::TrackSegment, and Trk::VertexOnTrack.

clone()

virtual CompetingRIOsOnTrack * Trk::CompetingRIOsOnTrack::clone ( ) const

overridepure virtual

Pseudo-constructor: needed to avoid excessive RTTI.

Implements Trk::MeasurementBase.

Implemented in InDet::CompetingPixelClustersOnTrack, InDet::CompetingSCT_ClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, and Muon::CompetingMuonClustersOnTrack.

dump() [1/2]

MsgStream & Trk::CompetingRIOsOnTrack::dump ( MsgStream & out ) const

overrideprotectedvirtual

returns the some information about the base class members (avoid code duplication)

Implements Trk::MeasurementBase.

Reimplemented in InDet::CompetingPixelClustersOnTrack, InDet::CompetingSCT_ClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, and Muon::CompetingMuonClustersOnTrack.

Definition at line 114 of file CompetingRIOsOnTrack.cxx.

{
  out << "  - effective pars   locX : ";
  if (m_localParams.contains(Trk::locX)) {
    out << (m_localParams)[Trk::locX];
    if (m_localParams.contains(Trk::locY)) {
      out << " and " << (m_localParams)[Trk::locY];
    }
  } else {
    out << "ill-defined! They are " << m_localParams;
  }
  if (m_localParams.contains(Trk::locY)) {
    out << std::endl;
  }
  unsigned int indexOfMaxProb = indexOfMaxAssignProb();
  out << "  - Contains: |ROT# identifier    locX      dLocX       locY       dlocY     "
         "ass.Prob   |";
  for (unsigned int i = 0; i < this->numberOfContainedROTs(); ++i) {
    out << std::endl
        << "              | " << i << "  " << this->rioOnTrack(i).identify() << "  ";
    if (this->rioOnTrack(i).localParameters().contains(Trk::locX)) {
      out << std::format("{:>10.6f}  {}",
                         this->rioOnTrack(i).localParameters()[Trk::locX],
                         1 / this->rioOnTrack(i).localCovariance()(Trk::locX, Trk::locX));
    } else {
      out << "                         ";
    }
    if (this->rioOnTrack(i).localParameters().contains(Trk::locY)) {
      out << std::format("  {:>10.6f}  {}  ",
                         this->rioOnTrack(i).localParameters()[Trk::locY],
                         1 / this->rioOnTrack(i).localCovariance()(Trk::locY, Trk::locY));
    } else {
      out << "                         ";
    }
    out << "  " << m_assignProb.at(i) << (indexOfMaxProb == i ? " **|" : "   |");
  }
  return out;
}

dump() [2/2]

std::ostream & Trk::CompetingRIOsOnTrack::dump ( std::ostream & out ) const

overrideprotectedvirtual

returns the some information about the base class members (avoid code duplication)

Implements Trk::MeasurementBase.

Reimplemented in InDet::CompetingPixelClustersOnTrack, InDet::CompetingSCT_ClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, and Muon::CompetingMuonClustersOnTrack.

Definition at line 156 of file CompetingRIOsOnTrack.cxx.

{
  out << "  - effective pars   locX : ";
  if (m_localParams.contains(Trk::locX)) {
    out << (m_localParams)[Trk::locX];
    if (m_localParams.contains(Trk::locY)) {
      out << " and " << (m_localParams)[Trk::locY];
    }
  } else {
    out << "ill-defined! They are " << m_localParams;
  }
  if (m_localParams.contains(Trk::locY)) {
    out << std::endl;
  }
 
  unsigned int indexOfMaxProb = indexOfMaxAssignProb();
  out << "  - Contains: |ROT# identifier    locX      dLocX       locY       dlocY     "
         "ass.Prob   |";
  for (unsigned int i = 0; i < this->numberOfContainedROTs(); ++i) {
    out << std::endl
        << "              | " << i << "  " << this->rioOnTrack(i).identify() << "  ";
    if (this->rioOnTrack(i).localParameters().contains(Trk::locX)) {
      out << std::format("{:>10.6f}  {}",
                         this->rioOnTrack(i).localParameters()[Trk::locX],
                         1 / this->rioOnTrack(i).localCovariance()(Trk::locX, Trk::locX));
    } else {
      out << "                         ";
    }
    if (this->rioOnTrack(i).localParameters().contains(Trk::locY)) {
      out << std::format("  {:>10.6f}  {}  ",
                         this->rioOnTrack(i).localParameters()[Trk::locY],
                         1 / this->rioOnTrack(i).localCovariance()(Trk::locY, Trk::locY));
    } else {
      out << "                         ";
    }
    out << "  " << m_assignProb.at(i) << (indexOfMaxProb == i ? " **|" : "   |");
  }
  return out;
}

globalPosition()

virtual const Amg::Vector3D & Trk::MeasurementBase::globalPosition ( ) const

pure virtualinherited

Interface method to get the global Position.

Implemented in HGTD_ClusterOnTrack, InDet::CompetingPixelClustersOnTrack, InDet::CompetingSCT_ClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, InDet::SiClusterOnTrack, InDet::TRT_DriftCircleOnTrack, MdtDriftCircleOnTrack, Muon::CompetingMuonClustersOnTrack, Muon::MdtDriftCircleOnTrack, Muon::MuonClusterOnTrack, Muon::MuonSegment, MuonClusterOnTrack, MuonSegment, RIO_OnTrack, Trk::CaloCluster_OnTrack, Trk::PseudoMeasurementOnTrack, Trk::RIO_OnTrack, Trk::SpacePoint, Trk::TrackSegment, and Trk::VertexOnTrack.

indexOfMaxAssignProb()

unsigned int Trk::CompetingRIOsOnTrack::indexOfMaxAssignProb

(

)

const

Index of the ROT with the highest assignment probability.

• extends MeasurementBase

Definition at line 100 of file CompetingRIOsOnTrack.cxx.

{
  unsigned int index = 0;
  double maxAssgnProb = 0;
  for (unsigned int i = 0; i < numberOfContainedROTs(); i++) {
    if (m_assignProb[i] >= maxAssgnProb) {
      index = i;
      maxAssgnProb = m_assignProb[i];
    }
  }
  return index;
}

localCovariance()

const Amg::MatrixX & Trk::MeasurementBase::localCovariance ( ) const

inlineinherited

Interface method to get the localError.

Definition at line 138 of file MeasurementBase.h.

{
  return m_localCovariance;
}

localParameters()

const Trk::LocalParameters & Trk::MeasurementBase::localParameters ( ) const

inlineinherited

Interface method to get the LocalParameters.

Definition at line 132 of file MeasurementBase.h.

{
  return m_localParams;
}

numberOfContainedROTs()

virtual unsigned int Trk::CompetingRIOsOnTrack::numberOfContainedROTs ( ) const

pure virtual

Number of RIO_OnTracks to be contained by this CompetingRIOsOnTrack.

• extends MeasurementBase

Implemented in InDet::CompetingPixelClustersOnTrack, InDet::CompetingSCT_ClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, and Muon::CompetingMuonClustersOnTrack.

operator=() [1/2]

CompetingRIOsOnTrack & Trk::CompetingRIOsOnTrack::operator= ( CompetingRIOsOnTrack && compROT )

defaultnoexcept

operator=() [2/2]

CompetingRIOsOnTrack & Trk::CompetingRIOsOnTrack::operator= ( const CompetingRIOsOnTrack & compROT )

default

Assignment operator.

rioOnTrack()

virtual const RIO_OnTrack & Trk::CompetingRIOsOnTrack::rioOnTrack ( unsigned int ) const

pure virtual

returns the RIO_OnTrack (also known as ROT) objects depending on the integer.

• extends MeasurementBase

Implemented in InDet::CompetingPixelClustersOnTrack, InDet::CompetingSCT_ClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, and Muon::CompetingMuonClustersOnTrack.

ROTsHaveCommonSurface()

virtual bool Trk::CompetingRIOsOnTrack::ROTsHaveCommonSurface ( const bool withNonVanishingAssignProb = true ) const

protectedpure virtual

query if all the contained ROTs have a common associated surface.

If withNonVanishingAssignProb==true just the ROTs with non-vanishing assignment probabilities are checked.

Implemented in InDet::CompetingPixelClustersOnTrack, InDet::CompetingSCT_ClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, and Muon::CompetingMuonClustersOnTrack.

setLocalParametersAndErrorMatrix()

void Trk::CompetingRIOsOnTrack::setLocalParametersAndErrorMatrix ( )

virtual

recalculate the LocalParameters and ErrorMatrix

Reimplemented in InDet::CompetingSCT_ClustersOnTrack, and InDet::CompetingTRT_DriftCirclesOnTrack.

Definition at line 33 of file CompetingRIOsOnTrack.cxx.

{
 
  if (ROTsHaveCommonSurface()) {
    // std::cout << "CompROT - weight matrices: " << std::endl;
    // std::cout << "CompROT - [1] " << rioOnTrack(0).localCovariance() << std::endl;
    Amg::MatrixX meanWeightMatrix =
      assignmentProbability(0) * rioOnTrack(0).localCovariance().inverse();
    for (unsigned int i = 1; i < numberOfContainedROTs(); i++) {
      meanWeightMatrix += assignmentProbability(i) * rioOnTrack(i).localCovariance().inverse();
      // std::cout << "CompROT - ["<< i << "] " << rioOnTrack(i).localCovariance() <<
      // std::endl;
    }
    // limit weight values against values too close to 0, otherwise inversion will fail!
    if (meanWeightMatrix.trace() <= 1.0e-15) {
      meanWeightMatrix = Amg::MatrixX(rioOnTrack(0).localCovariance().rows(),
                                      rioOnTrack(0).localCovariance().cols());
      meanWeightMatrix.setZero();
      for (int i = 0; i < meanWeightMatrix.cols(); ++i) {
        meanWeightMatrix(i, i) = 1.0e-10;
      }
    }
    // std::cout << "CompROT - mean weight: " << meanWeightMatrix << std::endl;
    m_localCovariance = meanWeightMatrix.inverse();
    // std::cout << "CompROT - mean covariance: " << localCovariance() << std::endl;
 
    if (numberOfContainedROTs() == 1) {
      m_localParams = rioOnTrack(0).localParameters();
    } else {
      Amg::MatrixX weight = rioOnTrack(0).localCovariance().inverse();
      Amg::VectorX meanParams =
        assignmentProbability(0) * weight * rioOnTrack(0).localParameters();
      for (unsigned int i = 1; i < numberOfContainedROTs(); i++) {
        weight = rioOnTrack(i).localCovariance().inverse();
        meanParams =
          meanParams + assignmentProbability(i) * weight * rioOnTrack(i).localParameters();
      }
      // std::cout << "CompROT - sum params: " << meanParams << std::endl;
      meanParams = localCovariance() * meanParams;
      // std::cout << "CompROT - mean params: " << meanParams << std::endl;
      int paramKey = rioOnTrack(0).localParameters().parameterKey();
      if (paramKey == 1) {
        Trk::DefinedParameter Par1(meanParams[Trk::loc1], Trk::loc1);
        m_localParams = Trk::LocalParameters(Par1);
      } else if (paramKey == 3) {
        Trk::DefinedParameter Par1(meanParams[Trk::loc1], Trk::loc1);
        Trk::DefinedParameter Par2(meanParams[Trk::loc2], Trk::loc2);
        m_localParams = Trk::LocalParameters(Par1, Par2);
      } else {
        std::cout << "Trk::CompetingRIOsOnTrack: can not handle parameter key " << paramKey
                  << std::endl;
      }
    }
  } else {
    // --------------------------------------------------
    // Warning: effective localParams cannot be calculated when ROTs don't lie on the
    //          associated surface without detector specific knowledge.
    // --------------------------------------------------
    // return 0;
    std::cout
      << "Trk::CompetingRIOsOnTrack: can not handle ROTs in different surfaces without "
         "detector specific knowledge "
      << std::endl;
  }
}

type()

virtual bool Trk::CompetingRIOsOnTrack::type ( MeasurementBaseType::Type type ) const

inlinefinaloverridevirtual

Extended method checking the type.

Implements Trk::MeasurementBase.

Definition at line 116 of file CompetingRIOsOnTrack.h.

  {
    return (type == MeasurementBaseType::CompetingRIOsOnTrack);
  }

uniqueClone()

std::unique_ptr< CompetingRIOsOnTrack > Trk::CompetingRIOsOnTrack::uniqueClone ( ) const

inline

NVI Clone.

Definition at line 88 of file CompetingRIOsOnTrack.h.

  {
    return std::unique_ptr<CompetingRIOsOnTrack>(clone());
  }

Friends And Related Symbol Documentation

::CompetingRIOsOnTrackCnv_p1

friend class ::CompetingRIOsOnTrackCnv_p1

friend

Definition at line 122 of file CompetingRIOsOnTrack.h.

Member Data Documentation

m_assignProb

std::vector<AssignmentProb> Trk::CompetingRIOsOnTrack::m_assignProb

protected

assignment probabilities of the ROTs

Definition at line 125 of file CompetingRIOsOnTrack.h.

m_localCovariance

Amg::MatrixX Trk::MeasurementBase::m_localCovariance

protectedinherited

Definition at line 112 of file MeasurementBase.h.

m_localParams

LocalParameters Trk::MeasurementBase::m_localParams

protectedinherited

Definition at line 111 of file MeasurementBase.h.

---

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

• CompetingRIOsOnTrack.h
• CompetingRIOsOnTrack.cxx