Fitter.h

Go to the documentation of this file.

// ******************************************************
// DecayTreeFitter Package
// We thank the original author Wouter Hulsbergen 
// (BaBar, LHCb) for providing the sources. 
// http://arxiv.org/abs/physics/0503191v1 (2005)
// Adaptation & Development for PANDA: Ralf Kliemt (2015)
// ******************************************************
// $Id: Fitter.h,v 1.7 2010-05-29 13:39:56 ibelyaev Exp $
// ============================================================================
#ifndef DECAYTREEFITTER_FITTER_H
#define DECAYTREEFITTER_FITTER_H 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <vector>
// ============================================================================
// GaudiKernel
// ============================================================================
//#include "GaudiKernel/SmartIF.h"
// ============================================================================
// Track interfaces
// ============================================================================
//#include "TrackInterfaces/ITrackStateProvider.h"
// ============================================================================
// LHCbMath
// ============================================================================
//#include "LHCbMath/ValueWithError.h"
//#include "LHCbMath/ParticleParams.h"
// ============================================================================
// DaVinciTypes
// ============================================================================
//#include "Kernel/DecayTree.h"
// ============================================================================
#include "RecoTrackStateProvider.h"
#include "Rtypes.h"

#include "RhoDoubleErr.h"
#include "RhoCandidate.h"
#include "RhoFitterBase.h"

namespace DecayTreeFitter
{
  class DecayChain ;
  class FitParams ;
  class ParticleBase ;
  class ChiSquare ;

  // ==========================================================================
  class Fitter : public RhoFitterBase
  {
  public:
    // ========================================================================
    enum FitStatus {
      UnFitted     = -1 ,
      Success      =  0 ,
      Failed            ,
      BadInput          ,
      NonConverged
    } ;
    // ========================================================================
  public:
    // ========================================================================
    Fitter ( RhoCandidate*   bc                  ,
            RecoTrackStateProvider* extrapolator        ,
            int verbosity = 0) ;
    Fitter ( RhoCandidate*   bc                  ,
            const RhoVector3Err& pv                  ,
            RecoTrackStateProvider* extrapolator = 0        ,
            int verbosity = 0) ;
    Fitter ( RhoCandidate*   bc                  ,
            const RhoLorentzVectorErr& lv                  ,
            RecoTrackStateProvider* extrapolator        ,
            int verbosity = 0) ;
    Fitter ( RhoCandidate*   bc                  ,
            const RhoLorentzVectorErr& lv                  ,
            const RhoVector3Err& pv                  ,
            RecoTrackStateProvider* extrapolator = 0        ,
            int verbosity = 0) ;
    virtual ~Fitter() ;                                           // destructor
    // ========================================================================
  public:
    // ========================================================================
    void setMassConstraint ( RhoCandidate*   cand , bool add = true ) ;
    void setMassConstraint ( RhoCandidate*   cand , double mass ) ;
    //TODO    void setMassConstraint ( RhoCandidateID& pid  , bool add = true ) ;
    //TODO    void setMassConstraint ( RhoCandidateID& pid  , double mass ) ;
    Bool_t Fit ( int maxNumberOfIterations  = 10 , double deltaChisquareConverged = 0.01 ) 
    {
      fit(maxNumberOfIterations,deltaChisquareConverged); 
      bool check = updateTree(m_particle);
      check = check && (m_status==0);
      return check;
    };
    Bool_t FitAll ( int maxit  = 10 , double dchiq = 0.01 ) { return Fit(maxit,dchiq); };
    std::string   print() const ;
    std::ostream& fillStream ( std::ostream& s ) const ;
    RhoCandidate* particle() const { return m_particle ; }
    RhoCandidate* fitParams ( RhoCandidate* p = 0 ) const {return p->GetFit();};
    //double     chiSquare () const { return m_chiSquare ; }
    double     chiSquare () const { return fChiSquare ; }
    int        nDof      () const ;
    FitStatus  status    () const { return m_status ; }
    int        nIter     () const { return m_niter  ; }
    ChiSquare chiSquare( RhoCandidate* p ) const ;
    RhoDoubleErr
    decayLengthSum ( RhoCandidate*, RhoCandidate* ) const ;
    //    LHCb::DecayTree getFittedTree() const ;
    //    RhoCandidate getFitted() const ;
    //    RhoCandidate getFitted(RhoCandidate* cand) const ;
    bool updateCand ( RhoCandidate* cand ) const ;
    bool updateTree ( RhoCandidate* cand ) const ;
    int  errCode  () { return m_errCode ; }
    void setVerbose(int i) ;
    void SetToleranceZ(double z) {if(m_extrapolator) m_extrapolator->SetToleranceZ(z);};


        //FIXME ######@^$E&$#%#^!#@&*(#######  REMOVE!
    DecayChain*       GetDecayChainDirty ()       { return m_decaychain  ; }


    // ========================================================================
  public:
    // ========================================================================
    RecoTrackStateProvider* extrapolator() { return m_extrapolator ; }
    void setStateProvider ( RecoTrackStateProvider* extrapolator ) ;
    // ========================================================================
  protected:
    // ========================================================================
    // expert interface. not yet for real consumption
    //    Gaudi::Math::ParticleParams
    //    fitParams(const ParticleBase& pb) const ;
    std::string name ( RhoCandidate* cand) const ;
    // ========================================================================
    RhoDoubleErr
    decayLengthSum(const ParticleBase&,const ParticleBase&) const ;
    // ========================================================================
    DecayChain*       decaychain ()       { return m_decaychain  ; }
    FitParams*        fitparams  ()       { return m_fitparams   ; }
    const DecayChain* decaychain () const { return m_decaychain  ; }
    const FitParams*  fitparams  () const { return m_fitparams   ; }
    // ========================================================================
    double globalChiSquare() const ;
    // ========================================================================
    // must be moved to derived class or so ...
    double add     ( RhoCandidate* cand ) ;
    double remove  ( RhoCandidate* cand ) ;
    void   updateIndex() ;
    // ========================================================================
    void   fit ( int maxNumberOfIterations  = 10 , double deltaChisquareConverged = 0.01 ) ;
    void fitOneStep() ;
    // ========================================================================

    RhoCandidate* fittedCand ( RhoCandidate* cand       ,
                              RhoCandidate*       headoftree ) const ;
    void            updateCand ( const ParticleBase&   pb         ,
                                RhoCandidate*       cand       ) const ;
    // ========================================================================
  private:
    // ========================================================================
    Fitter () ;                             //  default constructor is disabled
    Fitter ( const Fitter& ) ;              //     copy constructor is disabled
    Fitter& operator=( const Fitter& ) ;    // assignement operator is disabled
                                            // ========================================================================
  private:
    // ========================================================================
    RhoCandidate* m_particle   ;
    DecayChain*           m_decaychain ;
    FitParams*            m_fitparams  ;
    FitStatus             m_status     ;
    //double                m_chiSquare  ;
    int                   m_niter      ;
    int                   m_errCode    ;
    // ========================================================================
    //FIXME not being used???
    //    typedef std::map<RhoCandidate*, Gaudi::Math::ParticleParams> Map ;
    //    mutable Map m_map ;
    // ========================================================================
  protected:
    RecoTrackStateProvider* m_extrapolator ; // track extrapolator
                                             // ========================================================================
    ClassDef ( Fitter,1 )
  } ;
  // ==========================================================================
}
// ============================================================================
// The END
// ============================================================================
#endif