InDet::CompetingSCT_ClustersOnTrack Class Reference

Class for competing SCT_Clusters, it extends the Trk::CompetingRIOsOnTrack base class. More...

#include <CompetingSCT_ClustersOnTrack.h>

Inheritance diagram for InDet::CompetingSCT_ClustersOnTrack:

Collaboration diagram for InDet::CompetingSCT_ClustersOnTrack:

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
	CompetingSCT_ClustersOnTrack ()
	Default Constructor for POOL.
	CompetingSCT_ClustersOnTrack (const CompetingSCT_ClustersOnTrack &compROT)
	Copy Constructor.
CompetingSCT_ClustersOnTrack &	operator= (const CompetingSCT_ClustersOnTrack &compROT)
	Assignment operator.
CompetingSCT_ClustersOnTrack &	operator= (CompetingSCT_ClustersOnTrack &&compROT) noexcept
	Default move assignment operator.
	CompetingSCT_ClustersOnTrack (std::vector< const InDet::SCT_ClusterOnTrack * > &&childrots, std::vector< AssignmentProb > &&assgnProb)
	Constructor with all parameters: PLEASE do not use directly, but call InDet::CompetingSCT_ClustersOnTrackTool, otherwise inconsistency of the data will be very probable.
virtual	~CompetingSCT_ClustersOnTrack ()
	Destructor.
CompetingSCT_ClustersOnTrack *	clone () const
	needed to avoid excessive RTTI
const Trk::Surface &	associatedSurface () const
	returns the surface for the local to global transformation .
const Amg::Vector3D &	globalPosition () const
	Interface method to get the global Position.
unsigned int	numberOfContainedROTs () const
	Number of RIO_OnTracks to be contained by this CompetingRIOsOnTrack.
const std::vector< const InDet::SCT_ClusterOnTrack * > &	containedROTs () const
	returns the vector of SCT_ClusterOnTrack objects .
const InDet::SCT_ClusterOnTrack &	rioOnTrack (unsigned int) const
	returns the RIO_OnTrack (also known as ROT) objects depending on the integer
MsgStream &	dump (MsgStream &out) const
	returns some information about this MeasurementBase/CompetingSCT_ClustersOnTrack.
std::ostream &	dump (std::ostream &out) const
	returns some information about this MeasurementBase/CompetingSCT_ClustersOnTrack.
virtual void	setLocalParametersAndErrorMatrix ()
	recalculate the LocalParameters and ErrorMatrix
std::unique_ptr< CompetingRIOsOnTrack >	uniqueClone () const
	NVI Clone.
unsigned int	indexOfMaxAssignProb () const
	Index of the ROT with the highest assignment probability.
AssignmentProb	assignmentProbability (unsigned int indx) const
	returns the AssignmentProbability depending on the integer.
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.

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

Private Member Functions
void	clearChildRotVector ()
	private method to clear the Trk::RIO_OnTrack vector
bool	ROTsHaveCommonSurface (const bool withNonVanishingAssignProb=true) const
	Have all the contained ROTs a common associated surface?

Private Attributes
CxxUtils::CachedUniquePtr< const Amg::Vector3D >	m_globalPosition
	The global position.
std::vector< const InDet::SCT_ClusterOnTrack * >	m_containedChildRots
	The vector of contained InDet::SCT_ClusterOnTrack objects.

Friends
class	CompetingSCT_ClustersOnTrackTool
	InDet::CompetingSCT_ClustersOnTrackTool is a friend to allow for updates of the assignment probabilities.

Detailed Description

Class for competing SCT_Clusters, it extends the Trk::CompetingRIOsOnTrack base class.

This class is used by the Deterministic Annealing Filter to handle several SCT_ClusterOnTrack in one detector element, which compete against each other in being assigned to a track. In contrast to the InDet::CompetingTRT_DriftCirclesOnTrack all competing measurements of the InDet::CompetingSCT_ClustersOnTrack have to be on the same detector element (i.e. have a common associated surface). localParameters() and localErrorMatrix() return the mean values according to the weights (assignment probabilities).

Author

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

Definition at line 44 of file CompetingSCT_ClustersOnTrack.h.

Member Typedef Documentation

AssignmentProb

typedef double Trk::CompetingRIOsOnTrack::AssignmentProb

inherited

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

CompetingSCT_ClustersOnTrack() [1/3]

InDet::CompetingSCT_ClustersOnTrack::CompetingSCT_ClustersOnTrack

(

)

Default Constructor for POOL.

Definition at line 19 of file CompetingSCT_ClustersOnTrack.cxx.

  : Trk::CompetingRIOsOnTrack()
  , m_globalPosition{}
//
{
}

CompetingSCT_ClustersOnTrack() [2/3]

InDet::CompetingSCT_ClustersOnTrack::CompetingSCT_ClustersOnTrack

(

const CompetingSCT_ClustersOnTrack &

compROT

)

Copy Constructor.

Definition at line 27 of file CompetingSCT_ClustersOnTrack.cxx.

  : Trk::CompetingRIOsOnTrack(compROT)
  , m_globalPosition{}
{
  for (const InDet::SCT_ClusterOnTrack* rot : compROT.m_containedChildRots) {
    m_containedChildRots.push_back(rot->clone());
  }
  if (compROT.m_globalPosition) {
    m_globalPosition.store(std::make_unique<const Amg::Vector3D>(*compROT.m_globalPosition));
  }
}

CompetingSCT_ClustersOnTrack() [3/3]

InDet::CompetingSCT_ClustersOnTrack::CompetingSCT_ClustersOnTrack	(	std::vector< const InDet::SCT_ClusterOnTrack * > &&	childrots,
		std::vector< AssignmentProb > &&	assgnProb )

Constructor with all parameters: PLEASE do not use directly, but call InDet::CompetingSCT_ClustersOnTrackTool, otherwise inconsistency of the data will be very probable.

Definition at line 41 of file CompetingSCT_ClustersOnTrack.cxx.

  : Trk::CompetingRIOsOnTrack(std::move(assgnProb))
  , m_globalPosition{}
  , m_containedChildRots(std::move(childrots))
{
  // initialize local position and error matrix
  CompetingSCT_ClustersOnTrack::setLocalParametersAndErrorMatrix();
}

~CompetingSCT_ClustersOnTrack()

InDet::CompetingSCT_ClustersOnTrack::~CompetingSCT_ClustersOnTrack ( )

virtual

Destructor.

Definition at line 93 of file CompetingSCT_ClustersOnTrack.cxx.

{
  clearChildRotVector();
}

Member Function Documentation

assignmentProbability()

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

inlineinherited

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()

const Trk::Surface & InDet::CompetingSCT_ClustersOnTrack::associatedSurface ( ) const

inlinevirtual

returns the surface for the local to global transformation .

• interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 127 of file CompetingSCT_ClustersOnTrack.h.

{
  return ((*(m_containedChildRots.begin()))->associatedSurface());
}

clearChildRotVector()

void InDet::CompetingSCT_ClustersOnTrack::clearChildRotVector ( )

private

private method to clear the Trk::RIO_OnTrack vector

Definition at line 99 of file CompetingSCT_ClustersOnTrack.cxx.

{
  for (const InDet::SCT_ClusterOnTrack* rot : m_containedChildRots)
    delete rot;
}

clone()

CompetingSCT_ClustersOnTrack * InDet::CompetingSCT_ClustersOnTrack::clone ( ) const

inlinevirtual

needed to avoid excessive RTTI

Implements Trk::CompetingRIOsOnTrack.

Definition at line 121 of file CompetingSCT_ClustersOnTrack.h.

{
  return new InDet::CompetingSCT_ClustersOnTrack(*this);
}

containedROTs()

const std::vector< const InDet::SCT_ClusterOnTrack * > & InDet::CompetingSCT_ClustersOnTrack::containedROTs ( ) const

inline

returns the vector of SCT_ClusterOnTrack objects .

• specific for this CompetingSCT_ClustersOnTrack: SCT_ClusterOnTrack

Definition at line 133 of file CompetingSCT_ClustersOnTrack.h.

{
  return m_containedChildRots;
}

dump() [1/2]

MsgStream & InDet::CompetingSCT_ClustersOnTrack::dump ( MsgStream & out ) const

virtual

returns some information about this MeasurementBase/CompetingSCT_ClustersOnTrack.

Reimplemented from Trk::CompetingRIOsOnTrack.

Definition at line 106 of file CompetingSCT_ClustersOnTrack.cxx.

{
  using std::ios;
  out << "Trk::CompetingSCT_ClustersOnTrack with [" << numberOfContainedROTs()
      << "] competing RIO_OnTrack objects" << std::endl;
  out << "  - "
      << (this->ROTsHaveCommonSurface(true) ? "on common surface" : "over different surfaces")
      << "  (given prob>cut)" << std::endl;
  Trk::CompetingRIOsOnTrack::dump(out);
  out << "  - GlobalPosition        : ";
  if (not m_globalPosition)
    out << "null pointer" << endmsg;
  else
    out << *m_globalPosition << endmsg;
  return out;
}

dump() [2/2]

std::ostream & InDet::CompetingSCT_ClustersOnTrack::dump ( std::ostream & out ) const

virtual

returns some information about this MeasurementBase/CompetingSCT_ClustersOnTrack.

Reimplemented from Trk::CompetingRIOsOnTrack.

Definition at line 124 of file CompetingSCT_ClustersOnTrack.cxx.

{
  using std::ios;
  out << "Trk::CompetingSCT_ClustersOnTrack with [" << numberOfContainedROTs()
      << "] competing RIO_OnTrack objects" << std::endl;
  out << "  - "
      << (this->ROTsHaveCommonSurface(true) ? "on common surface" : "over different surfaces")
      << "  (given prob>cut)" << std::endl;
  Trk::CompetingRIOsOnTrack::dump(out);
  out << "  - GlobalPosition        : ";
  if (not m_globalPosition)
    out << "null pointer" << std::endl;
  else
    out << *m_globalPosition << std::endl;
  return out;
}

globalPosition()

const Amg::Vector3D & InDet::CompetingSCT_ClustersOnTrack::globalPosition ( ) const

inlinevirtual

Interface method to get the global Position.

• interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 145 of file CompetingSCT_ClustersOnTrack.h.

{
  if (not m_globalPosition) {
    m_globalPosition.set(std::make_unique<const Amg::Vector3D>(
      associatedSurface().localToGlobal(localParameters())));
  }
  return *m_globalPosition;
}

indexOfMaxAssignProb()

unsigned int Trk::CompetingRIOsOnTrack::indexOfMaxAssignProb ( ) const

inherited

Index of the ROT with the highest assignment probability.

• extends MeasurementBase

Definition at line 101 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()

unsigned int InDet::CompetingSCT_ClustersOnTrack::numberOfContainedROTs ( ) const

inlinevirtual

Number of RIO_OnTracks to be contained by this CompetingRIOsOnTrack.

Implements Trk::CompetingRIOsOnTrack.

Definition at line 155 of file CompetingSCT_ClustersOnTrack.h.

{
  return m_containedChildRots.size();
}

operator=() [1/2]

InDet::CompetingSCT_ClustersOnTrack & InDet::CompetingSCT_ClustersOnTrack::operator= ( InDet::CompetingSCT_ClustersOnTrack && compROT )

noexcept

Default move assignment operator.

Definition at line 78 of file CompetingSCT_ClustersOnTrack.cxx.

{
  if (this != &compROT) {
    // move operator of base class
    Trk::CompetingRIOsOnTrack::operator=(compROT);
    // clear rots
    clearChildRotVector();
    m_containedChildRots = std::move(compROT.m_containedChildRots);
    m_globalPosition = std::move(compROT.m_globalPosition);
  }
  return (*this);
}

operator=() [2/2]

InDet::CompetingSCT_ClustersOnTrack & InDet::CompetingSCT_ClustersOnTrack::operator=

(

const CompetingSCT_ClustersOnTrack &

compROT

)

Assignment operator.

Definition at line 55 of file CompetingSCT_ClustersOnTrack.cxx.

{
  if (this != &compROT) {
    // assingment operator of base class
    Trk::CompetingRIOsOnTrack::operator=(compROT);
    // clear rots
    clearChildRotVector();
    m_containedChildRots.clear();
 
    for (const InDet::SCT_ClusterOnTrack* rot : compROT.m_containedChildRots) {
      m_containedChildRots.push_back(rot->clone());
    }
    if (compROT.m_globalPosition) {
      m_globalPosition.store(std::make_unique<const Amg::Vector3D>(*compROT.m_globalPosition));
    } else if (m_globalPosition) {
      m_globalPosition.release().reset();
    }
  }
  return (*this);
}

rioOnTrack()

const InDet::SCT_ClusterOnTrack & InDet::CompetingSCT_ClustersOnTrack::rioOnTrack ( unsigned int indx ) const

inlinevirtual

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

Implements Trk::CompetingRIOsOnTrack.

Definition at line 139 of file CompetingSCT_ClustersOnTrack.h.

{
  return *(m_containedChildRots[indx]);
}

ROTsHaveCommonSurface()

bool InDet::CompetingSCT_ClustersOnTrack::ROTsHaveCommonSurface ( const bool withNonVanishingAssignProb = true ) const

privatevirtual

Have all the contained ROTs a common associated surface?

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

• interface from CompetingRIOsOnTrack
• CompetingSCT_ClustersOnTrack assume that all PixelClusters belong to the same detector element, so this function will always return true

Implements Trk::CompetingRIOsOnTrack.

Definition at line 143 of file CompetingSCT_ClustersOnTrack.cxx.

{
  return true;
}

setLocalParametersAndErrorMatrix()

void InDet::CompetingSCT_ClustersOnTrack::setLocalParametersAndErrorMatrix ( )

virtual

recalculate the LocalParameters and ErrorMatrix

• CompetingSCT_ClustersOnTrack overwrites implementation in CompetingRIOsOnTrack, because SCT end cap needs special attention in calculating the effective parameters

Reimplemented from Trk::CompetingRIOsOnTrack.

Definition at line 149 of file CompetingSCT_ClustersOnTrack.cxx.

{
 
  if (ROTsHaveCommonSurface()) {
    int nNonVanishingROTs = ((assignmentProbability(0) > 1.e-10) ? 1 : 0);
    for (unsigned int i = 1; i < numberOfContainedROTs(); i++) {
      if (assignmentProbability(i) > 1.e-10) {
        nNonVanishingROTs += 1;
      }
    }
    const int& paramKey = rioOnTrack(0).localParameters().parameterKey();
    Amg::MatrixX meanWeightMatrix;
    meanWeightMatrix.setZero();
    const unsigned int& maxProbIndex = indexOfMaxAssignProb();
    if (nNonVanishingROTs > 1) {
      // more than one non-vanishing ROT: do the more complicated calculation
      if (paramKey == 1) {
        Amg::MatrixX weight = rioOnTrack(0).localCovariance().inverse();
        Amg::VectorX meanParams =
          assignmentProbability(0) * weight * rioOnTrack(0).localParameters();
        meanWeightMatrix = assignmentProbability(0) * weight;
        for (unsigned int i = 1; i < numberOfContainedROTs(); i++) {
          weight = rioOnTrack(i).localCovariance().inverse();
          meanParams =
            meanParams + assignmentProbability(i) * weight * rioOnTrack(i).localParameters();
          meanWeightMatrix += assignmentProbability(i) * weight;
        }
 
        meanParams = meanWeightMatrix.inverse() * meanParams;
        Trk::DefinedParameter Par1(meanParams[Trk::loc1], Trk::loc1);
        m_localParams = Trk::LocalParameters(Par1);
      } else if (paramKey == 3) {
        double meanTheta = 0.;
        double meanEigen1 = 0.;
        double meanEigen2 = 0.;
        double sumAssignProb = 0.;
        double meanMeasX = 0.;
        double meanMeasY = 0.;
        for (unsigned int i = 0; i < numberOfContainedROTs(); i++) {
          const Amg::MatrixX& covMat = rioOnTrack(i).localCovariance();
          // rho[i] = covMat[0][1]/sqrt(covMat[0][0]*covMat[1][1]);
          const double& assignProb = assignmentProbability(i);
          sumAssignProb += assignProb;
          const double trace = covMat(0, 0) + covMat(1, 1);
          const double det = covMat(0, 0) * covMat(1, 1) - covMat(0, 1) * covMat(1, 0);
          const double lambda1 = trace / 2. - sqrt(trace * trace / 4. - det);
          const double lambda2 = trace / 2. + sqrt(trace * trace / 4. - det);
          meanTheta +=
            assignProb * 0.5 * atan(2. * covMat(0, 1) / (covMat(0, 0) - covMat(1, 1)));
          meanEigen1 += assignProb / lambda1;
          meanEigen2 += assignProb / lambda2;
          // x coord has smaller uncert (use smaller eigenvalue):
          meanMeasX += assignProb / lambda1 * rioOnTrack(i).localParameters()[Trk::locX];
          meanMeasY += assignProb / lambda2 * rioOnTrack(i).localParameters()[Trk::locY];
        }
        meanTheta /= sumAssignProb;
        meanMeasX /= meanEigen1;
        meanMeasY /= meanEigen2;
 
        const double cosTheta = cos(meanTheta);
        const double sinTheta = sin(meanTheta);
        meanWeightMatrix = Amg::MatrixX(2, 2);
        meanWeightMatrix.setZero();
        meanWeightMatrix(0, 0) =
          cosTheta * cosTheta * meanEigen1 + sinTheta * sinTheta * meanEigen2;
        meanWeightMatrix(1, 1) =
          cosTheta * cosTheta * meanEigen2 + sinTheta * sinTheta * meanEigen1;
        meanWeightMatrix(0, 1) =
          cosTheta * sinTheta * meanEigen1 - cosTheta * sinTheta * meanEigen2;
        meanWeightMatrix(1, 0) = meanWeightMatrix(0, 1);
 
        Amg::MatrixX weightMatrix_maxIndex =
          rioOnTrack(maxProbIndex).localCovariance().inverse();
        int orderInput = (weightMatrix_maxIndex(0, 0) > weightMatrix_maxIndex(1, 1)) ? -1 : 1;
        int orderOutput = (meanWeightMatrix(0, 0) > meanWeightMatrix(1, 1)) ? -1 : 1;
        if (orderInput * orderOutput < 0) {
          std::cout << "Trk::CompetingSCT_ClustersOnTrack: order of dimensions "
                       "does not match!!!";
        }
 
        Trk::DefinedParameter Par1(meanMeasX, Trk::loc1);
        Trk::DefinedParameter Par2(meanMeasY, Trk::loc2);
        m_localParams = Trk::LocalParameters(Par1, Par2);
      } else {
        std::cout << "Trk::CompetingSCT_ClustersOnTrack: can not handle parameter key "
                  << paramKey << std::endl;
      }
    } else {
      // not more than one non-vanishing ROT: use the ROT with highest prob
      meanWeightMatrix = assignmentProbability(maxProbIndex) *
                         rioOnTrack(maxProbIndex).localCovariance().inverse();
      m_localParams = rioOnTrack(maxProbIndex).localParameters();
    }
    // limit weight values against values too close to 0, otherwise inversion
    // will fail!
    if (meanWeightMatrix.trace() <= 1.0e-15) {
      for (int i = 0; i < meanWeightMatrix.cols(); ++i)
        meanWeightMatrix(i, i) = 1.0e-10;
    }
    m_localCovariance = meanWeightMatrix.inverse();
 
  } else {
 
    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

inlinefinaloverridevirtualinherited

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

inlineinherited

NVI Clone.

Definition at line 88 of file CompetingRIOsOnTrack.h.

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

Friends And Related Symbol Documentation

CompetingSCT_ClustersOnTrackTool

friend class CompetingSCT_ClustersOnTrackTool

friend

InDet::CompetingSCT_ClustersOnTrackTool is a friend to allow for updates of the assignment probabilities.

Definition at line 50 of file CompetingSCT_ClustersOnTrack.h.

Member Data Documentation

m_assignProb

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

protectedinherited

assignment probabilities of the ROTs

Definition at line 125 of file CompetingRIOsOnTrack.h.

m_containedChildRots

std::vector<const InDet::SCT_ClusterOnTrack*> InDet::CompetingSCT_ClustersOnTrack::m_containedChildRots

private

The vector of contained InDet::SCT_ClusterOnTrack objects.

Definition at line 109 of file CompetingSCT_ClustersOnTrack.h.

m_globalPosition

CxxUtils::CachedUniquePtr<const Amg::Vector3D> InDet::CompetingSCT_ClustersOnTrack::m_globalPosition

private

The global position.

Definition at line 106 of file CompetingSCT_ClustersOnTrack.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:

• CompetingSCT_ClustersOnTrack.h
• CompetingSCT_ClustersOnTrack.cxx