Track candidate – seed values and indices. More...

#include <TrackCand.h>

Inheritance diagram for genfit::TrackCand:

Collaboration diagram for genfit::TrackCand:

Public Member Functions
	TrackCand ()

	~TrackCand ()

	TrackCand (const TrackCand &other)
	copy constructor

TrackCand &	operator= (TrackCand other)
	assignment operator

void	swap (TrackCand &other)

TrackCandHit *	getHit (int i) const

void	getHit (int i, int &detId, int &hitId) const
	Get detector Id and hit Id for hit number i.

void	getHit (int i, int &detId, int &hitId, double &sortingParameter) const
	Get detector Id, hit Id and sorting parameter for hit number i.

void	getHitWithPlane (int i, int &detId, int &hitId, int &planeId) const
	Get detector Id, hit Id and plane id for hit number i.

unsigned int	getNHits () const

std::vector< int >	getHitIDs (int detId=-2) const
	Get hit ids of from a specific detector.

std::vector< int >	getDetIDs () const
	Get detector IDs of all hits.

std::vector< double >	getSortingParameters () const
	Get sorting parameterts of all hits.

std::set< int >	getUniqueDetIDs () const

int	getMcTrackId () const
	Get the MCT track id, for MC simulations - default value = -1.

TVector3	getPosSeed () const
	get the seed value for track: pos. Identical to the first 3 components of getStateSeed

TVector3	getMomSeed () const
	get the seed value for track: mom. Identical to the last 3 components of getStateSeed

void	setCovSeed (const TMatrixDSym &cov6D)
	set the covariance matrix seed (6D).

const TMatrixDSym &	getCovSeed () const
	get the covariance matrix seed (6D).

const TVectorD &	getStateSeed () const
	Returns the 6D seed state; should be in global coordinates.

double	getChargeSeed () const

int	getPdgCode () const
	Get the PDG code.

bool	hitInTrack (int detId, int hitId) const
	Is there a hit with detId and hitId in the TrackCand?

void	addHit (int detId, int hitId, int planeId=-1, double sortingParameter=0)

void	addHit (TrackCandHit *hit)

void	setMcTrackId (int i)
	Set the MCT track id, for MC simulations.

void	setPdgCode (int pdgCode)
	Set a particle hypothesis in form of a PDG code. This will also set the charge attribute.

void	append (const TrackCand &)
	Clone the TrackCandHit objects from the other TrackCand and append them to this TrackCand.

void	sortHits ()
	Sort the hits that were already added to the trackCand using the sorting parameters.

void	sortHits (const std::vector< unsigned int > &indices)

void	reset ()
	Delete and clear the TrackCandHits.

void	Print (const Option_t *="") const
	Write the content of all private attributes to the terminal.

void	set6DSeed (const TVectorD &state6D, const double charge)
	sets the state to seed the track fitting. State has to be a TVectorD(6). First 3 elements are the staring postion second 3 elements the starting momentum. Everything in global coordinates charge is the charge hypotheses of the particle charge

void	set6DSeedAndPdgCode (const TVectorD &state6D, const int pdgCode)
	This function works the same as set6DSeed but instead of a charge hypothesis you can set a pdg code which will set the charge automatically.

void	setPosMomSeed (const TVector3 &pos, const TVector3 &mom, const double charge)
	sets the state to seed the track fitting. State has to be a TVector3 for position and a TVector3 for momentum. Everything in global coordinates charge is the charge hypotheses of the particle charge

void	setPosMomSeedAndPdgCode (const TVector3 &pos, const TVector3 &mom, const int pdgCode)
	This function works the same as setPosMomSeed but instead of a charge hypothesis you can set a pdg code which will set the charge automatically.

Static Public Member Functions
static bool	compareTrackCandHits (const TrackCandHit lhs, const TrackCandHit rhs)

Private Attributes
std::vector< TrackCandHit * >	hits_

int	mcTrackId_

int	pdg_

TVectorD	state6D_

TMatrixDSym	cov6D_

double	q_

Friends
bool	operator== (const TrackCand &lhs, const TrackCand &rhs)
	== operator checks equality of TrackCandHits. Does not check for sorting parameters.

bool	operator!= (const TrackCand &lhs, const TrackCand &rhs)

Detailed Description

Track candidate – seed values and indices.

Author: Christian Höppner (Technische Universität München, original author); Sebastian Neubert (Technische Universität München, original author); Moritz Nadler (maintainer during 2012)

The main task of the TrackCand object is to store a list of indices to cluster objects. Each cluster in the Track is identified by it's detector ID and it's index in the corresponding TClonesArray. Also there is a ordering parameter to order hits. Optionally, plane indices for the hits can be stored (most importantly for fitting with the Daf). This information is used by the RecoHitFactory to automatically load RecoHits into a Track. Through this it is possible to define Tracks over an arbitrary number of different detectors.

In addition TrackCand offers members to store starting values for the fit. The starting values (seeds) for the fit are stored as a 6D state (x,y,z,px,py,pz) and its corresponding 6x6 covariance matrix. All seed getter and setter manipulate these two members but the user can chose using TVector3 or TMatrixD to get/set the seed state. However this information is not automatically used in genfit. But a pointer to a TrackCand can be passed to the a RKTrackRep constructor to make use of this information without manually extracting it from the TrackCand object.

See also: RecoHitFactory

Definition at line 69 of file TrackCand.h.

Constructor & Destructor Documentation

◆ TrackCand() [1/2]

genfit::TrackCand::TrackCand ( )

Definition at line 31 of file TrackCand.cc.

                     :
  mcTrackId_(-1),
  pdg_(0),
  state6D_(6),
  cov6D_(6),
  q_(0)
{
  ;
}

◆ ~TrackCand()

genfit::TrackCand::~TrackCand ( )

Definition at line 41 of file TrackCand.cc.

                      {
  for (unsigned int i=0; i<hits_.size(); ++i) {
    delete hits_[i];
  }
  hits_.clear();
}

◆ TrackCand() [2/2]

genfit::TrackCand::TrackCand ( const TrackCand & other )

copy constructor

Definition at line 49 of file TrackCand.cc.

                                             :
  TObject(other),
  mcTrackId_(other.mcTrackId_),
  pdg_(0),
  state6D_(other.state6D_),
  cov6D_(other.cov6D_),
  q_(other.q_)
{
  // deep copy
  hits_.reserve(other.hits_.size());
  for (unsigned int i=0; i<other.hits_.size(); ++i) {
    hits_.push_back( (other.hits_[i])->clone() );
  }
 
  if (other.pdg_ != 0)
    setPdgCode(other.pdg_);
}

Member Function Documentation

◆ addHit() [1/2]

void genfit::TrackCand::addHit	(	int	detId,
		int	hitId,
		int	planeId = `-1`,
		double	sortingParameter = `0`
	)

Definition at line 122 of file TrackCand.cc.

{
  hits_.push_back(new TrackCandHit(detId, hitId, planeId, sortingParameter));
}

◆ addHit() [2/2]

void genfit::TrackCand::addHit ( TrackCandHit * hit )

inline

Definition at line 148 of file TrackCand.h.

148{hits_.push_back(hit);}

◆ append()

void genfit::TrackCand::append ( const TrackCand & rhs )

Clone the TrackCandHit objects from the other TrackCand and append them to this TrackCand.

Definition at line 210 of file TrackCand.cc.

                                          {
  for(unsigned int i=0; i<rhs.getNHits(); ++i){
    addHit(rhs.getHit(i)->clone());
  }
}

◆ compareTrackCandHits()

static bool genfit::TrackCand::compareTrackCandHits	(	const TrackCandHit *	lhs,
		const TrackCandHit *	rhs
	)

inlinestatic

Definition at line 89 of file TrackCand.h.

89{return (*lhs < *rhs);} // operator< defined in TrackCandHit.h

◆ getChargeSeed()

double genfit::TrackCand::getChargeSeed ( ) const

inline

Definition at line 136 of file TrackCand.h.

136{return q_;}

◆ getCovSeed()

const TMatrixDSym & genfit::TrackCand::getCovSeed ( ) const

inline

get the covariance matrix seed (6D).

Definition at line 131 of file TrackCand.h.

131{return cov6D_;}

◆ getDetIDs()

std::vector< int > genfit::TrackCand::getDetIDs ( ) const

Get detector IDs of all hits.

Definition at line 137 of file TrackCand.cc.

                                          {
  std::vector<int> result;
  for(unsigned int i=0; i<hits_.size(); ++i){
    result.push_back(hits_[i]->getDetId());
  }
  return result;
}

◆ getHit() [1/3]

TrackCandHit * genfit::TrackCand::getHit ( int i ) const

Definition at line 85 of file TrackCand.cc.

                                           {
  if (i < 0)
    i += hits_.size();
 
  return hits_.at(i);
}

◆ getHit() [2/3]

void genfit::TrackCand::getHit	(	int	i,
		int &	detId,
		int &	hitId
	)		const

Get detector Id and hit Id for hit number i.

Definition at line 93 of file TrackCand.cc.

                                                          {
  if (i < 0)
    i += hits_.size();
 
  detId = hits_.at(i)->getDetId();
  hitId = hits_[i]->getHitId();
}

◆ getHit() [3/3]

void genfit::TrackCand::getHit	(	int	i,
		int &	detId,
		int &	hitId,
		double &	sortingParameter
	)		const

Get detector Id, hit Id and sorting parameter for hit number i.

Definition at line 102 of file TrackCand.cc.

                                                                                    {
  if (i < 0)
    i += hits_.size();
 
  detId = hits_.at(i)->getDetId();
  hitId = hits_[i]->getHitId();
  sortingParameter = hits_[i]->getSortingParameter();
}

◆ getHitIDs()

std::vector< int > genfit::TrackCand::getHitIDs ( int detId = -2 ) const

Get hit ids of from a specific detector.

DetId -1 gives hitIds of hits with default detId -1. The default argument -2 gives hit Ids of all hits.

Definition at line 127 of file TrackCand.cc.

                                                   {
  std::vector<int> result;
  for(unsigned int i=0; i<hits_.size(); ++i){
    if(detId==-2 || hits_[i]->getDetId() == detId) {
      result.push_back(hits_[i]->getHitId());
    }
  }
  return result;
}

◆ getHitWithPlane()

void genfit::TrackCand::getHitWithPlane	(	int	i,
		int &	detId,
		int &	hitId,
		int &	planeId
	)		const

Get detector Id, hit Id and plane id for hit number i.

Definition at line 112 of file TrackCand.cc.

                                                                                 {
  if (i < 0)
    i += hits_.size();
 
  detId = hits_.at(i)->getDetId();
  hitId = hits_[i]->getHitId();
  planeId = hits_[i]->getPlaneId();
}

◆ getMcTrackId()

int genfit::TrackCand::getMcTrackId ( ) const

inline

Get the MCT track id, for MC simulations - default value = -1.

Definition at line 119 of file TrackCand.h.

119{return mcTrackId_;}

◆ getMomSeed()

TVector3 genfit::TrackCand::getMomSeed ( ) const

inline

get the seed value for track: mom. Identical to the last 3 components of getStateSeed

Definition at line 125 of file TrackCand.h.

125{return TVector3(state6D_(3), state6D_(4), state6D_(5));}

◆ getNHits()

unsigned int genfit::TrackCand::getNHits ( ) const

inline

Definition at line 103 of file TrackCand.h.

103{return hits_.size();}

◆ getPdgCode()

int genfit::TrackCand::getPdgCode ( ) const

inline

Get the PDG code.

Definition at line 139 of file TrackCand.h.

139{return pdg_;}

◆ getPosSeed()

TVector3 genfit::TrackCand::getPosSeed ( ) const

inline

get the seed value for track: pos. Identical to the first 3 components of getStateSeed

Definition at line 122 of file TrackCand.h.

122{return TVector3(state6D_(0), state6D_(1), state6D_(2));}

◆ getSortingParameters()

std::vector< double > genfit::TrackCand::getSortingParameters ( ) const

Get sorting parameterts of all hits.

Definition at line 145 of file TrackCand.cc.

                                                        {
  std::vector<double> result;
  for(unsigned int i=0; i<hits_.size(); ++i){
    result.push_back(hits_[i]->getSortingParameter());
  }
  return result;
}

◆ getStateSeed()

const TVectorD & genfit::TrackCand::getStateSeed ( ) const

inline

Returns the 6D seed state; should be in global coordinates.

Definition at line 134 of file TrackCand.h.

134{return state6D_;}

◆ getUniqueDetIDs()

std::set< int > genfit::TrackCand::getUniqueDetIDs ( ) const

Definition at line 153 of file TrackCand.cc.

                                             {
  std::set<int> retVal;
  for (unsigned int i = 0; i < hits_.size(); ++i) {
    retVal.insert(hits_[i]->getDetId());
  }
  return retVal;
}

◆ hitInTrack()

bool genfit::TrackCand::hitInTrack	(	int	detId,
		int	hitId
	)		const

Is there a hit with detId and hitId in the TrackCand?

Definition at line 178 of file TrackCand.cc.

{
  for (unsigned int i = 0; i < hits_.size(); ++i){
    if (detId == hits_[i]->getDetId() && hitId == hits_[i]->getHitId())
      return true;
  }
  return false;
}

◆ operator=()

TrackCand & genfit::TrackCand::operator= ( TrackCand other )

assignment operator

Definition at line 67 of file TrackCand.cc.

                                               {
  swap(other);
  return *this;
}

◆ Print()

void genfit::TrackCand::Print ( const Option_t * option = "" ) const

Write the content of all private attributes to the terminal.

Definition at line 197 of file TrackCand.cc.

                                                  {
  std::cout << "======== TrackCand::print ========\n";
  std::cout << "mcTrackId=" << mcTrackId_ << "\n";
  std::cout << "seed values for 6D state: \n";
  state6D_.Print(option);
  std::cout << "q" << q_ << "\n";
  std::cout << "PDG code= " << pdg_ << "\n";
  for(unsigned int i=0; i<hits_.size(); ++i){
    hits_[i]->Print();
  }
}

◆ reset()

void genfit::TrackCand::reset ( )

Delete and clear the TrackCandHits.

Definition at line 169 of file TrackCand.cc.

{
  for (unsigned int i=0; i<hits_.size(); ++i) {
    delete hits_[i];
  }
  hits_.clear();
}

◆ set6DSeed()

void genfit::TrackCand::set6DSeed	(	const TVectorD &	state6D,
		const double	charge
	)

sets the state to seed the track fitting. State has to be a TVectorD(6). First 3 elements are the staring postion second 3 elements the starting momentum. Everything in global coordinates charge is the charge hypotheses of the particle charge

Definition at line 241 of file TrackCand.cc.

                                                                      {
  if (pdg_ != 0 && q_ != charge)
    pdg_ = -pdg_;
  q_ = charge;
  state6D_ = state6D;
}

◆ set6DSeedAndPdgCode()

void genfit::TrackCand::set6DSeedAndPdgCode	(	const TVectorD &	state6D,
		const int	pdgCode
	)

This function works the same as set6DSeed but instead of a charge hypothesis you can set a pdg code which will set the charge automatically.

Definition at line 248 of file TrackCand.cc.

                                                                              {
  setPdgCode(pdgCode);
  state6D_ = state6D;
}

◆ setCovSeed()

void genfit::TrackCand::setCovSeed ( const TMatrixDSym & cov6D )

inline

set the covariance matrix seed (6D).

Definition at line 128 of file TrackCand.h.

128{cov6D_ = cov6D; /* always 6D, no need to resize */}

◆ setMcTrackId()

void genfit::TrackCand::setMcTrackId ( int i )

inline

Set the MCT track id, for MC simulations.

Definition at line 151 of file TrackCand.h.

151{mcTrackId_ = i;}

◆ setPdgCode()

void genfit::TrackCand::setPdgCode ( int pdgCode )

Set a particle hypothesis in form of a PDG code. This will also set the charge attribute.

Definition at line 162 of file TrackCand.cc.

                                      {
  pdg_ = pdgCode;
  TParticlePDG* part = TDatabasePDG::Instance()->GetParticle(pdg_);
  q_ = part->Charge() / (3.);
}

◆ setPosMomSeed()

void genfit::TrackCand::setPosMomSeed	(	const TVector3 &	pos,
		const TVector3 &	mom,
		const double	charge
	)

sets the state to seed the track fitting. State has to be a TVector3 for position and a TVector3 for momentum. Everything in global coordinates charge is the charge hypotheses of the particle charge

Definition at line 253 of file TrackCand.cc.

                                                                                           {
  if (pdg_ != 0 && q_ != charge)
    pdg_ = -pdg_;
  q_ = charge;
  state6D_[0] = pos[0];  state6D_[1] = pos[1];  state6D_[2] = pos[2];
  state6D_[3] = mom[0];  state6D_[4] = mom[1];  state6D_[5] = mom[2];
}

◆ setPosMomSeedAndPdgCode()

void genfit::TrackCand::setPosMomSeedAndPdgCode	(	const TVector3 &	pos,
		const TVector3 &	mom,
		const int	pdgCode
	)

This function works the same as setPosMomSeed but instead of a charge hypothesis you can set a pdg code which will set the charge automatically.

Definition at line 261 of file TrackCand.cc.

                                                                                                   {
  setPdgCode(pdgCode);
  state6D_[0] = pos[0];  state6D_[1] = pos[1];  state6D_[2] = pos[2];
  state6D_[3] = mom[0];  state6D_[4] = mom[1];  state6D_[5] = mom[2];
}

◆ sortHits() [1/2]

void genfit::TrackCand::sortHits ( )

Sort the hits that were already added to the trackCand using the sorting parameters.

Definition at line 217 of file TrackCand.cc.

                        {
  std::stable_sort(hits_.begin(), hits_.end(), compareTrackCandHits);
}

◆ sortHits() [2/2]

void genfit::TrackCand::sortHits ( const std::vector< unsigned int > & indices )

Definition at line 222 of file TrackCand.cc.

                                                              {
 
  const unsigned int nHits(getNHits());
  if (indices.size() != nHits){
    abort();
    Exception exc("TrackCand::sortHits ==> Size of indices != number of hits!",__LINE__,__FILE__);
    throw exc;
  }
 
  //these containers will hold the sorted results. They are created to avoid probably slower in-place sorting
  std::vector<TrackCandHit*> sortedHits(nHits);
  for (unsigned int i=0; i<nHits; ++i){
    sortedHits[i] = hits_[indices[i]];
  }
  //write the changes back to the private data members:
  hits_ = sortedHits;
}

◆ swap()

void genfit::TrackCand::swap ( TrackCand & other )

Definition at line 73 of file TrackCand.cc.

                                     {
  // by swapping the members of two classes,
  // the two classes are effectively swapped
  std::swap(this->hits_, other.hits_);
  std::swap(this->mcTrackId_, other.mcTrackId_);
  std::swap(this->pdg_, other.pdg_);
  std::swap(this->state6D_, other.state6D_);
  std::swap(this->cov6D_, other.cov6D_);
  std::swap(this->q_, other.q_);
}

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const TrackCand &	lhs,
		const TrackCand &	rhs
	)

friend

Definition at line 87 of file TrackCand.h.

87{return !(lhs == rhs);}

◆ operator==

bool operator==	(	const TrackCand &	lhs,
		const TrackCand &	rhs
	)

friend

== operator checks equality of TrackCandHits. Does not check for sorting parameters.

Definition at line 188 of file TrackCand.cc.

                                                            {
  if(lhs.getNHits() != rhs.getNHits()) return false;
  for (unsigned int i = 0; i < lhs.getNHits(); ++i){
    if (lhs.getHit(i) != rhs.getHit(i)) return false;
  }
  return true;
}

Member Data Documentation

◆ cov6D_

TMatrixDSym genfit::TrackCand::cov6D_

private

global 6D position plus momentum state

Definition at line 199 of file TrackCand.h.

◆ hits_

std::vector<TrackCandHit*> genfit::TrackCand::hits_

private

Definition at line 193 of file TrackCand.h.

◆ mcTrackId_

int genfit::TrackCand::mcTrackId_

private

if MC simulation, store the mc track id here

Definition at line 195 of file TrackCand.h.

◆ pdg_

int genfit::TrackCand::pdg_

private

particle data groupe's id for a particle

Definition at line 196 of file TrackCand.h.

◆ q_

double genfit::TrackCand::q_

private

the charge of the particle in units of elementary charge

Definition at line 200 of file TrackCand.h.

◆ state6D_

TVectorD genfit::TrackCand::state6D_

private

global 6D position plus momentum state

Definition at line 198 of file TrackCand.h.

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

genfit/core/include/TrackCand.h
genfit/core/src/TrackCand.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TrackCand() [1/2]

◆ ~TrackCand()

◆ TrackCand() [2/2]

Member Function Documentation

◆ addHit() [1/2]

◆ addHit() [2/2]

◆ append()

◆ compareTrackCandHits()

◆ getChargeSeed()

◆ getCovSeed()

◆ getDetIDs()

◆ getHit() [1/3]

◆ getHit() [2/3]

◆ getHit() [3/3]

◆ getHitIDs()

◆ getHitWithPlane()

◆ getMcTrackId()

◆ getMomSeed()

◆ getNHits()

◆ getPdgCode()

◆ getPosSeed()

◆ getSortingParameters()

◆ getStateSeed()

◆ getUniqueDetIDs()

◆ hitInTrack()

◆ operator=()

◆ Print()

◆ reset()

◆ set6DSeed()

◆ set6DSeedAndPdgCode()

◆ setCovSeed()

◆ setMcTrackId()

◆ setPdgCode()

◆ setPosMomSeed()

◆ setPosMomSeedAndPdgCode()

◆ sortHits() [1/2]

◆ sortHits() [2/2]

◆ swap()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator==

Member Data Documentation

◆ cov6D_

◆ hits_

◆ mcTrackId_

◆ pdg_

◆ q_

◆ state6D_