#include <CaloCluster_OnTrack.h>

Inheritance diagram for Trk::CaloCluster_OnTrack:

Collaboration diagram for Trk::CaloCluster_OnTrack:

Public Member Functions
	CaloCluster_OnTrack ()
	Default Constructor for POOL. More...

	CaloCluster_OnTrack (const CaloCluster_OnTrack &cot)
	Copy Constructor. More...

CaloCluster_OnTrack &	operator= (const CaloCluster_OnTrack &cot)
	Assignment operator. More...

	CaloCluster_OnTrack (CaloCluster_OnTrack &&cot) noexcept=default
	Move Constructor. More...

CaloCluster_OnTrack &	operator= (CaloCluster_OnTrack &&cot) noexcept=default
	Move Assignment operator. More...

	CaloCluster_OnTrack (LocalParameters &&locpars, Amg::MatrixX &&locerr, const Surface &surf, const EnergyLoss *eloss=nullptr)
	Constructor with parameters. More...

virtual	~CaloCluster_OnTrack ()=default
	Destructor. More...

virtual CaloCluster_OnTrack *	clone () const override final
	Pseudo-constructor, needed to avoid excessive RTTI. More...

std::unique_ptr< CaloCluster_OnTrack >	uniqueClone () const
	NVI Clone giving up unique pointer. More...

virtual const Surface &	associatedSurface () const override final
	returns the surface for the local to global transformation More...

virtual const Amg::Vector3D &	globalPosition () const override final
	Interface method to get the global Position. More...

const Trk::EnergyLoss *	energyLoss () const
	Extended method to get the EnergyLoss. More...

virtual bool	type (MeasurementBaseType::Type type) const override final
	Extended method checking the type. More...

virtual MsgStream &	dump (MsgStream &out) const override final
	returns the some information about this CaloCluster_OnTrack. More...

virtual std::ostream &	dump (std::ostream &out) const override final
	returns the some information about this CaloCluster_OnTrack. More...

const LocalParameters &	localParameters () const
	Interface method to get the LocalParameters. More...

const Amg::MatrixX &	localCovariance () const
	Interface method to get the localError. More...

void	destroySurface () noexcept
	destroySurface deletes the ptr if not null and the surface isFree Usefull also for testing More...

const S *	surfacePtr ()
	return the ptr we hold useful for tests More...

const S *	release () noexcept
	release ala unique_ptr release More...

Static Public Member Functions
static const S *	cloneHelper (const S *input)
	Helper for cloning or not when we need depending on if the surface isFree. More...

Protected Attributes
Amg::Vector3D	m_globalpos
	global position of the cluster hit More...

std::unique_ptr< const Trk::EnergyLoss >	m_eloss
	Energy Loss. More...

LocalParameters	m_localParams

Amg::MatrixX	m_localCovariance

const S *	m_associatedSurface = nullptr

Detailed Description

Class to handle Cluster On Tracks (ROT) for CaloClusters, it inherits from the common MeasurementBase.

The Track holds a vector of TrackStateOnSurface that carry the MeasurmentBase class pointers.

Definition at line 29 of file CaloCluster_OnTrack.h.

Constructor & Destructor Documentation

◆ CaloCluster_OnTrack() [1/4]

Trk::CaloCluster_OnTrack::CaloCluster_OnTrack ( )

Default Constructor for POOL.

Definition at line 31 of file CaloCluster_OnTrack.cxx.

   : Trk::MeasurementBase()
   , SurfacePtrHolder()
   , m_globalpos{ INVALID_VECTOR3D }
   , m_eloss{ nullptr }
 {}

◆ CaloCluster_OnTrack() [2/4]

Trk::CaloCluster_OnTrack::CaloCluster_OnTrack ( const CaloCluster_OnTrack & cot )

Copy Constructor.

Definition at line 39 of file CaloCluster_OnTrack.cxx.

   : Trk::MeasurementBase(cot)
   , SurfacePtrHolder(cot)
   , m_globalpos(cot.m_globalpos)
 {
   m_eloss.reset(cot.m_eloss ? new Trk::EnergyLoss(*cot.m_eloss) : nullptr);
 }

◆ CaloCluster_OnTrack() [3/4]

Trk::CaloCluster_OnTrack::CaloCluster_OnTrack ( CaloCluster_OnTrack && cot )

defaultnoexcept

Move Constructor.

◆ CaloCluster_OnTrack() [4/4]

Trk::CaloCluster_OnTrack::CaloCluster_OnTrack	(	Trk::LocalParameters &&	locpars,
		Amg::MatrixX &&	locerr,
		const Surface &	surf,
		const EnergyLoss *	eloss = `nullptr`
	)

Constructor with parameters.

Definition at line 19 of file CaloCluster_OnTrack.cxx.

   : MeasurementBase(std::move(locpars), std::move(locerr))
   , SurfacePtrHolder(surface)
   , m_globalpos(surface.localToGlobal(m_localParams))
   , m_eloss(eloss)
 {}

◆ ~CaloCluster_OnTrack()

virtual Trk::CaloCluster_OnTrack::~CaloCluster_OnTrack ( )

virtualdefault

Destructor.

Member Function Documentation

◆ associatedSurface()

const Trk::Surface & Trk::CaloCluster_OnTrack::associatedSurface ( ) const

inlinefinaloverridevirtual

returns the surface for the local to global transformation

interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 98 of file CaloCluster_OnTrack.h.

 {
   return *m_associatedSurface;
 }

◆ clone()

Trk::CaloCluster_OnTrack * Trk::CaloCluster_OnTrack::clone ( ) const

finaloverridevirtual

Pseudo-constructor, needed to avoid excessive RTTI.

Implements Trk::MeasurementBase.

Definition at line 62 of file CaloCluster_OnTrack.cxx.

 {
   return new Trk::CaloCluster_OnTrack(*this);
 }

◆ cloneHelper()

template<typename S >

static const S* Trk::SurfacePtrHolderImpl< S >::cloneHelper ( const S * input )

inlinestaticinherited

Helper for cloning or not when we need depending on if the surface isFree.

Definition at line 124 of file SurfaceHolderImpl.h.

   {
     return (input && input->isFree() ? input->clone() : input);
   }

◆ destroySurface()

template<typename S >

void Trk::SurfacePtrHolderImpl< S >::destroySurface ( )

inlinenoexceptinherited

destroySurface deletes the ptr if not null and the surface isFree Usefull also for testing

Definition at line 105 of file SurfaceHolderImpl.h.

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

◆ dump() [1/2]

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

finaloverridevirtual

returns the some information about this CaloCluster_OnTrack.

Implements Trk::MeasurementBase.

Definition at line 74 of file CaloCluster_OnTrack.cxx.

 {
   sl << "Trk::CaloCluster_OnTrack { "
      << "\n";
   sl << "\t  surface = " << associatedSurface() << "\n";
   sl << "\t  position = (" << localParameters() << endmsg;
   sl << "\t  has Error Matrix: "
      << "\n";
   sl << localCovariance() << "}"
      << "\n";
  
   return sl;
 }

◆ dump() [2/2]

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

finaloverridevirtual

returns the some information about this CaloCluster_OnTrack.

Implements Trk::MeasurementBase.

Definition at line 89 of file CaloCluster_OnTrack.cxx.

 {
   sl << "\t  surface = " << associatedSurface() << "\n";
   sl << "\t  position = (" << localParameters() << "\n";
   sl << "\t  has Error Matrix: "
      << "\n";
   sl << localCovariance() << "}"
      << "\n";
   return sl;
 }

◆ energyLoss()

const Trk::EnergyLoss * Trk::CaloCluster_OnTrack::energyLoss ( ) const

inline

Extended method to get the EnergyLoss.

Definition at line 104 of file CaloCluster_OnTrack.h.

 {
   return m_eloss.get();
 }

◆ globalPosition()

const Amg::Vector3D & Trk::CaloCluster_OnTrack::globalPosition ( ) const

finaloverridevirtual

Interface method to get the global Position.

interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 68 of file CaloCluster_OnTrack.cxx.

 {
   return m_globalpos;
 }

◆ 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;
 }

◆ operator=() [1/2]

CaloCluster_OnTrack& Trk::CaloCluster_OnTrack::operator= ( CaloCluster_OnTrack && cot )

defaultnoexcept

Move Assignment operator.

◆ operator=() [2/2]

Trk::CaloCluster_OnTrack & Trk::CaloCluster_OnTrack::operator= ( const CaloCluster_OnTrack & cot )

Assignment operator.

Definition at line 50 of file CaloCluster_OnTrack.cxx.

 {
   if (&cot != this) {
     Trk::MeasurementBase::operator=(cot);
     SurfacePtrHolder::operator=(cot);
     m_globalpos = cot.m_globalpos;
     m_eloss.reset(cot.m_eloss ? new Trk::EnergyLoss(*cot.m_eloss) : nullptr);
   }
   return *this;
 }

◆ release()

template<typename S >

const S* Trk::SurfacePtrHolderImpl< S >::release ( )

inlinenoexceptinherited

release ala unique_ptr release

Definition at line 116 of file SurfaceHolderImpl.h.

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

◆ surfacePtr()

template<typename S >

const S* Trk::SurfacePtrHolderImpl< S >::surfacePtr ( )

inlineinherited

return the ptr we hold useful for tests

Definition at line 114 of file SurfaceHolderImpl.h.

114 { return m_associatedSurface; }

◆ type()

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

inlinefinaloverridevirtual

Extended method checking the type.

Implements Trk::MeasurementBase.

Definition at line 75 of file CaloCluster_OnTrack.h.

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

◆ uniqueClone()

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

inline

NVI Clone giving up unique pointer.

Definition at line 58 of file CaloCluster_OnTrack.h.

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

Member Data Documentation

◆ m_associatedSurface

template<typename S >

const S* Trk::SurfacePtrHolderImpl< S >::m_associatedSurface = nullptr

protectedinherited

Definition at line 130 of file SurfaceHolderImpl.h.

◆ m_eloss

std::unique_ptr<const Trk::EnergyLoss> Trk::CaloCluster_OnTrack::m_eloss

protected

Energy Loss.

Definition at line 91 of file CaloCluster_OnTrack.h.

◆ m_globalpos

Amg::Vector3D Trk::CaloCluster_OnTrack::m_globalpos

protected

global position of the cluster hit

Definition at line 88 of file CaloCluster_OnTrack.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:

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CaloCluster_OnTrack() [1/4]

◆ CaloCluster_OnTrack() [2/4]

◆ CaloCluster_OnTrack() [3/4]

◆ CaloCluster_OnTrack() [4/4]

◆ ~CaloCluster_OnTrack()

Member Function Documentation

◆ associatedSurface()

◆ clone()

◆ cloneHelper()

◆ destroySurface()

◆ dump() [1/2]

◆ dump() [2/2]

◆ energyLoss()

◆ globalPosition()

◆ localCovariance()

◆ localParameters()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ release()

◆ surfacePtr()

◆ type()

◆ uniqueClone()

Member Data Documentation

◆ m_associatedSurface

◆ m_eloss

◆ m_globalpos

◆ m_localCovariance

◆ m_localParams