RaveVertexFitter Class Reference

The RaveVertexFitter class is part of the RaveInterface together with RaveSetup. More...

#include <RaveVertexFitter.h>

Collaboration diagram for RaveVertexFitter:

Public Member Functions
	RaveVertexFitter ()
	The constructor.
	~RaveVertexFitter ()
	Destructor.
void	addTrack (const Particle *const aParticlePtr)
	add a track (in the format of a Belle2::Particle) to set of tracks that should be fitted to a vertex
void	addTrack (const TrackFitResult *const aTrackPtr)
	add a track (in the format of a pointer to a Belle2::TrackFitResult) to set of tracks that should be fitted to a vertex
void	addMother (const Particle *const aMotherParticlePtr)
	All daughters of the argument of this function will be used as input for the vertex fit.
int	fit (std::string options="default")
	do the vertex fit with all tracks previously added with the addTrack or addMother function.
B2Vector3D	getPos (VecSize vertexId=0) const
	get the position of the fitted vertex.
double	getPValue (VecSize vertexId=0) const
	get the p value of the fitted vertex.
double	getNdf (VecSize vertexId=0) const
	get the number of degrees of freedom (NDF) of the fitted vertex.
double	getChi2 (VecSize vertexId=0) const
	get the χ² of the fitted vertex.
TMatrixDSym	getCov (VecSize vertexId=0) const
	get the covariance matrix (3x3) of the of the fitted vertex position.
double	getWeight (int trackId, VecSize vertexId=0) const
	get the weight Rave assigned to a specific input track.
std::vector< int >	getTrackIdsForOneVertex (VecSize vertexId=0) const
	get the ids of the tracks Rave associated with a specific vertex.
void	useBeamSpot (bool beamSpot=true)
	Overwrite the global option in ReveSetup that tells the fitter if beam spot info should be used or not.
void	clearTracks ()
	Delete all information of previously added tracks and fitted results.
void	Print () const
	Print all attributes of this object to terminal.
int	getNTracks () const
	return the number of tracks that where added via addTrack or addMother
void	updateDaughters ()
	update the Daughters particles

Protected Member Functions
void	initBeamSpotMember ()
	Initialize m_useBeamSpot.
void	isVertexIdValid (const VecSize vertexId) const
	checks if the vertex the user requested via one of the getters it actually there
rave::Track	TrackFitResultToRaveTrack (const TrackFitResult *const aTrackPtr) const
	converts a track from Belle2::TrackFitResult format to rave::Track format

Protected Attributes
bool	m_useBeamSpot
	flag determines if the beam spot will be used or not.
std::vector< rave::Track >	m_raveTracks
	holds the tracks that were added to a RaveVertexFitter object in the format used by Rave
std::vector< rave::Vertex >	m_raveVertices
	holds the fitted vertices after fit() was called in the format used by Rave
std::vector< Particle * >	m_belleDaughters
	Belle Particle pointers input.

Private Types
typedef std::vector< int >::size_type	VecSize
	I am using std::vector<int>::size_type because it is the official return value of .size() although on normal machines a ::size_type is just an unsigned int anyway.

Detailed Description

The RaveVertexFitter class is part of the RaveInterface together with RaveSetup.

To fit a vertex the user adds tracks (different formats are supported). Then calls the fit() function where the name of the fitting method and parameters can be passed as a string. RaveVertexFitter provides the getters to extract the results produced by Rave.

Definition at line 36 of file RaveVertexFitter.h.

Member Typedef Documentation

VecSize

typedef std::vector<int>::size_type VecSize

private

I am using std::vector<int>::size_type because it is the official return value of .size() although on normal machines a ::size_type is just an unsigned int anyway.

Because std::vector<int>::size_type is so long it is shortened to VecSize

Definition at line 38 of file RaveVertexFitter.h.

Constructor & Destructor Documentation

RaveVertexFitter()

RaveVertexFitter

(

)

The constructor.

Definition at line 30 of file RaveVertexFitter.cc.

                                  : m_useBeamSpot(false)
{
  //B2WARNING( "RaveVertexFitter::RaveVertexFitter()" );
  if (RaveSetup::getRawInstance() == nullptr) {
    B2FATAL("RaveSetup::initialize was not called. It has to be called before RaveSetup or RaveVertexFitter are used");
  }
  //B2WARNING "m_useBeamSpot " << m_useBeamSpot );
  m_useBeamSpot = RaveSetup::getRawInstance()->m_useBeamSpot;
  //B2WARNING("m_useBeamSpot " << m_useBeamSpot );
}

Member Function Documentation

addMother()

void addMother

(

const Particle *const

aMotherParticlePtr

)

All daughters of the argument of this function will be used as input for the vertex fit.

Definition at line 110 of file RaveVertexFitter.cc.

{
  vector<Particle*> daughters = aMotherParticlePtr->getDaughters();
 
  int nDaughters = daughters.size();
  for (int i = 0; i not_eq nDaughters; ++i) {
    addTrack(daughters[i]);
  }
 
}

addTrack() [1/2]

void addTrack

(

const Particle *const

aParticlePtr

)

add a track (in the format of a Belle2::Particle) to set of tracks that should be fitted to a vertex

Definition at line 87 of file RaveVertexFitter.cc.

{
  const int id = m_raveTracks.size();
  const ROOT::Math::XYZVector& pos = aParticlePtr->getVertex();
  const ROOT::Math::XYZVector& mom = aParticlePtr->getMomentum();
  rave::Vector6D ravestate(pos.X(), pos.Y(), pos.Z(), mom.X(), mom.Y(), mom.Z());
 
  const TMatrixFSym& cov = aParticlePtr->getMomentumVertexErrorMatrix();
 
  rave::Covariance6D ravecov(cov(4, 4), cov(4, 5), cov(4, 6),
                             cov(5, 5), cov(5, 6), cov(6, 6),
                             cov(0, 4), cov(1, 4), cov(2, 4),
                             cov(0, 5), cov(1, 5), cov(2, 5),
                             cov(0, 6), cov(1, 6), cov(2, 6),
                             cov(0, 0), cov(0, 1), cov(0, 2),
                             cov(1, 1), cov(1, 2), cov(2, 2));
 
  // 1 and 1 are dummy values for chi2 and ndf. the are not used for the vertex fit
  m_raveTracks.emplace_back(id, ravestate, ravecov, rave::Charge(aParticlePtr->getCharge() + 0.1), 1, 1);
 
  m_belleDaughters.push_back(const_cast<Particle*>(aParticlePtr));
}

addTrack() [2/2]

void addTrack

(

const TrackFitResult *const

aTrackPtr

)

add a track (in the format of a pointer to a Belle2::TrackFitResult) to set of tracks that should be fitted to a vertex

Definition at line 55 of file RaveVertexFitter.cc.

{
  m_raveTracks.push_back(TrackFitResultToRaveTrack(aTrackPtr));
}

clearTracks()

void clearTracks ( )

inline

Delete all information of previously added tracks and fitted results.

Definition at line 95 of file RaveVertexFitter.h.

      {
        m_raveTracks.clear();
      }

fit()

int fit

(

std::string

options = "default"

)

do the vertex fit with all tracks previously added with the addTrack or addMother function.

The argument is a string determining the Rave fitting method. See https://rave.hepforge.org/trac/wiki/RaveMethods for the different methods The return value is the number of successfully found vertices (depending on the selected algorithm this can be more then one vertex). Return value 0 means the fit was not successful. -1 means not enough tracks were added

Definition at line 121 of file RaveVertexFitter.cc.

{
  //B2WARNING("RaveVertexFitter::fit(string options)" );
  //B2WARNING("m_useBeamSpot " << m_useBeamSpot );
  if (options == "default") {
    options = "kalman";
  }
  int ndf = 0;
 
  ndf = 2 * m_raveTracks.size();
 
  if (m_useBeamSpot == true) {
    ndf += 3;
  }
  if (ndf < 4) {
    return -1;
  }
  int nOfVertices = -100;
 
  if (m_useBeamSpot == true) {
    const B2Vector3D& bsPos = RaveSetup::getRawInstance()->m_beamSpot;
    const TMatrixDSym& bsCov = RaveSetup::getRawInstance()->m_beamSpotCov;
    const rave::Covariance3D bsCovRave(bsCov(0, 0), bsCov(0, 1), bsCov(0, 2), bsCov(1, 1), bsCov(1, 2), bsCov(2, 2));
    RaveSetup::getRawInstance()->m_raveVertexFactory->setBeamSpot(rave::Ellipsoid3D(rave::Point3D(bsPos.X(), bsPos.Y(), bsPos.Z()),
        bsCovRave));
  }
  //B2WARNING( "now fitting with m_raveVertexFactory" );
  RaveSetup::getRawInstance()->m_raveVertexFactory->setDefaultMethod(options);
  m_raveVertices = RaveSetup::getRawInstance()->m_raveVertexFactory->create(m_raveTracks, m_useBeamSpot);
  nOfVertices = m_raveVertices.size();
 
  return nOfVertices;
}

getChi2()

double getChi2

(

VecSize

vertexId = 0

)

const

get the χ² of the fitted vertex.

If Rave was also used to find different vertices the user has to provide the index of that vertex

Definition at line 222 of file RaveVertexFitter.cc.

{
  isVertexIdValid(vertexId);
 
  return m_raveVertices[vertexId].chiSquared();
 
}

getCov()

TMatrixDSym getCov

(

VecSize

vertexId = 0

)

const

get the covariance matrix (3x3) of the of the fitted vertex position.

If Rave was also used to find different vertices the user has to provide the index of that vertex

Definition at line 230 of file RaveVertexFitter.cc.

{
  isVertexIdValid(vertexId);
 
  TMatrixDSym Cov(3);
  Cov(0, 0) = m_raveVertices[vertexId].error().dxx();
  Cov(0, 1) = m_raveVertices[vertexId].error().dxy();
  Cov(0, 2) = m_raveVertices[vertexId].error().dxz();
  Cov(1, 1) = m_raveVertices[vertexId].error().dyy();
  Cov(1, 2) = m_raveVertices[vertexId].error().dyz();
  Cov(2, 2) = m_raveVertices[vertexId].error().dzz();
  Cov(1, 0) = Cov(0, 1);
  Cov(2, 1) = Cov(1, 2);
  Cov(2, 0) = Cov(0, 2);
 
  return Cov;
 
}

getNdf()

double getNdf

(

VecSize

vertexId = 0

)

const

get the number of degrees of freedom (NDF) of the fitted vertex.

If Rave was also used to find different vertices the user has to provide the index of that vertex

Definition at line 214 of file RaveVertexFitter.cc.

{
  isVertexIdValid(vertexId);
 
  return m_raveVertices[vertexId].ndf();
 
}

getNTracks()

int getNTracks ( ) const

inline

return the number of tracks that where added via addTrack or addMother

Definition at line 110 of file RaveVertexFitter.h.

      {
        return m_raveTracks.size();
      }

getPos()

B2Vector3D getPos

(

VecSize

vertexId = 0

)

const

get the position of the fitted vertex.

If Rave was also used to find different vertices the user has to provide the index of that vertex

Definition at line 169 of file RaveVertexFitter.cc.

{
  isVertexIdValid(vertexId);
 
  return B2Vector3D(m_raveVertices[vertexId].position().x(), m_raveVertices[vertexId].position().y(),
                    m_raveVertices[vertexId].position().z());
 
}

getPValue()

double getPValue

(

VecSize

vertexId = 0

)

const

get the p value of the fitted vertex.

If Rave was also used to find different vertices the user has to provide the index of that vertex

Definition at line 206 of file RaveVertexFitter.cc.

{
  isVertexIdValid(vertexId);
 
  return ROOT::Math::chisquared_cdf_c(m_raveVertices[vertexId].chiSquared(), m_raveVertices[vertexId].ndf());
 
}

getTrackIdsForOneVertex()

std::vector< int > getTrackIdsForOneVertex

(

VecSize

vertexId = 0

)

const

get the ids of the tracks Rave associated with a specific vertex.

The trackId is determined by the order of the addTrack calls. So the first track added with addTrack has trackId = 0, the next has 1 etc

Definition at line 194 of file RaveVertexFitter.cc.

{
 
  const std::vector < std::pair < float, rave::Track > >& weightedTracks = m_raveVertices[vertexId].weightedTracks();
  const int n = weightedTracks.size();
  vector<int> trackIds(n);
  for (int i = 0; i not_eq n; ++i) {
    trackIds[i] = weightedTracks[i].second.id();
  }
  return trackIds;
}

getWeight()

double getWeight	(	int	trackId,
		VecSize	vertexId = 0
	)		const

get the weight Rave assigned to a specific input track.

The trackId is determined by the order of the addTrack calls. So the first track added with addTrack has trackId = 0, the next has 1 etc

Definition at line 178 of file RaveVertexFitter.cc.

{
  isVertexIdValid(vertexId);
 
 
  const std::vector < std::pair < float, rave::Track > >& weightedTracks = m_raveVertices[vertexId].weightedTracks();
  for (unsigned int i = 0; i not_eq weightedTracks.size(); ++i) {
    if (weightedTracks[i].second.id() == trackId) {
//          B2WARNING( "returning weight for track with x coord: " <<weightedTracks[i].second.state().x() );
      return weightedTracks[i].first;
    }
  }
  return -1;
 
}

initBeamSpotMember()

void initBeamSpotMember ( )

protected

Initialize m_useBeamSpot.

Called by constructor

Definition at line 41 of file RaveVertexFitter.cc.

{
  m_useBeamSpot = false;
  if (RaveSetup::getRawInstance() == nullptr) {
    B2FATAL("RaveSetup::initialize was not called. It has to be called before RaveSetup or RaveVertexFitter are used");
  }
  m_useBeamSpot = RaveSetup::getRawInstance()->m_useBeamSpot;
}

isVertexIdValid()

void isVertexIdValid ( const VecSize  vertexId ) const

protected

checks if the vertex the user requested via one of the getters it actually there

Definition at line 155 of file RaveVertexFitter.cc.

{
 
  if (m_raveVertices.empty()) {
    B2ERROR("There is no fitted Vertex. Maybe you did not call fit() or maybe the fit was not successful");
    throw;
  }
  if (vertexId >= m_raveVertices.size()) {
    B2ERROR("The Vertex id " << vertexId << " does not correspond to any fitted vertex");
    throw;
  }
 
}

Print()

void Print ( ) const

inline

Print all attributes of this object to terminal.

Definition at line 102 of file RaveVertexFitter.h.

      {
        B2INFO("useBeamSpot: " << m_useBeamSpot);
        B2INFO("number of rave::Tracks: " << m_raveTracks.size());
        B2INFO("number of fitted  rave::Vertices: " << m_raveVertices.size());
 
      }

TrackFitResultToRaveTrack()

rave::Track TrackFitResultToRaveTrack ( const TrackFitResult *const  aTrackPtr ) const

protected

converts a track from Belle2::TrackFitResult format to rave::Track format

Definition at line 60 of file RaveVertexFitter.cc.

{
  const int id = m_raveTracks.size();
 
  B2Vector3D pos = aTrackPtr->getPosition();
  B2Vector3D mom = aTrackPtr->getMomentum();
  TMatrixF cov(aTrackPtr->getCovariance6());
 
 
  // state
  rave::Vector6D ravestate(pos.X(), pos.Y(), pos.Z(),
                           mom.X(), mom.Y(), mom.Z());
 
  rave::Covariance6D ravecov(cov(0, 0), cov(1, 0), cov(2, 0),
                             cov(1, 1), cov(2, 1), cov(2, 2),
                             cov(3, 0), cov(4, 0), cov(5, 0),
                             cov(3, 1), cov(4, 1), cov(5, 1),
                             cov(3, 2), cov(4, 2), cov(5, 2),
                             cov(3, 3), cov(4, 3), cov(5, 3),
                             cov(4, 4), cov(5, 4), cov(5, 5));
 
  return rave::Track(id, ravestate, ravecov, rave::Charge(aTrackPtr->getChargeSign()), 1,
                     1); //the two 1s are just dummy values. They are not used by Rave anyway
 
}

updateDaughters()

void updateDaughters

(

)

update the Daughters particles

Definition at line 250 of file RaveVertexFitter.cc.

{
  if (m_raveVertices.size() != 1) {
    B2ERROR("RaveVertexFitter: Daughters update works only with a single vertex");
    return;
  }
 
  if (!m_raveVertices[0].hasRefittedTracks()) {
    B2WARNING("RaveVertexFitter: Fitted vertex has no refitted tracks");
    return;
  }
 
  std::vector < rave::Track > rTracks = m_raveVertices[0].tracks(); //< the original tracks
 
  for (unsigned int i = 0; i < rTracks.size(); i++) {
    rave::Track rtrk =  m_raveVertices[0].refittedTrack(rTracks[i]);
    const rave::Point3D fittedV = rtrk.position();
    const rave::Vector3D fittedP = rtrk.momentum();
    const rave::Covariance6D& fittedCov = rtrk.error();
 
    ROOT::Math::XYZVector x3(fittedV.x(), fittedV.y(), fittedV.z());
    double fittedE = sqrt(fittedP.mag2() + (m_belleDaughters[i]->getMass() * (m_belleDaughters[i]->getMass())));
    ROOT::Math::PxPyPzEVector p4(fittedP.x(), fittedP.y(), fittedP.z(), fittedE);
 
    TMatrixDSym fitted7CovPart = m_belleDaughters[i]->getMomentumVertexErrorMatrix() ;
 
    //px,py,pz,E,x,y,z
    TMatrixDSym fitted7CovM(7);
    fitted7CovM(0, 0) = fittedCov.dpxpx();    fitted7CovM(0, 0) = fitted7CovM(0, 0);
    fitted7CovM(0, 1) = fittedCov.dpxpy();    fitted7CovM(1, 0) = fitted7CovM(0, 1);
    fitted7CovM(0, 2) = fittedCov.dpxpz();    fitted7CovM(2, 0) = fitted7CovM(0, 2);
    fitted7CovM(0, 3) = fitted7CovPart(0, 3); fitted7CovM(3, 0) = fitted7CovM(0, 3);
    fitted7CovM(0, 4) = fittedCov.dxpx();     fitted7CovM(4, 0) = fitted7CovM(0, 4);
    fitted7CovM(0, 5) = fittedCov.dypx();     fitted7CovM(5, 0) = fitted7CovM(0, 5);
    fitted7CovM(0, 6) = fittedCov.dzpx();     fitted7CovM(6, 0) = fitted7CovM(0, 6);
 
    fitted7CovM(1, 1) = fittedCov.dpypy();    fitted7CovM(1, 1) = fitted7CovM(1, 1);
    fitted7CovM(1, 2) = fittedCov.dpypz();    fitted7CovM(2, 1) = fitted7CovM(1, 2);
    fitted7CovM(1, 3) = fitted7CovPart(1, 3); fitted7CovM(3, 1) = fitted7CovM(1, 3);
    fitted7CovM(1, 4) = fittedCov.dxpy();     fitted7CovM(4, 1) = fitted7CovM(1, 4);
    fitted7CovM(1, 5) = fittedCov.dypy();     fitted7CovM(5, 1) = fitted7CovM(1, 5);
    fitted7CovM(1, 6) = fittedCov.dzpy();     fitted7CovM(6, 1) = fitted7CovM(1, 6);
 
    fitted7CovM(2, 2) = fittedCov.dpzpz();    fitted7CovM(2, 2) = fitted7CovM(2, 2);
    fitted7CovM(2, 3) = fitted7CovPart(2, 3); fitted7CovM(3, 2) = fitted7CovM(2, 3);
    fitted7CovM(2, 4) = fittedCov.dxpz();     fitted7CovM(4, 2) = fitted7CovM(2, 4);
    fitted7CovM(2, 5) = fittedCov.dypz();     fitted7CovM(5, 2) = fitted7CovM(2, 5);
    fitted7CovM(2, 6) = fittedCov.dzpz();     fitted7CovM(6, 2) = fitted7CovM(2, 6);
 
    fitted7CovM(3, 3) = fitted7CovPart(3, 3); fitted7CovM(3, 3) = fitted7CovM(3, 3);
    fitted7CovM(3, 4) = fitted7CovPart(3, 4); fitted7CovM(4, 3) = fitted7CovM(3, 4);
    fitted7CovM(3, 5) = fitted7CovPart(3, 5); fitted7CovM(5, 3) = fitted7CovM(3, 5);
    fitted7CovM(3, 6) = fitted7CovPart(3, 6); fitted7CovM(6, 3) = fitted7CovM(3, 6);
 
    fitted7CovM(4, 4) = fittedCov.dxx();      fitted7CovM(4, 4) = fitted7CovM(4, 4);
    fitted7CovM(4, 5) = fittedCov.dxy();      fitted7CovM(5, 4) = fitted7CovM(4, 5);
    fitted7CovM(4, 6) = fittedCov.dxz();      fitted7CovM(6, 4) = fitted7CovM(4, 6);
 
    fitted7CovM(5, 5) = fittedCov.dyy();      fitted7CovM(5, 5) = fitted7CovM(5, 5);
    fitted7CovM(5, 6) = fittedCov.dyz();      fitted7CovM(6, 5) = fitted7CovM(5, 6);
 
    fitted7CovM(6, 6) = fittedCov.dzz();      fitted7CovM(6, 6) = fitted7CovM(6, 6);
 
 
    float pValDau = m_belleDaughters[i]->getPValue();
 
    m_belleDaughters[i]->updateMomentum(p4, x3, fitted7CovM, pValDau);
 
  }
 
}

useBeamSpot()

void useBeamSpot ( bool  beamSpot = true )

inline

Overwrite the global option in ReveSetup that tells the fitter if beam spot info should be used or not.

The beam spot pos and cov must still be set in the RaveSetup class if you what to use it

Definition at line 82 of file RaveVertexFitter.h.

      {
        if (beamSpot == true) {
          if (RaveSetup::getRawInstance()->m_useBeamSpot == false) {
            B2FATAL("Beam spot information cannot be used because the beam spot position and covariance was not set in RaveSetup");
          }
          m_useBeamSpot = true;
        } else {
          m_useBeamSpot = false;
        }
      }

Member Data Documentation

m_belleDaughters

std::vector<Particle*> m_belleDaughters

protected

Belle Particle pointers input.

Definition at line 142 of file RaveVertexFitter.h.

m_raveTracks

std::vector<rave::Track> m_raveTracks

protected

holds the tracks that were added to a RaveVertexFitter object in the format used by Rave

Definition at line 136 of file RaveVertexFitter.h.

m_raveVertices

std::vector< rave::Vertex > m_raveVertices

protected

holds the fitted vertices after fit() was called in the format used by Rave

Definition at line 139 of file RaveVertexFitter.h.

m_useBeamSpot

bool m_useBeamSpot

protected

flag determines if the beam spot will be used or not.

Overwrites the global flag in RaveSetup

Definition at line 130 of file RaveVertexFitter.h.

---

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

• analysis/VertexFitting/RaveInterface/include/RaveVertexFitter.h
• analysis/VertexFitting/RaveInterface/src/RaveVertexFitter.cc