InDet::CompetingPixelClustersOnTrack Class Reference

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

#include <CompetingPixelClustersOnTrack.h>

Inheritance diagram for InDet::CompetingPixelClustersOnTrack:

Collaboration diagram for InDet::CompetingPixelClustersOnTrack:

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
	CompetingPixelClustersOnTrack ()
	Default Constructor for POOL.
	CompetingPixelClustersOnTrack (const CompetingPixelClustersOnTrack &compROT)
	Copy Constructor.
CompetingPixelClustersOnTrack &	operator= (const CompetingPixelClustersOnTrack &compROT)
	Assignment operator.
CompetingPixelClustersOnTrack &	operator= (CompetingPixelClustersOnTrack &&compROT) noexcept
	CompetingPixelClustersOnTrack (std::vector< const InDet::PixelClusterOnTrack * > &&childrots, std::vector< AssignmentProb > &&assgnProb)
	Constructor with all parameters: PLEASE do not use directly, but call InDet::CompetingPixelClustersOnTrackTool, otherwise inconsistency of the data will be very probable.
virtual	~CompetingPixelClustersOnTrack ()
	Destructor.
CompetingPixelClustersOnTrack *	clone () const
	needed to avoid excessive RTTI
std::unique_ptr< CompetingPixelClustersOnTrack >	uniqueClone () const
	NVI method returning unique_ptr clone.
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::PixelClusterOnTrack * > &	containedROTs () const
	returns the vector of PixelClusterOnTrack objects .
const InDet::PixelClusterOnTrack &	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/CompetingPixelClustersOnTrack.
std::ostream &	dump (std::ostream &out) const
	returns some information about this MeasurementBase/CompetingPixelClustersOnTrack.
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 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.

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::PixelClusterOnTrack * >	m_containedChildRots
	The vector of contained InDet::PixelClusterOnTrack objects.

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

Detailed Description

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

This class is used by the Deterministic Annealing Filter to handle several PixelClusterOnTrack 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::CompetingPixelClustersOnTrack 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 46 of file CompetingPixelClustersOnTrack.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

CompetingPixelClustersOnTrack() [1/3]

InDet::CompetingPixelClustersOnTrack::CompetingPixelClustersOnTrack

(

)

Default Constructor for POOL.

Definition at line 16 of file CompetingPixelClustersOnTrack.cxx.

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

CompetingPixelClustersOnTrack() [2/3]

InDet::CompetingPixelClustersOnTrack::CompetingPixelClustersOnTrack

(

const CompetingPixelClustersOnTrack &

compROT

)

Copy Constructor.

Definition at line 24 of file CompetingPixelClustersOnTrack.cxx.

  : Trk::CompetingRIOsOnTrack(compROT)
  , m_globalPosition{}
  , m_containedChildRots()
{
  std::vector<const InDet::PixelClusterOnTrack*>::const_iterator rotIter =
    compROT.m_containedChildRots.begin();
  for (; rotIter != compROT.m_containedChildRots.end(); ++rotIter) {
    m_containedChildRots.push_back((*rotIter)->clone());
  }
  if (compROT.m_globalPosition) {
    m_globalPosition.store(std::make_unique<const Amg::Vector3D>(*compROT.m_globalPosition));
  }
}

CompetingPixelClustersOnTrack() [3/3]

InDet::CompetingPixelClustersOnTrack::CompetingPixelClustersOnTrack	(	std::vector< const InDet::PixelClusterOnTrack * > &&	childrots,
		std::vector< AssignmentProb > &&	assgnProb )

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

Definition at line 41 of file CompetingPixelClustersOnTrack.cxx.

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

~CompetingPixelClustersOnTrack()

InDet::CompetingPixelClustersOnTrack::~CompetingPixelClustersOnTrack ( )

virtual

Destructor.

Definition at line 90 of file CompetingPixelClustersOnTrack.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::CompetingPixelClustersOnTrack::associatedSurface ( ) const

inlinevirtual

returns the surface for the local to global transformation .

• interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 129 of file CompetingPixelClustersOnTrack.h.

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

clearChildRotVector()

void InDet::CompetingPixelClustersOnTrack::clearChildRotVector ( )

private

private method to clear the Trk::RIO_OnTrack vector

Definition at line 96 of file CompetingPixelClustersOnTrack.cxx.

{
  std::vector<const InDet::PixelClusterOnTrack*>::const_iterator rotIter =
    m_containedChildRots.begin();
  for (; rotIter != m_containedChildRots.end(); ++rotIter)
    delete (*rotIter);
}

clone()

CompetingPixelClustersOnTrack * InDet::CompetingPixelClustersOnTrack::clone ( ) const

inlinevirtual

needed to avoid excessive RTTI

Implements Trk::CompetingRIOsOnTrack.

Definition at line 123 of file CompetingPixelClustersOnTrack.h.

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

containedROTs()

const std::vector< const InDet::PixelClusterOnTrack * > & InDet::CompetingPixelClustersOnTrack::containedROTs ( ) const

inline

returns the vector of PixelClusterOnTrack objects .

• specific for this CompetingPixelClustersOnTrack: PixelClusterOnTrack

Definition at line 135 of file CompetingPixelClustersOnTrack.h.

{
  return (m_containedChildRots);
}

dump() [1/2]

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

virtual

returns some information about this MeasurementBase/CompetingPixelClustersOnTrack.

Reimplemented from Trk::CompetingRIOsOnTrack.

Definition at line 105 of file CompetingPixelClustersOnTrack.cxx.

{
  using std::ios;
  out << "Trk::CompetingPixelClustersOnTrack with [" << numberOfContainedROTs()
      << "] competing Pixel RIO_OnTrack objects" << std::endl;
  Trk::CompetingRIOsOnTrack::dump(out);
  out << "  - GlobalPosition        : ";
  if (not m_globalPosition)
    out << "null pointer" << std::endl;
  else
    out << *m_globalPosition << endmsg;
  return out;
}

dump() [2/2]

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

virtual

returns some information about this MeasurementBase/CompetingPixelClustersOnTrack.

Reimplemented from Trk::CompetingRIOsOnTrack.

Definition at line 120 of file CompetingPixelClustersOnTrack.cxx.

{
  using std::ios;
  out << "Trk::CompetingPixelClustersOnTrack with [" << numberOfContainedROTs()
      << "] competing Pixel RIO_OnTrack objects" << 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::CompetingPixelClustersOnTrack::globalPosition ( ) const

virtual

Interface method to get the global Position.

• interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 142 of file CompetingPixelClustersOnTrack.cxx.

{
  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::CompetingPixelClustersOnTrack::numberOfContainedROTs ( ) const

inlinevirtual

Number of RIO_OnTracks to be contained by this CompetingRIOsOnTrack.

Implements Trk::CompetingRIOsOnTrack.

Definition at line 147 of file CompetingPixelClustersOnTrack.h.

{
  return m_containedChildRots.size();
}

operator=() [1/2]

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

noexcept

Definition at line 76 of file CompetingPixelClustersOnTrack.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::CompetingPixelClustersOnTrack & InDet::CompetingPixelClustersOnTrack::operator=

(

const CompetingPixelClustersOnTrack &

compROT

)

Assignment operator.

Definition at line 53 of file CompetingPixelClustersOnTrack.cxx.

{
  if (this != &compROT) {
    // assignment operator of base class
    Trk::CompetingRIOsOnTrack::operator=(compROT);
    // clear rots
    clearChildRotVector();
    m_containedChildRots.clear();
    if (compROT.m_globalPosition) {
      m_globalPosition.store(std::make_unique<const Amg::Vector3D>(*compROT.m_globalPosition));
    } else if (m_globalPosition) {
      m_globalPosition.release().reset();
    }
    std::vector<const InDet::PixelClusterOnTrack*>::const_iterator rotIter =
      compROT.m_containedChildRots.begin();
    for (; rotIter != compROT.m_containedChildRots.end(); ++rotIter)
      m_containedChildRots.push_back((*rotIter)->clone());
  }
  return (*this);
}

rioOnTrack()

const InDet::PixelClusterOnTrack & InDet::CompetingPixelClustersOnTrack::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 141 of file CompetingPixelClustersOnTrack.h.

{
  return *std::as_const(m_containedChildRots)[indx];
}

ROTsHaveCommonSurface()

bool InDet::CompetingPixelClustersOnTrack::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
• CompetingPixelClustersOnTrack assume that all PixelClusters belong to the same detector element, so this function will always return true

Implements Trk::CompetingRIOsOnTrack.

Definition at line 136 of file CompetingPixelClustersOnTrack.cxx.

{
  return true;
}

setLocalParametersAndErrorMatrix()

void Trk::CompetingRIOsOnTrack::setLocalParametersAndErrorMatrix ( )

virtualinherited

recalculate the LocalParameters and ErrorMatrix

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

Definition at line 34 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

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< CompetingPixelClustersOnTrack > InDet::CompetingPixelClustersOnTrack::uniqueClone ( ) const

inline

NVI method returning unique_ptr clone.

Definition at line 75 of file CompetingPixelClustersOnTrack.h.

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

Friends And Related Symbol Documentation

CompetingPixelClustersOnTrackTool

friend class CompetingPixelClustersOnTrackTool

friend

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

Definition at line 52 of file CompetingPixelClustersOnTrack.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::PixelClusterOnTrack*> InDet::CompetingPixelClustersOnTrack::m_containedChildRots

private

The vector of contained InDet::PixelClusterOnTrack objects.

Definition at line 111 of file CompetingPixelClustersOnTrack.h.

m_globalPosition

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

private

The global Position.

Definition at line 108 of file CompetingPixelClustersOnTrack.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:

• CompetingPixelClustersOnTrack.h
• CompetingPixelClustersOnTrack.cxx