MakeMotherKFit is a class to build mother particle from kinematically fitted daughters. More...

#include <MakeMotherKFit.h>

Public Member Functions
	MakeMotherKFit (void)
	Construct an object with no argument.

	~MakeMotherKFit (void)
	Destruct the object.

enum KFitError::ECode	addTrack (const KFitTrack &kp)
	Add a track to the make-mother object.

enum KFitError::ECode	addTrack (const CLHEP::HepLorentzVector &p, const HepPoint3D &x, const CLHEP::HepSymMatrix &e, const double q, const int flag=KFitConst::kAfterFit)
	Add a track to the make-mother object with specifying its momentum, position, error matrix, and charge.

enum KFitError::ECode	setMagneticField (const double mf)
	Change a magnetic field from the default value KFitConst::kDefaultMagneticField.

enum KFitError::ECode	setVertex (const HepPoint3D &v)
	Set a vertex position of the mother particle.

enum KFitError::ECode	setVertexError (const CLHEP::HepSymMatrix &e)
	Set a vertex error matrix of the mother particle.

enum KFitError::ECode	setTrackVertexError (const CLHEP::HepMatrix &e)
	Set a vertex error matrix of the child particle in the addTrack'ed order.

enum KFitError::ECode	setTrackZeroVertexError (void)
	Indicate no vertex uncertainty in the child particle in the addTrack'ed order.

enum KFitError::ECode	setCorrelation (const CLHEP::HepMatrix &e)
	Set a correlation matrix.

enum KFitError::ECode	setZeroCorrelation (void)
	Indicate no correlation between tracks.

enum KFitError::ECode	setFlagAtDecayPoint (const bool flag)
	Set a flag to control computational point for the mother particle property at the decay point or not.

enum KFitError::ECode	setFlagBeforeAfter (const int flag)
	Set a flag to control computational parameters for the mother particle property before or after the fit.

enum KFitError::ECode	getErrorCode (void) const
	Get a code of the last error.

const KFitTrack	getMother (void) const
	Get a track object of the mother particle.

const CLHEP::HepLorentzVector	getMotherMomentum (void) const
	Get a Lorentz vector of the mother particle.

const HepPoint3D	getMotherPosition (void) const
	Get a position of the mother particle.

const CLHEP::HepSymMatrix	getMotherError (void) const
	Get an error matrix of the mother particle.

enum KFitError::ECode	doMake (void)
	Perform a reconstruction of mother particle.

Private Member Functions
void	calculateError (CLHEP::HepSymMatrix *Ec) const
	Make a matrix to calculate error matrix of the mother particle.

void	calculateDELMDELC (CLHEP::HepMatrix *e) const
	Make delMdelC to calculate error matrix of the mother particle.

Private Attributes
enum KFitError::ECode	m_ErrorCode
	Error code.

bool	m_FlagAtDecayPoint
	Flag controlled by setFlagAtDecayPoint().

int	m_FlagBeforeAfter
	Flag controlled by setFlagBeforeAfter().

bool	m_FlagVertexError
	Flag to indicate if the vertex error matrix of the mother particle is preset.

bool	m_FlagCorrelation
	Flag to indicate if the correlation matrix among the child particles is preset.

bool	m_FlagTrackVertexError
	Flag to indicate if the vertex error matrix of the child particle is preset.

double	m_MagneticField
	Magnetic field.

int	m_TrackCount
	Number of tracks.

std::vector< KFitTrack >	m_Tracks
	Array of track objects of the child particles.

std::vector< CLHEP::HepMatrix >	m_TrackVertexError
	Array of vertex error matrices of the child particles.

std::vector< CLHEP::HepMatrix >	m_Correlation
	Array of correlation matrices among the child particles.

CLHEP::Hep3Vector	m_Vertex
	Vertex position of the mother particle.

CLHEP::HepSymMatrix	m_VertexError
	Vertex error matrix of the mother particle.

double	m_Charge
	Charge of the mother particle.

KFitTrack	m_Mother
	Track object of the mother particle.

Detailed Description

MakeMotherKFit is a class to build mother particle from kinematically fitted daughters.

Definition at line 40 of file MakeMotherKFit.h.

Constructor & Destructor Documentation

◆ MakeMotherKFit()

MakeMotherKFit ( void )

Construct an object with no argument.

Definition at line 19 of file MakeMotherKFit.cc.

                              :
  m_Vertex(Hep3Vector()),
  m_VertexError(HepSymMatrix(3, 0))
{
  m_ErrorCode = KFitError::kNoError;
  m_FlagAtDecayPoint = true;
  m_FlagVertexError = false;
  m_FlagCorrelation = false;
  m_FlagTrackVertexError = false;
  m_FlagBeforeAfter = KFitConst::kAfterFit;
  m_MagneticField = KFitConst::kDefaultMagneticField;
  m_TrackCount = 0;
  m_Charge = 0;
}

Member Function Documentation

◆ addTrack() [1/2]

enum KFitError::ECode addTrack	(	const CLHEP::HepLorentzVector &	p,
		const HepPoint3D &	x,
		const CLHEP::HepSymMatrix &	e,
		const double	q,
		const int	flag = `KFitConst::kAfterFit`
	)

Add a track to the make-mother object with specifying its momentum, position, error matrix, and charge.

This function internally calls addTrack(const KFitTrack &kp).

Parameters

p	Lorentz vector of the track
x	position of the track
e	(7x7) error matrix of the track
q	charge of the track
flag	KFitConst::kBeforeFit or KFitConst::kAfterFit

Returns: error code (zero if success)

Definition at line 49 of file MakeMotherKFit.cc.

                                         {
  if (e.num_row() != (int)KFitConst::kNumber7)
  {
    m_ErrorCode = KFitError::kBadMatrixSize;
    KFitError::displayError(__FILE__, __LINE__, __func__, m_ErrorCode);
    return m_ErrorCode;
  }
 
  return this->addTrack(KFitTrack(p, x, e, q, flag));
}

◆ addTrack() [2/2]

enum KFitError::ECode addTrack ( const KFitTrack & kp )

Add a track to the make-mother object.

Parameters

kp	object of the track

Returns: error code (zero if success)

Definition at line 39 of file MakeMotherKFit.cc.

                                           {
  m_Tracks.push_back(p);
  m_Charge += p.getCharge();
  m_TrackCount = m_Tracks.size();
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ calculateDELMDELC()

void calculateDELMDELC ( CLHEP::HepMatrix * e ) const

private

Make delMdelC to calculate error matrix of the mother particle.

Parameters

e	delMdelC container

Definition at line 306 of file MakeMotherKFit.cc.

{
  // ...local parameters
  double sum_a = 0;
 
  for (int i = 0; i < m_TrackCount; i++) {
    const double c = Belle2::Const::speedOfLight * 1e-4;
    double a = -c * m_MagneticField * m_Tracks[i].getCharge();
    sum_a += a;
 
    // ...sets "a" in dMdC.
    (*dMdC)[0][5 + i * KFitConst::kNumber7] =  a;
    (*dMdC)[1][4 + i * KFitConst::kNumber7] = -a;
 
    // ...sets "1" in dMdC.
    (*dMdC)[0][0 + i * KFitConst::kNumber7] = 1.;
    (*dMdC)[1][1 + i * KFitConst::kNumber7] = 1.;
    (*dMdC)[2][2 + i * KFitConst::kNumber7] = 1.;
    (*dMdC)[3][3 + i * KFitConst::kNumber7] = 1.;
  }
 
  // ...sets "1" in dMdC.
  (*dMdC)[4][0 + m_TrackCount * KFitConst::kNumber7] = 1.;
  (*dMdC)[5][1 + m_TrackCount * KFitConst::kNumber7] = 1.;
  (*dMdC)[6][2 + m_TrackCount * KFitConst::kNumber7] = 1.;
 
  // ...sets "sum_a" in dMdC.
  (*dMdC)[0][1 + m_TrackCount * KFitConst::kNumber7] = - sum_a;
  (*dMdC)[1][0 + m_TrackCount * KFitConst::kNumber7] =   sum_a;
}

◆ calculateError()

void calculateError ( CLHEP::HepSymMatrix * Ec ) const

private

Make a matrix to calculate error matrix of the mother particle.

Parameters

Ec	error matrix container

Definition at line 254 of file MakeMotherKFit.cc.

{
  // ...error matrix of tracks
  {
    int i = 0;
    for (const auto& track : m_Tracks) {
      (*Ec).sub(i * KFitConst::kNumber7 + 1, track.getError(m_FlagBeforeAfter));
      i++;
    }
  }
 
 
  // ...error matrix between tracks
  if (m_FlagCorrelation) {
    int i = 0, j = 1;
    for (const auto& hm : m_Correlation) {
      for (int k = 0; k < KFitConst::kNumber7; k++) for (int l = 0; l < KFitConst::kNumber7; l++) {
          (*Ec)[k + i * KFitConst::kNumber7][l + j * KFitConst::kNumber7] = hm[k][l];
        }
 
      if (j != m_TrackCount - 1) {
        j++;
      } else if (i != m_TrackCount - 2) {
        i++;
        j = i + 1;
      } else {
        break;
      }
    }
  }
 
 
  // ...error of vertex
  if (m_FlagVertexError) {
    (*Ec).sub(m_TrackCount * KFitConst::kNumber7 + 1, m_VertexError);
  }
 
 
  // ...error matrix between vertex and tracks
  if (m_FlagTrackVertexError) {
    int i = 0;
    for (const auto& hm : m_TrackVertexError) {
      for (int j = 0; j < 3; j++) for (int k = 0; k < KFitConst::kNumber7; k++) {
          (*Ec)[j + m_TrackCount * KFitConst::kNumber7][k + i * KFitConst::kNumber7] = hm[j][k];
        }
      i++;
    }
  }
}

◆ doMake()

enum KFitError::ECode doMake ( void )

Perform a reconstruction of mother particle.

Returns: error code (zero if success)

Definition at line 192 of file MakeMotherKFit.cc.

                       {
  // ...makes matrix.
  HepMatrix dMdC(KFitConst::kNumber7, KFitConst::kNumber7 * m_TrackCount + 3, 0);
  HepSymMatrix Ec(KFitConst::kNumber7 * m_TrackCount + 3, 0);
 
 
  // ...sets error matrix
  if (m_FlagCorrelation && m_Correlation.size() != static_cast<unsigned int>((m_TrackCount * m_TrackCount - m_TrackCount) / 2))
  {
    m_ErrorCode = KFitError::kBadTrackSize;
    KFitError::displayError(__FILE__, __LINE__, __func__, m_ErrorCode);
    return m_ErrorCode;
  }
  if (m_FlagTrackVertexError && m_TrackVertexError.size() != (unsigned int)m_TrackCount)
  {
    m_ErrorCode = KFitError::kBadTrackSize;
    KFitError::displayError(__FILE__, __LINE__, __func__, m_ErrorCode);
    return m_ErrorCode;
  }
  this->calculateError(&Ec);
 
 
  // ...makes delMdelC to calculate error matrix of mother particle.
  this->calculateDELMDELC(&dMdC);
 
 
  // ...calculates error matrix of mother particle.
  HepSymMatrix Em(Ec.similarity(dMdC));
 
 
  // ...makes mother particle
  double px = 0, py = 0, pz = 0, E = 0;
  for (int i = 0; i < m_TrackCount; i++)
  {
    double a = 0, dx = 0, dy = 0;
    if (m_FlagAtDecayPoint) {
      const double c = Belle2::Const::speedOfLight * 1e-4;
      a = -c * m_MagneticField * m_Tracks[i].getCharge();
      dx = m_Vertex.x() - m_Tracks[i].getPosition(m_FlagBeforeAfter).x();
      dy = m_Vertex.y() - m_Tracks[i].getPosition(m_FlagBeforeAfter).y();
    }
    px += m_Tracks[i].getMomentum(m_FlagBeforeAfter).x() - a * dy;
    py += m_Tracks[i].getMomentum(m_FlagBeforeAfter).y() + a * dx;
    pz += m_Tracks[i].getMomentum(m_FlagBeforeAfter).z();
    E  += m_Tracks[i].getMomentum(m_FlagBeforeAfter).t();
  }
 
 
  // ...momentum
  m_Mother.setMomentum(HepLorentzVector(px, py, pz, E));
  // ...position
  m_Mother.setPosition(m_Vertex);
  // ...error
  m_Mother.setError(Em);
  m_Mother.setCharge(m_Charge);
 
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ getErrorCode()

enum KFitError::ECode getErrorCode ( void ) const

Get a code of the last error.

Returns: error code

Definition at line 159 of file MakeMotherKFit.cc.

                                   {
  return m_ErrorCode;
}

◆ getMother()

const KFitTrack getMother ( void ) const

Get a track object of the mother particle.

Returns: track object of the mother particle

Definition at line 164 of file MakeMotherKFit.cc.

{
  return m_Mother;
}

◆ getMotherError()

const HepSymMatrix getMotherError ( void ) const

Get an error matrix of the mother particle.

Returns: error matrix of the mother particle

Definition at line 185 of file MakeMotherKFit.cc.

{
  return m_Mother.getError(KFitConst::kBeforeFit);
}

◆ getMotherMomentum()

const HepLorentzVector getMotherMomentum ( void ) const

Get a Lorentz vector of the mother particle.

Returns: Lorentz vector of the mother particle

Definition at line 171 of file MakeMotherKFit.cc.

{
  return m_Mother.getMomentum(KFitConst::kBeforeFit);
}

◆ getMotherPosition()

const HepPoint3D getMotherPosition ( void ) const

Get a position of the mother particle.

Returns: position of the mother particle

Definition at line 178 of file MakeMotherKFit.cc.

{
  return m_Mother.getPosition(KFitConst::kBeforeFit);
}

◆ setCorrelation()

enum KFitError::ECode setCorrelation ( const CLHEP::HepMatrix & e )

Set a correlation matrix.

Parameters

e	(7x7) correlation matrix

Returns: error code (zero if success)

Definition at line 119 of file MakeMotherKFit.cc.

                                                 {
  if (e.num_row() != (int)KFitConst::kNumber7 || e.num_col() != (int)KFitConst::kNumber7)
  {
    m_ErrorCode = KFitError::kBadMatrixSize;
    KFitError::displayError(__FILE__, __LINE__, __func__, m_ErrorCode);
    return m_ErrorCode;
  }
 
  m_Correlation.push_back(e);
  m_FlagCorrelation = true;
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ setFlagAtDecayPoint()

enum KFitError::ECode setFlagAtDecayPoint ( const bool flag )

Set a flag to control computational point for the mother particle property at the decay point or not.

Parameters

flag	true for yes, false for no

Returns: error code (zero if success)

Definition at line 143 of file MakeMotherKFit.cc.

                                                   {
  m_FlagAtDecayPoint = flag;
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ setFlagBeforeAfter()

enum KFitError::ECode setFlagBeforeAfter ( const int flag )

Set a flag to control computational parameters for the mother particle property before or after the fit.

Parameters

flag	KFitConst::kBeforeFit or KFitConst::kAfterFit

Returns: error code (zero if success)

Definition at line 151 of file MakeMotherKFit.cc.

                                                 {
  m_FlagBeforeAfter = flag;
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ setMagneticField()

enum KFitError::ECode setMagneticField ( const double mf )

Change a magnetic field from the default value KFitConst::kDefaultMagneticField.

Parameters

mf	magnetic field to set

Returns: error code (zero if success)

Definition at line 63 of file MakeMotherKFit.cc.

                                                {
  m_MagneticField = mf;
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ setTrackVertexError()

enum KFitError::ECode setTrackVertexError ( const CLHEP::HepMatrix & e )

Set a vertex error matrix of the child particle in the addTrack'ed order.

Parameters

e	(3x7) vertex error matrix

Returns: error code (zero if success)

Definition at line 95 of file MakeMotherKFit.cc.

                                                      {
  if (e.num_row() != 3 || e.num_col() != (int)KFitConst::kNumber7)
  {
    m_ErrorCode = KFitError::kBadMatrixSize;
    KFitError::displayError(__FILE__, __LINE__, __func__, m_ErrorCode);
    return m_ErrorCode;
  }
 
  m_TrackVertexError.push_back(e);
  m_FlagTrackVertexError = true;
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ setTrackZeroVertexError()

enum KFitError::ECode setTrackZeroVertexError ( void )

Indicate no vertex uncertainty in the child particle in the addTrack'ed order.

Returns: error code (zero if success)

Definition at line 111 of file MakeMotherKFit.cc.

                                        {
  HepMatrix zero(3, KFitConst::kNumber7, 0);
 
  return this->setTrackVertexError(zero);
}

◆ setVertex()

enum KFitError::ECode setVertex ( const HepPoint3D & v )

Set a vertex position of the mother particle.

Parameters

v	vertex position

Returns: error code (zero if success)

Definition at line 71 of file MakeMotherKFit.cc.

                                             {
  m_Vertex = v;
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ setVertexError()

enum KFitError::ECode setVertexError ( const CLHEP::HepSymMatrix & e )

Set a vertex error matrix of the mother particle.

Parameters

e	(3x3) vertex error matrix

Returns: error code (zero if success)

Definition at line 79 of file MakeMotherKFit.cc.

                                                    {
  if (e.num_row() != 3)
  {
    m_ErrorCode = KFitError::kBadMatrixSize;
    KFitError::displayError(__FILE__, __LINE__, __func__, m_ErrorCode);
    return m_ErrorCode;
  }
 
  m_VertexError = e;
  m_FlagVertexError = true;
 
  return m_ErrorCode = KFitError::kNoError;
}

◆ setZeroCorrelation()

enum KFitError::ECode setZeroCorrelation ( void )

Indicate no correlation between tracks.

Returns: error code (zero if success)

Definition at line 135 of file MakeMotherKFit.cc.

                                   {
  HepMatrix zero(KFitConst::kNumber7, KFitConst::kNumber7, 0);
 
  return this->setCorrelation(zero);
}

Member Data Documentation

◆ m_Charge

double m_Charge

private

Charge of the mother particle.

Definition at line 180 of file MakeMotherKFit.h.

◆ m_Correlation

std::vector<CLHEP::HepMatrix> m_Correlation

private

Array of correlation matrices among the child particles.

Definition at line 170 of file MakeMotherKFit.h.

◆ m_ErrorCode

enum KFitError::ECode m_ErrorCode

private

Error code.

Definition at line 146 of file MakeMotherKFit.h.

◆ m_FlagAtDecayPoint

bool m_FlagAtDecayPoint

private

Flag controlled by setFlagAtDecayPoint().

Definition at line 149 of file MakeMotherKFit.h.

◆ m_FlagBeforeAfter

int m_FlagBeforeAfter

private

Flag controlled by setFlagBeforeAfter().

Definition at line 151 of file MakeMotherKFit.h.

◆ m_FlagCorrelation

bool m_FlagCorrelation

private

Flag to indicate if the correlation matrix among the child particles is preset.

Definition at line 155 of file MakeMotherKFit.h.

◆ m_FlagTrackVertexError

bool m_FlagTrackVertexError

private

Flag to indicate if the vertex error matrix of the child particle is preset.

Definition at line 157 of file MakeMotherKFit.h.

◆ m_FlagVertexError

bool m_FlagVertexError

private

Flag to indicate if the vertex error matrix of the mother particle is preset.

Definition at line 153 of file MakeMotherKFit.h.

◆ m_MagneticField

double m_MagneticField

private

Magnetic field.

Definition at line 160 of file MakeMotherKFit.h.

◆ m_Mother

KFitTrack m_Mother

private

Track object of the mother particle.

Definition at line 182 of file MakeMotherKFit.h.

◆ m_TrackCount

int m_TrackCount

private

Number of tracks.

Definition at line 162 of file MakeMotherKFit.h.

◆ m_Tracks

std::vector<KFitTrack> m_Tracks

private

Array of track objects of the child particles.

Definition at line 166 of file MakeMotherKFit.h.

◆ m_TrackVertexError

std::vector<CLHEP::HepMatrix> m_TrackVertexError

private

Array of vertex error matrices of the child particles.

Definition at line 168 of file MakeMotherKFit.h.

◆ m_Vertex

CLHEP::Hep3Vector m_Vertex

private

Vertex position of the mother particle.

Definition at line 174 of file MakeMotherKFit.h.

◆ m_VertexError

CLHEP::HepSymMatrix m_VertexError

private

Vertex error matrix of the mother particle.

Definition at line 176 of file MakeMotherKFit.h.

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

analysis/VertexFitting/KFit/include/MakeMotherKFit.h
analysis/VertexFitting/KFit/src/MakeMotherKFit.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MakeMotherKFit()

Member Function Documentation

◆ addTrack() [1/2]

◆ addTrack() [2/2]

◆ calculateDELMDELC()

◆ calculateError()

◆ doMake()

◆ getErrorCode()

◆ getMother()

◆ getMotherError()

◆ getMotherMomentum()

◆ getMotherPosition()

◆ setCorrelation()

◆ setFlagAtDecayPoint()

◆ setFlagBeforeAfter()

◆ setMagneticField()

◆ setTrackVertexError()

◆ setTrackZeroVertexError()

◆ setVertex()

◆ setVertexError()

◆ setZeroCorrelation()

Member Data Documentation

◆ m_Charge

◆ m_Correlation

◆ m_ErrorCode

◆ m_FlagAtDecayPoint

◆ m_FlagBeforeAfter

◆ m_FlagCorrelation

◆ m_FlagTrackVertexError

◆ m_FlagVertexError

◆ m_MagneticField

◆ m_Mother

◆ m_TrackCount

◆ m_Tracks

◆ m_TrackVertexError

◆ m_Vertex

◆ m_VertexError