InDet::CompetingTRT_DriftCirclesOnTrack Class Reference

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

#include <CompetingTRT_DriftCirclesOnTrack.h>

Inheritance diagram for InDet::CompetingTRT_DriftCirclesOnTrack:

Collaboration diagram for InDet::CompetingTRT_DriftCirclesOnTrack:

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
	CompetingTRT_DriftCirclesOnTrack ()
	Default Constructor for POOL.
	CompetingTRT_DriftCirclesOnTrack (const CompetingTRT_DriftCirclesOnTrack &compROT)
	Copy Constructor.
CompetingTRT_DriftCirclesOnTrack &	operator= (const CompetingTRT_DriftCirclesOnTrack &compROT)
	Assignment operator.
CompetingTRT_DriftCirclesOnTrack &	operator= (CompetingTRT_DriftCirclesOnTrack &&compROT) noexcept
	Move assignment operator.
	CompetingTRT_DriftCirclesOnTrack (const Trk::Surface *sf, std::vector< const InDet::TRT_DriftCircleOnTrack * > &&childrots, std::vector< AssignmentProb > &&assgnProb, const Trk::LocalParameters &effecLocalPars, const Amg::MatrixX &effecLocalErrMat, int ROTsHaveComSrfc)
	Constructor with all parameters: PLEASE do not use directly, but call InDet::CompetingTRT_DriftCirclesOnTrackTool, otherwise inconsistency of the data will be very probable.
virtual	~CompetingTRT_DriftCirclesOnTrack ()
	Destructor.
CompetingTRT_DriftCirclesOnTrack *	clone () const
	virtual constructor - 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::TRT_DriftCircleOnTrack * > &	containedROTs () const
	returns the vector of TRT_DriftCircleOnTrack objects .
const InDet::TRT_DriftCircleOnTrack &	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/CompetingTRT_DriftCirclesOnTrack.
std::ostream &	dump (std::ostream &out) const
	returns some information about this MeasurementBase/CompetingTRT_DriftCirclesOnTrack.
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.
const Surface *	surfacePtr ()
	return the ptr we hold useful for tests
const Surface *	release () noexcept
	release ala unique_ptr release
void	destroySurface () noexcept
	destroySurface deletes the ptr if not null and the surface has not a associatedDetectorElement Usefull also for testing

Static Public Member Functions
static const Surface *	cloneHelper (const Surface *input)
	Helper for cloning or not when we need depending on if we have an associatedDetectorElement.

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

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

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

Detailed Description

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

This class is used by the Deterministic Annealing Filter to handle several TRT_DriftCircleOnTrack 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() return the mean values according to the weights (assignment probabilities).

Author

Sebastian.Fleischmann -at- cern.ch

Definition at line 45 of file CompetingTRT_DriftCirclesOnTrack.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

CompetingTRT_DriftCirclesOnTrack() [1/3]

InDet::CompetingTRT_DriftCirclesOnTrack::CompetingTRT_DriftCirclesOnTrack

(

)

Default Constructor for POOL.

Definition at line 19 of file CompetingTRT_DriftCirclesOnTrack.cxx.

  : Trk::CompetingRIOsOnTrack()
  , Trk::SurfacePtrHolderDetEl(nullptr)
  , m_globalPosition{}
  , m_containedChildRots()
  , m_ROTsHaveCommonSurface(8)
{
}

CompetingTRT_DriftCirclesOnTrack() [2/3]

InDet::CompetingTRT_DriftCirclesOnTrack::CompetingTRT_DriftCirclesOnTrack

(

const CompetingTRT_DriftCirclesOnTrack &

compROT

)

Copy Constructor.

Definition at line 29 of file CompetingTRT_DriftCirclesOnTrack.cxx.

  : Trk::CompetingRIOsOnTrack(compROT)
  , Trk::SurfacePtrHolderDetEl(compROT)
  , m_globalPosition{}
  , m_containedChildRots{}
  , m_ROTsHaveCommonSurface(compROT.m_ROTsHaveCommonSurface)
{
  std::vector<const InDet::TRT_DriftCircleOnTrack*>::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)));
  }
}

CompetingTRT_DriftCirclesOnTrack() [3/3]

InDet::CompetingTRT_DriftCirclesOnTrack::CompetingTRT_DriftCirclesOnTrack	(	const Trk::Surface *	sf,
		std::vector< const InDet::TRT_DriftCircleOnTrack * > &&	childrots,
		std::vector< AssignmentProb > &&	assgnProb,
		const Trk::LocalParameters &	effecLocalPars,
		const Amg::MatrixX &	effecLocalErrMat,
		int	ROTsHaveComSrfc )

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

Definition at line 49 of file CompetingTRT_DriftCirclesOnTrack.cxx.

  : Trk::CompetingRIOsOnTrack(std::move(assgnProb))
  , Trk::SurfacePtrHolderDetEl(sf)
  , m_globalPosition{}
  , m_containedChildRots(std::move(childrots))
  , m_ROTsHaveCommonSurface(ROTsHaveComSrfc)
{
  m_localParams = effecLocalPars;
  m_localCovariance = effecLocalErrMat;
}

~CompetingTRT_DriftCirclesOnTrack()

InDet::CompetingTRT_DriftCirclesOnTrack::~CompetingTRT_DriftCirclesOnTrack ( )

virtual

Destructor.

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

inlinevirtual

returns the surface for the local to global transformation .

• interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 141 of file CompetingTRT_DriftCirclesOnTrack.h.

{
  return (*m_associatedSurface);
}

clearChildRotVector()

void InDet::CompetingTRT_DriftCirclesOnTrack::clearChildRotVector ( )

private

private method to clear the Trk::RIO_OnTrack vector

Definition at line 121 of file CompetingTRT_DriftCirclesOnTrack.cxx.

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

clone()

CompetingTRT_DriftCirclesOnTrack * InDet::CompetingTRT_DriftCirclesOnTrack::clone ( ) const

inlinevirtual

virtual constructor - needed to avoid excessive RTTI

Implements Trk::CompetingRIOsOnTrack.

Definition at line 135 of file CompetingTRT_DriftCirclesOnTrack.h.

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

cloneHelper()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::cloneHelper ( const Surface * input )

inlinestaticinherited

Helper for cloning or not when we need depending on if we have an associatedDetectorElement.

Definition at line 213 of file SurfaceHolderImpl.h.

  {
    return (input && input->associatedDetectorElement() == nullptr
              ? input->clone()
              : input);
  }

containedROTs()

const std::vector< const InDet::TRT_DriftCircleOnTrack * > & InDet::CompetingTRT_DriftCirclesOnTrack::containedROTs ( ) const

inline

returns the vector of TRT_DriftCircleOnTrack objects .

• specific for this CompetingTRT_DriftCirclesOnTrack: TRT_DriftCircleOnTrack

Definition at line 147 of file CompetingTRT_DriftCirclesOnTrack.h.

{
  return m_containedChildRots;
}

destroySurface()

void Trk::SurfacePtrHolderImplDetEl< Surface >::destroySurface ( )

inlinenoexceptinherited

destroySurface deletes the ptr if not null and the surface has not a associatedDetectorElement Usefull also for testing

Definition at line 201 of file SurfaceHolderImpl.h.

  {
    if (m_associatedSurface &&
        m_associatedSurface->associatedDetectorElement() == nullptr) {
      delete m_associatedSurface;
    }
    //
    m_associatedSurface = nullptr;
  }

dump() [1/2]

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

virtual

returns some information about this MeasurementBase/CompetingTRT_DriftCirclesOnTrack.

Reimplemented from Trk::CompetingRIOsOnTrack.

Definition at line 131 of file CompetingTRT_DriftCirclesOnTrack.cxx.

{
  using std::ios;
  out << "Trk::CompetingTRT_DriftCirclesOnTrack 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::CompetingTRT_DriftCirclesOnTrack::dump ( std::ostream & out ) const

virtual

returns some information about this MeasurementBase/CompetingTRT_DriftCirclesOnTrack.

Reimplemented from Trk::CompetingRIOsOnTrack.

Definition at line 151 of file CompetingTRT_DriftCirclesOnTrack.cxx.

{
  using std::ios;
  out << "Trk::CompetingTRT_DriftCirclesOnTrack 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::CompetingTRT_DriftCirclesOnTrack::globalPosition ( ) const

virtual

Interface method to get the global Position.

• interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 189 of file CompetingTRT_DriftCirclesOnTrack.cxx.

{
  if (m_globalPosition) {
    return *m_globalPosition;
  }
  // cannot use the localToGlobal transformation, because the local z-coordinate
  // along the wire is not known here. The contained TRT_DriftCircleOnTrack use
  // the full transformation => use the weighted mean of their GlobalPositions
  // FIXME: introduce a special function in base class, which returns the sum of
  // assignment probabilities
  double assgnProbSum = 0.;
  std::vector<AssignmentProb>::const_iterator assgnProbIter =
    m_assignProb.begin();
  for (; assgnProbIter != m_assignProb.end(); ++assgnProbIter) {
    assgnProbSum += (*assgnProbIter);
  }
 
  Amg::Vector3D globalPos(0., 0., 0.);
  if (assgnProbSum > 0.) {
    std::vector<const InDet::TRT_DriftCircleOnTrack*>::const_iterator rotIter =
      std::as_const(m_containedChildRots).begin();
    assgnProbIter = m_assignProb.begin();
    for (; rotIter != std::as_const(m_containedChildRots).end();
         ++rotIter, ++assgnProbIter) {
      globalPos +=
        (((*assgnProbIter) / assgnProbSum) * ((*rotIter)->globalPosition()));
    }
 
  } else {
    globalPos = std::as_const(m_containedChildRots)[0]->globalPosition();
  }
  m_globalPosition.set(std::make_unique<const Amg::Vector3D>(globalPos));
  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::CompetingTRT_DriftCirclesOnTrack::numberOfContainedROTs ( ) const

inlinevirtual

Number of RIO_OnTracks to be contained by this CompetingRIOsOnTrack.

Implements Trk::CompetingRIOsOnTrack.

Definition at line 159 of file CompetingTRT_DriftCirclesOnTrack.h.

{
  return m_containedChildRots.size();
}

operator=() [1/2]

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

noexcept

Move assignment operator.

Definition at line 99 of file CompetingTRT_DriftCirclesOnTrack.cxx.

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

operator=() [2/2]

InDet::CompetingTRT_DriftCirclesOnTrack & InDet::CompetingTRT_DriftCirclesOnTrack::operator=

(

const CompetingTRT_DriftCirclesOnTrack &

compROT

)

Assignment operator.

Definition at line 69 of file CompetingTRT_DriftCirclesOnTrack.cxx.

{
  if (this != &compROT) {
    // assignment operator of base class
    Trk::CompetingRIOsOnTrack::operator=(compROT);
    Trk::SurfacePtrHolderDetEl::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();
    }
    //
    m_ROTsHaveCommonSurface = compROT.m_ROTsHaveCommonSurface;
    //
    std::vector<const InDet::TRT_DriftCircleOnTrack*>::const_iterator rotIter =
      compROT.m_containedChildRots.begin();
    for (; rotIter != compROT.m_containedChildRots.end(); ++rotIter)
      m_containedChildRots.push_back((*rotIter)->clone());
  }
  return (*this);
}

release()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::release ( )

inlinenoexceptinherited

release ala unique_ptr release

Definition at line 192 of file SurfaceHolderImpl.h.

  {
    const S* tmp = m_associatedSurface;
    m_associatedSurface = nullptr;
    return tmp;
  }

rioOnTrack()

const InDet::TRT_DriftCircleOnTrack & InDet::CompetingTRT_DriftCirclesOnTrack::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 153 of file CompetingTRT_DriftCirclesOnTrack.h.

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

ROTsHaveCommonSurface()

bool InDet::CompetingTRT_DriftCirclesOnTrack::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.

Implements Trk::CompetingRIOsOnTrack.

Definition at line 172 of file CompetingTRT_DriftCirclesOnTrack.cxx.

{
  // if (m_ROTsHaveCommonSurface==0) {
  // values of int m_ROTsHaveCommonSurface:
  //  no  yes  NA    (ROTs on a common surface)  NA means not checked yet
  //  0    1   2
  //     for all    | just ROTs with non-vanishing assgnProb
  //      * 1       |   * 3
  if (withNonVanishingAssignProb) {
    return (m_ROTsHaveCommonSurface / 3);
  } else {
    return (m_ROTsHaveCommonSurface % 3);
  }
}

setLocalParametersAndErrorMatrix()

void InDet::CompetingTRT_DriftCirclesOnTrack::setLocalParametersAndErrorMatrix ( )

virtual

recalculate the LocalParameters and ErrorMatrix

Reimplemented from Trk::CompetingRIOsOnTrack.

Definition at line 225 of file CompetingTRT_DriftCirclesOnTrack.cxx.

{
  std::cout << "InDet::CompetingTRT_DriftCirclesOnTrack: can not handle ROTs "
               "in different surfaces without detector specific knowledge "
            << std::endl;
}

surfacePtr()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::surfacePtr ( )

inlineinherited

return the ptr we hold useful for tests

Definition at line 190 of file SurfaceHolderImpl.h.

{ return m_associatedSurface; }

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

CompetingTRT_DriftCirclesOnTrackTool

friend class CompetingTRT_DriftCirclesOnTrackTool

friend

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

Definition at line 53 of file CompetingTRT_DriftCirclesOnTrack.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_associatedSurface

const Surface* Trk::SurfacePtrHolderImplDetEl< Surface >::m_associatedSurface

protectedinherited

Definition at line 221 of file SurfaceHolderImpl.h.

m_containedChildRots

std::vector<const InDet::TRT_DriftCircleOnTrack*> InDet::CompetingTRT_DriftCirclesOnTrack::m_containedChildRots

private

The vector of contained InDet::TRT_DriftCircleOnTrack objects.

Definition at line 124 of file CompetingTRT_DriftCirclesOnTrack.h.

m_globalPosition

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

private

The global Position.

Definition at line 121 of file CompetingTRT_DriftCirclesOnTrack.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.

m_ROTsHaveCommonSurface

int InDet::CompetingTRT_DriftCirclesOnTrack::m_ROTsHaveCommonSurface

private

Definition at line 131 of file CompetingTRT_DriftCirclesOnTrack.h.

---

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

• CompetingTRT_DriftCirclesOnTrack.h
• CompetingTRT_DriftCirclesOnTrack.cxx