#include <TrackParticleBase.h>

Inheritance diagram for Trk::TrackParticleBase:

Collaboration diagram for Trk::TrackParticleBase:

Public Member Functions
	TrackParticleBase ()
	Constructor 0 standard constructor which sets everything to 0, needed for persistency.
	TrackParticleBase (const Track trk, const TrackParticleOrigin vertexType, const VxCandidate vxCandidate, const TrackSummary trkSummary, std::vector< const TrackParameters > &parameters, const TrackParameters definingParameter, const FitQuality fitQuality)
	Main constructor.
	TrackParticleBase (const ElementLink< TrackCollection > &trackLink, const Trk::TrackParticleOrigin trkPrtOrigin, const ElementLink< VxContainer > &vxCandidate, std::unique_ptr< Trk::TrackSummary > trkSummary, std::vector< const Trk::TrackParameters * > &&parameters, std::unique_ptr< Trk::FitQuality > fitQuality, const TrackInfo &info)
	TrackParticleBase (const TrackParticleBase &)
	Copy constructor.
TrackParticleBase &	operator= (const TrackParticleBase &)
	Assignement operator.
TrackParticleBase &	operator= (TrackParticleBase &&) noexcept
virtual	~TrackParticleBase ()
	Destructor.
double	charge () const
	Return charge of the particle.
const Track *	originalTrack () const
	Return pointer to associated track.
const VxCandidate *	reconstructedVertex () const
	Get a pointer to the primary vertex.
const ElementLink< VxContainer > &	reconstructedVertexLink () const
TrackParticleOrigin	particleOriginType () const
	Get the particle origin type.
const TrackParameters &	definingParameters () const
	Returns the 'defining' parameter of this TrackParticle.
const std::vector< const TrackParameters * > &	trackParameters () const
	Returns the track parameters.
const ElementLink< TrackCollection > *	trackElementLink () const
	Return the ElementLink to the Track.
const TrackSummary *	trackSummary () const
	accessor function for TrackSummary.
const FitQuality *	fitQuality () const
	accessor function for FitQuality.
const Perigee *	perigee () const
	Attempts to cast the definingParameters() to Perigee.
void	setStorableObject (const TrackCollection *trackColl)
void	setStorableObject (const VxContainer *vxColl)
void	setTrackLink (const TrackCollection cont, const Track track)
virtual MsgStream &	dump (MsgStream &out) const
	Dump methods to be used by the overloaded stream operator (inheritance!)
virtual std::ostream &	dump (std::ostream &out) const
const TrackInfo &	info () const
	returns the info of the track.

Protected Attributes
ElementLink< TrackCollection >	m_originalTrack
	ElementLink to the Track used to create this TrackParticleBase object Before writing to disk, should be made valid using setStorableObject(const VxContainer* vxColl).
TrackParticleOrigin	m_trackParticleOrigin
	specifies the origin type of the particle (prim.vertex, ...)
ElementLink< VxContainer >	m_elVxCandidate
	ElementLink to a VxCandidate.
std::vector< const TrackParameters * >	m_trackParameters
	DataVector of TrackParameters stored inside this TrackParticle.
const TrackSummary *	m_trackSummary
	the summary of this TrackParticle.
const FitQuality *	m_fitQuality
	the fit quality of this TrackParticle.
TrackInfo	m_trackInfo
	This is a class which stores the identity of where the track was created, fitted, which properties the reconstruction had.

Friends
class	::TrackParticleBaseCnv_p1

Detailed Description

Definition at line 40 of file TrackParticleBase.h.

Constructor & Destructor Documentation

◆ TrackParticleBase() [1/4]

Trk::TrackParticleBase::TrackParticleBase ( )

Constructor 0 standard constructor which sets everything to 0, needed for persistency.

Definition at line 19 of file TrackParticleBase.cxx.

                                         :
        m_originalTrack(),
        m_trackParticleOrigin(NoVtx),
        m_elVxCandidate(),
        m_trackParameters(0),
        m_trackSummary(nullptr),
        m_fitQuality(nullptr),
    m_trackInfo()
    {
      #ifdef DEBUG_CTOR_DTOR
      std::cout<<"TrackParticleBase blank ctr :"<<this<<std::endl;
      #endif
    }

◆ TrackParticleBase() [2/4]

Trk::TrackParticleBase::TrackParticleBase	(	const Track *	trk,
		const TrackParticleOrigin	vertexType,
		const VxCandidate *	vxCandidate,
		const TrackSummary *	trkSummary,
		std::vector< const TrackParameters * > &	parameters,
		const TrackParameters *	definingParameter,
		const FitQuality *	fitQuality )

Main constructor.

Merged old Constructors 0.5a, 2a and 1a from old (pre 13) TrackParticle constructors & added new info.

I have tried to merge the various TrackParticle constructors (though perhaps we should split this into one which takes RecVertex and one which takes VxCandidate, since they seem to be exclusive)

Parameters

trk	Track used to create this object. Since an ElementLink is used to store the object, setStorableObject(const TrackCollection* trackColl) must be called to set persistency.
vertexType	See TrackParticleOrigin for definitions, but should be set to NoVtx if no VxCandidate pointer is passed.
vxCandidate	Pointer to the VxCandidate used to create this TrackParticleBase.
trkSummary	Summary object of this TrackParticleBase (should be created with TrackSummaryTool). Will be owned by this TrackParticleBase.
parameters	std::vector of TrackParameters which describe this TrackParticleBase. Ownership of these TrackParameters objects passes to TrackParticleBase (so if you copied them from a Track, make sure you didn't just copy the pointers but actually created new objects, for example, by using clone() )
definingParameter	The parameter which defines the charge of this TrackParticleBase and which in derived classes (such as Rec::TrackParticle), could be used to define e.g. the 4-momentum. This will be appended to the vector of parameters passed before, so please make sure that it is NOT already contained in that!
fitQuality	FitQuality which describes this TrackParticleBase. Will be owned by this TrackParticleBase.

Warning: You MUST pass in a valid 'definingParameter' and this 'definingParameter' must NOT be part of the std::vector<const TrackParameters*> passed.

Definition at line 34 of file TrackParticleBase.cxx.

        :
        m_originalTrack(),
        m_trackParticleOrigin( trkPrtOrigin  ),
        m_elVxCandidate(),
        m_trackParameters( parameters ),
        m_trackSummary( trkSummary ),
        m_fitQuality(fitQuality)
    {
      #ifdef DEBUG_CTOR_DTOR
      std::cout<<"TrackParticleBase ctr :"<<this<<std::endl;
      #endif
 
    // if no vxCandidate set, then trkPrtOrigin should be NoVtx
        assert ((vxCandidate!=nullptr)||(trkPrtOrigin==NoVtx));
 
    // Defining parameter is always last.
        m_trackParameters.push_back(definingParameter);
 
    // establish element links
        if (trk!=nullptr)
    {
      m_originalTrack.setElement(trk);
      m_trackInfo = trk->info();
    }
        if (vxCandidate!=nullptr) { m_elVxCandidate.setElement(vxCandidate);
}
    }

◆ TrackParticleBase() [3/4]

Trk::TrackParticleBase::TrackParticleBase	(	const ElementLink< TrackCollection > &	trackLink,
		const Trk::TrackParticleOrigin	trkPrtOrigin,
		const ElementLink< VxContainer > &	vxCandidate,
		std::unique_ptr< Trk::TrackSummary >	trkSummary,
		std::vector< const Trk::TrackParameters * > &&	parameters,
		std::unique_ptr< Trk::FitQuality >	fitQuality,
		const TrackInfo &	info )

Definition at line 69 of file TrackParticleBase.cxx.

        :
        m_originalTrack(trackLink),
        m_trackParticleOrigin( trkPrtOrigin  ),
        m_elVxCandidate(vxCandidate),
        m_trackParameters( std::move(parameters) ),
        m_trackSummary( trkSummary.release() ),
        m_fitQuality(fitQuality.release()),
        m_trackInfo (info)
    {
      // if no vxCandidate set, then trkPrtOrigin should be NoVtx
      assert (!vxCandidate.isDefault() || trkPrtOrigin==NoVtx);
    }

◆ TrackParticleBase() [4/4]

Trk::TrackParticleBase::TrackParticleBase ( const TrackParticleBase & rhs )

Copy constructor.

Copy Constructor.

Definition at line 92 of file TrackParticleBase.cxx.

        :
        m_originalTrack(rhs.m_originalTrack),
        m_trackParticleOrigin(rhs.m_trackParticleOrigin),
        m_elVxCandidate(rhs.m_elVxCandidate),
        m_trackParameters(),
        m_trackSummary( (rhs.m_trackSummary) ? new TrackSummary(*(rhs.m_trackSummary)) : nullptr ),
        m_fitQuality( (rhs.m_fitQuality) ? new FitQuality(*(rhs.m_fitQuality)) : nullptr ),
    m_trackInfo(rhs.m_trackInfo)
    {
 
        #ifdef DEBUG_CTOR_DTOR
        std::cout<<"TrackParticleBase copy ctr :"<<this<<std::endl;
        #endif
 
        std::vector<const TrackParameters*>::const_iterator it    = rhs.m_trackParameters.begin();
        std::vector<const TrackParameters*>::const_iterator itEnd = rhs.m_trackParameters.end();
        for (; it!=itEnd; ++it) { m_trackParameters.push_back( (*it)->clone() );
}
    }

◆ ~TrackParticleBase()

Trk::TrackParticleBase::~TrackParticleBase ( )

virtual

Destructor.

Definition at line 176 of file TrackParticleBase.cxx.

                                          {
        #ifdef DEBUG_CTOR_DTOR
        std::cout<<"TrackParticleBase dtor :"<<this<<std::endl;
        #endif
        std::vector<const TrackParameters*>::const_iterator it    = m_trackParameters.begin();
        std::vector<const TrackParameters*>::const_iterator itEnd = m_trackParameters.end();
        for (; it!=itEnd; ++it) { delete (*it);
}
        if (m_trackSummary!=nullptr) { delete m_trackSummary;
}
        if (m_fitQuality  !=nullptr) { delete m_fitQuality;
}
    }

Member Function Documentation

◆ charge()

double Trk::TrackParticleBase::charge ( void ) const

inline

Return charge of the particle.

Returns: The charge of the particle is calculated via the TrackParameters::charge() method. It is calculated via the sign of the track parameters \( \frac{q_0}{p} \).

Definition at line 200 of file TrackParticleBase.h.

  {
    return definingParameters().charge();
  }

◆ definingParameters()

const TrackParameters & Trk::TrackParticleBase::definingParameters ( ) const

inline

Returns the 'defining' parameter of this TrackParticle.

Returns: The parameters (from the vector returned by trackParameters() ) which define the charge(), and (in the inherited Rec::TrackParticle, the 4 momentum)

Definition at line 239 of file TrackParticleBase.h.

                                                                            {
    return *( m_trackParameters.back() );
  }

◆ dump() [1/2]

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

virtual

Dump methods to be used by the overloaded stream operator (inheritance!)

Reimplemented in Rec::TrackParticle.

Definition at line 190 of file TrackParticleBase.cxx.

    {
        // DO NOT specificy an output level like MSG::VERBOSE (should be done by the caller)
        sl << "Printing TrackParticle. OriginType: " << this->particleOriginType() << endmsg;
        if (this->trackElementLink()->isValid())
        {
          sl << "The ElementLink<TrackCollection> is valid." << endmsg;
        } else
        {
          sl << "The ElementLink<TrackCollection> is NOT valid." << endmsg;
        }
        if ( this->fitQuality() !=nullptr ) {          sl << * ( this->fitQuality() ) <<endmsg;
}
        if ( this->trackSummary() !=nullptr ) {        sl << * ( this->trackSummary() ) <<endmsg;
}
        // vertex EL should alwasy be there as it is in ESD and AOD
        if ( this->reconstructedVertex() !=nullptr ) { sl << ( this->reconstructedVertex()->recVertex() ) <<endmsg;
}
        const std::vector<const TrackParameters*> trackParameters = this->trackParameters();
        sl << "TrackParticle has " << trackParameters.size() << " track parameters. Printing them:" << endmsg;
        for (const auto *trackParameter : trackParameters)
        {
          sl << (*trackParameter) << endmsg;
        }
    sl<<"TrackInfo inherited from original Track comes below:"<<endmsg;
    sl<<m_trackInfo.dumpInfo();
        return sl;
    }

◆ dump() [2/2]

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

virtual

Reimplemented in Rec::TrackParticle.

Definition at line 219 of file TrackParticleBase.cxx.

    {
        sl << "Printing TrackParticle. OriginType: " << this->particleOriginType() << std::endl;
        if (this->trackElementLink()->isValid())
        {
          sl << "The ElementLink<TrackCollection> is valid." << std::endl;
        } else
        {
          sl << "The ElementLink<TrackCollection> is NOT valid." << std::endl;
        }
        if ( this->fitQuality() !=nullptr ) {          sl << * ( this->fitQuality() ) <<std::endl;
}
        if ( this->trackSummary() !=nullptr ) {        sl << * ( this->trackSummary() ) <<std::endl;
}
        // vertex EL should alwasy be there as it is in ESD and AOD
        if ( this->reconstructedVertex() !=nullptr ) { sl << ( this->reconstructedVertex()->recVertex() ) <<std::endl;
}
        const std::vector<const TrackParameters*> trackParameters = this->trackParameters();
        sl << "TrackParticle has " << trackParameters.size() << " track parameters. Printing them:" << std::endl;
        for (const auto *trackParameter : trackParameters)
        {
          sl << (*trackParameter) << std::endl;
        }
    sl<<"TrackInfo inherited from original Track comes below:"<<std::endl;
    sl<<m_trackInfo.dumpInfo();
        return sl;
    }

◆ fitQuality()

const FitQuality * Trk::TrackParticleBase::fitQuality ( ) const

inline

accessor function for FitQuality.

Returns: The pointer to the FitQuality for this class. Can be 0 if object was created with no FitQuality.

Todo: Is this correct? Is it valid to have a TPB with no FQ?

Definition at line 259 of file TrackParticleBase.h.

                                                               {
    return m_fitQuality;
  }

◆ info()

const TrackInfo & Trk::TrackParticleBase::info ( ) const

inline

returns the info of the track.

Definition at line 276 of file TrackParticleBase.h.

  {
    return m_trackInfo;
  }

◆ operator=() [1/2]

TrackParticleBase & Trk::TrackParticleBase::operator= ( const TrackParticleBase & rhs )

Assignement operator.

Assignment operator.

Definition at line 116 of file TrackParticleBase.cxx.

    {
        if (this!=&rhs)
        {
    // only delete objects where these two pointers point to
    // the other pointers point to objects in storegate
            if (m_trackSummary!=nullptr) { delete m_trackSummary; m_trackSummary = nullptr; }
            if (m_fitQuality  !=nullptr) { delete m_fitQuality  ; m_fitQuality   = nullptr; }
            std::vector<const TrackParameters*>::const_iterator it    = m_trackParameters.begin();
            std::vector<const TrackParameters*>::const_iterator itEnd = m_trackParameters.end();
            for (; it!=itEnd; ++it) { delete (*it);
            }
 
            m_originalTrack             =   rhs.m_originalTrack;
            m_trackParticleOrigin       =   rhs.m_trackParticleOrigin;
            m_elVxCandidate             =   rhs.m_elVxCandidate;
 
            //the following are owned, and so must be copied.
            m_trackSummary              =   (rhs.m_trackSummary) ? new TrackSummary(*(rhs.m_trackSummary)) : nullptr;
            m_fitQuality                =   (rhs.m_fitQuality) ? new FitQuality(*(rhs.m_fitQuality)) : nullptr;
            m_trackInfo                 =    rhs.m_trackInfo;
 
            it    = rhs.m_trackParameters.begin();
            itEnd = rhs.m_trackParameters.end();
            for (; it!=itEnd; ++it) { m_trackParameters.push_back( (*it)->clone() );
            }
        }
        return *this;
    }

◆ operator=() [2/2]

TrackParticleBase & Trk::TrackParticleBase::operator= ( TrackParticleBase && rhs )

noexcept

Definition at line 147 of file TrackParticleBase.cxx.

    {
      if (this != &rhs) {
        delete m_trackSummary;
        m_trackSummary = rhs.m_trackSummary;
        rhs.m_trackSummary = nullptr;
 
        delete m_fitQuality;
        m_fitQuality = rhs.m_fitQuality;
        rhs.m_fitQuality = nullptr;
 
        for (const TrackParameters* p : m_trackParameters) {
          delete p;
        }
 
        m_trackParameters = std::move(rhs.m_trackParameters);
 
        m_originalTrack = rhs.m_originalTrack;
        m_trackParticleOrigin = rhs.m_trackParticleOrigin;
        m_elVxCandidate = rhs.m_elVxCandidate;
 
        m_trackInfo = rhs.m_trackInfo;
      }
      return *this;
    }

◆ originalTrack()

const Track * Trk::TrackParticleBase::originalTrack ( ) const

inline

Return pointer to associated track.

Returns: a pointer to the Track with which the particle was created. Right now it is also possible to create a particle without a track (or possibly the Track is not accessible). In that case the method returns 0.

Definition at line 205 of file TrackParticleBase.h.

  {
    if (m_originalTrack.isValid()){
      return *m_originalTrack;
    } 
      return nullptr;
    
  }

◆ particleOriginType()

TrackParticleOrigin Trk::TrackParticleBase::particleOriginType ( ) const

inline

Get the particle origin type.

Returns: A TrackParticleOrigin enum (see TrkEventPrimitives/VertexType.h for definitions)

Definition at line 235 of file TrackParticleBase.h.

                                                                         {
    return m_trackParticleOrigin;
  }

◆ perigee()

const Perigee * Trk::TrackParticleBase::perigee ( ) const

inline

Attempts to cast the definingParameters() to Perigee.

The result is not cached, so there will be a (small) time penalty each time you call this.

Returns: Perigee* if the cast was successful, zero if not

Definition at line 263 of file TrackParticleBase.h.

  {
    return dynamic_cast<const Perigee*>( &(definingParameters()) );
  }

◆ reconstructedVertex()

const VxCandidate * Trk::TrackParticleBase::reconstructedVertex ( ) const

inline

Get a pointer to the primary vertex.

Returns: Returns a pointer to the primary vertex.

Definition at line 215 of file TrackParticleBase.h.

  {
    if (m_elVxCandidate.isValid()) {
      return *m_elVxCandidate;
    } 
    
      return nullptr;
    
  }

◆ reconstructedVertexLink()

const ElementLink< VxContainer > & Trk::TrackParticleBase::reconstructedVertexLink ( ) const

inline

Definition at line 225 of file TrackParticleBase.h.

  {
    return m_elVxCandidate;
  }

◆ setStorableObject() [1/2]

void Trk::TrackParticleBase::setStorableObject ( const TrackCollection * trackColl )

inline

Definition at line 251 of file TrackParticleBase.h.

                                                                                   {
    m_originalTrack.setStorableObject(*trackColl);
  }

◆ setStorableObject() [2/2]

void Trk::TrackParticleBase::setStorableObject ( const VxContainer * vxColl )

inline

Definition at line 255 of file TrackParticleBase.h.

                                                                            {
    m_elVxCandidate.setStorableObject(*vxColl);
  }

◆ setTrackLink()

void Trk::TrackParticleBase::setTrackLink	(	const TrackCollection *	cont,
		const Track *	track )

inline

Definition at line 269 of file TrackParticleBase.h.

  {
     if ( m_originalTrack.isValid() ) { m_originalTrack.reset();
}
     m_originalTrack.toContainedElement( *cont, track);
  }

◆ trackElementLink()

const ElementLink< TrackCollection > * Trk::TrackParticleBase::trackElementLink ( ) const

inline

Return the ElementLink to the Track.

Returns: ElementLink<TrackCollection>

This is necessary to force backnavigation from AOD to ESD

Definition at line 230 of file TrackParticleBase.h.

  {
     return &m_originalTrack;
  }

◆ trackParameters()

const std::vector< const TrackParameters * > & Trk::TrackParticleBase::trackParameters ( ) const

inline

Returns the track parameters.

Returns: The TrackParameters of the TrackParticleBase, expressed at various points through out the detector.

"Various" may seem vague, but it is up to the clients of this class to decide what is needed (Perigee, MuonSpectrometer entrance etc). However, the size of this vector must be at least 1, since ALL TrackParticleBases are required to have ONE defining parameter

Definition at line 243 of file TrackParticleBase.h.

                                                                                           {
    return m_trackParameters;
  }  

◆ trackSummary()

const TrackSummary * Trk::TrackParticleBase::trackSummary ( ) const

inline

accessor function for TrackSummary.

Returns: A pointer to the TrackSummary owned by this object (could be 0)

Definition at line 247 of file TrackParticleBase.h.

                                                                   {
    return m_trackSummary;
  }

◆ ::TrackParticleBaseCnv_p1

friend class ::TrackParticleBaseCnv_p1

friend

Definition at line 160 of file TrackParticleBase.h.

Member Data Documentation

◆ m_elVxCandidate

ElementLink< VxContainer > Trk::TrackParticleBase::m_elVxCandidate

protected

ElementLink to a VxCandidate.

Before writing to disk, should be made valid using setStorableObject(const VxContainer* vxColl)

Definition at line 170 of file TrackParticleBase.h.

◆ m_fitQuality

const FitQuality* Trk::TrackParticleBase::m_fitQuality

protected

the fit quality of this TrackParticle.

Owned by this object.

Definition at line 179 of file TrackParticleBase.h.

◆ m_originalTrack

ElementLink< TrackCollection > Trk::TrackParticleBase::m_originalTrack

protected

ElementLink to the Track used to create this TrackParticleBase object Before writing to disk, should be made valid using setStorableObject(const VxContainer* vxColl).

Definition at line 164 of file TrackParticleBase.h.

◆ m_trackInfo

TrackInfo Trk::TrackParticleBase::m_trackInfo

protected

This is a class which stores the identity of where the track
was created, fitted, which properties the reconstruction had.

Definition at line 186 of file TrackParticleBase.h.

◆ m_trackParameters

std::vector<const TrackParameters*> Trk::TrackParticleBase::m_trackParameters

protected

DataVector of TrackParameters stored inside this TrackParticle.

(This TrackParticleBase owns all the TrackParameters, and will delete them in the destructor)

Definition at line 173 of file TrackParticleBase.h.

◆ m_trackParticleOrigin

TrackParticleOrigin Trk::TrackParticleBase::m_trackParticleOrigin

protected

specifies the origin type of the particle (prim.vertex, ...)

Definition at line 167 of file TrackParticleBase.h.

◆ m_trackSummary

const TrackSummary* Trk::TrackParticleBase::m_trackSummary

protected

the summary of this TrackParticle.

Owned by this object.

Definition at line 176 of file TrackParticleBase.h.

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

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TrackParticleBase() [1/4]

◆ TrackParticleBase() [2/4]

◆ TrackParticleBase() [3/4]

◆ TrackParticleBase() [4/4]

◆ ~TrackParticleBase()

Member Function Documentation

◆ charge()

◆ definingParameters()

◆ dump() [1/2]

◆ dump() [2/2]

◆ fitQuality()

◆ info()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ originalTrack()

◆ particleOriginType()

◆ perigee()

◆ reconstructedVertex()

◆ reconstructedVertexLink()

◆ setStorableObject() [1/2]

◆ setStorableObject() [2/2]

◆ setTrackLink()

◆ trackElementLink()

◆ trackParameters()

◆ trackSummary()

Friends And Related Symbol Documentation

◆ ::TrackParticleBaseCnv_p1

Member Data Documentation

◆ m_elVxCandidate

◆ m_fitQuality

◆ m_originalTrack

◆ m_trackInfo

◆ m_trackParameters

◆ m_trackParticleOrigin

◆ m_trackSummary