KFitBase.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 * External Contributor: J. Tanaka                                        *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <vector>
 
#include <CLHEP/Matrix/Matrix.h>
#include <CLHEP/Matrix/SymMatrix.h>
#include <CLHEP/Vector/LorentzVector.h>
#include <CLHEP/Geometry/Point3D.h>
 
#include <analysis/dataobjects/Particle.h>
#include <analysis/VertexFitting/KFit/KFitConst.h>
#include <analysis/VertexFitting/KFit/KFitError.h>
#include <analysis/VertexFitting/KFit/KFitTrack.h>
 
#ifndef ENABLE_BACKWARDS_COMPATIBILITY
typedef HepGeom::Point3D<double> HepPoint3D;
#endif
 
namespace Belle2 {
  namespace analysis {
    class KFitBase {
    public:
      KFitBase(void);
      virtual ~KFitBase(void);
 
 
    public:
      enum KFitError::ECode         addTrack(const KFitTrack& kp);
      enum KFitError::ECode               addTrack(const CLHEP::HepLorentzVector& p, const HepPoint3D& x, const CLHEP::HepSymMatrix& e,
                                                   const double q);
      enum KFitError::ECode addParticle(const Particle* particle);
      virtual enum KFitError::ECode       setCorrelation(const CLHEP::HepMatrix& c);
      virtual enum KFitError::ECode       setZeroCorrelation(void);
      enum KFitError::ECode               setMagneticField(const double mf);
 
 
      enum KFitError::ECode               getErrorCode(void) const;
      int                                 getTrackCount(void) const;
      virtual int                         getNDF(void) const;
      virtual double                      getCHIsq(void) const;
      double                              getMagneticField(void) const;
      virtual double                      getTrackCHIsq(const int id) const;
      const CLHEP::HepLorentzVector       getTrackMomentum(const int id) const;
      const HepPoint3D                    getTrackPosition(const int id) const;
      const CLHEP::HepSymMatrix           getTrackError(const int id) const;
      const KFitTrack                     getTrack(const int id) const;
      virtual const CLHEP::HepMatrix             getCorrelation(const int id1, const int id2,
                                                                const int flag = KFitConst::kAfterFit) const;
 
 
    public:
      bool isFitted(void) const;
 
 
    protected:
      const CLHEP::HepSymMatrix makeError1(const CLHEP::HepLorentzVector& p, const CLHEP::HepMatrix& e) const;
      const CLHEP::HepMatrix    makeError1(const CLHEP::HepLorentzVector& p1, const CLHEP::HepLorentzVector& p2,
                                           const CLHEP::HepMatrix& e) const;
      const CLHEP::HepMatrix    makeError2(const CLHEP::HepLorentzVector& p, const CLHEP::HepMatrix& e) const;
      const CLHEP::HepSymMatrix makeError3(const CLHEP::HepLorentzVector& p, const CLHEP::HepMatrix& e, const bool is_fix_mass) const;
      const CLHEP::HepMatrix    makeError3(const CLHEP::HepLorentzVector& p1, const CLHEP::HepLorentzVector& p2,
                                           const CLHEP::HepMatrix& e, const bool is_fix_mass1, const bool is_fix_mass2) const;
      const CLHEP::HepMatrix    makeError4(const CLHEP::HepLorentzVector& p, const CLHEP::HepMatrix& e) const;
 
 
      virtual enum KFitError::ECode prepareInputMatrix(void)    = 0;
      virtual enum KFitError::ECode prepareInputSubMatrix(void) = 0;
      virtual enum KFitError::ECode prepareCorrelation(void);
      virtual enum KFitError::ECode prepareOutputMatrix(void)   = 0;
      virtual enum KFitError::ECode makeCoreMatrix(void)        = 0;
      virtual enum KFitError::ECode calculateNDF(void)          = 0;
 
 
    protected:
      enum KFitError::ECode doFit1(void);
      enum KFitError::ECode doFit2(void);
 
 
    protected:
      bool isTrackIDInRange(const int id) const;
      bool isNonZeroEnergy(const CLHEP::HepLorentzVector& p) const;
 
 
      enum KFitError::ECode m_ErrorCode;
      bool                  m_FlagFitted;
 
 
      std::vector<KFitTrack> m_Tracks;
      std::vector<CLHEP::HepMatrix> m_BeforeCorrelation;
 
 
      CLHEP::HepSymMatrix m_V_al_0;
      CLHEP::HepMatrix    m_al_0;
      CLHEP::HepMatrix    m_al_1;
      CLHEP::HepMatrix    m_al_a;
      CLHEP::HepMatrix    m_property;
 
      CLHEP::HepMatrix    m_D;
      CLHEP::HepMatrix    m_d;
 
      CLHEP::HepMatrix    m_V_D;
 
      CLHEP::HepMatrix    m_V_al_1;
      CLHEP::HepMatrix    m_lam;
 
      CLHEP::HepMatrix    m_E;
      CLHEP::HepMatrix    m_V_E;
      CLHEP::HepMatrix    m_lam0;
      CLHEP::HepMatrix    m_v;
      CLHEP::HepMatrix    m_v_a;
      CLHEP::HepMatrix    m_V_Dt;
      CLHEP::HepMatrix    m_Cov_v_al_1;
 
 
      int      m_NDF;
      double   m_CHIsq;
 
 
      int      m_TrackCount;
      int      m_NecessaryTrackCount;
 
      bool     m_FlagCorrelation;
      bool     m_FlagOverIteration;
 
      double   m_MagneticField;
    };
 
  } // namespace analysis
 
} // namespace Belle2