EMErrorDetail.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef EGAMMAEVENT_EMERRORBUILDER_H
#define EGAMMAEVENT_EMERRORBUILDER_H
/********************************************************************
NAME:     EMErrorDetail.h
PACKAGE:  offline/Reconstruction/egamma/egammaEvent
AUTHORS:  T. Cuhadar Donszelmann
CREATED:  May 2009
PURPOSE:  Build track/conv. tracks/photon error matrices
UPDATED:
********************************************************************/
#include <vector>
//#include "GaudiKernel/ToolHandle.h"
#include "egammaEvent/egDetail.h"
#include "egammaEvent/egamma.h"
#include "TrkParametersBase/ParametersT.h"
#include "VxVertex/RecVertex.h"
 
class EMClusterErrorsParametrizations;
 
namespace Trk{
  template<int DIM, class T, class S> class ParametersT;
  class  Track;
}
 
class EMErrorDetail : public egDetail
{
 public:
 
  EMErrorDetail(); 
 
  virtual ~EMErrorDetail() = default;
 
  //void print() const; 
  virtual const std::string& className() const;
  
  virtual double parameter(egammaParameters::ParamDef) const ;
  virtual int intParameter(egammaParameters::ParamDef) const ;
  virtual bool   hasParameter(egammaParameters::ParamDef) const ;
  virtual bool   hasIntParameter(egammaParameters::ParamDef) const ;
  void set_parameter(egammaParameters::ParamDef, double, bool overwrite=false) ; 
  
  // obsolete @brief Fill the details of the object. This is the main function for building the detail*/
  //template <int DIM, class T, class S> void fillEMErrorDetail(const egamma*, const Trk::ParametersT< DIM, T, S>*, 
  //                                                            const EMClusterErrorsParametrizations*, 
  //                                  const Amg::Vector3D&);
  
  // obsolete: Fill and get the track covariance matrix from the method where track and cluster information are combined*/
  //bool fillEMTrackCombinedErrorMatrix(const AmgSymMatrix(5)& combinedMatrix);
 
  Amg::MatrixX getCombinedErrorMatrix() const;
  Amg::MatrixX getUncombinedErrorMatrix() const;
 
  AmgSymMatrix(4) get4x4CombinedErrorMatrix() const;
  AmgSymMatrix(4) get4x4UncombinedErrorMatrix() const;
 
  /*** THE 6 FUNCTIONS BELOW ARE DEPRICATED FOR EXTERNAL USE
       THEY ARE CALLED BY THE ABOVE FUNCTIONS ***/
 
  AmgSymMatrix(5) getEMTrackCombinedErrorMatrix() const;
  AmgSymMatrix(3) getEMPhotonErrorMatrix() const;
  AmgSymMatrix(5) getEMTrackUncombinedErrorMatrix() const;
 
  AmgSymMatrix(4) get4x4EMTrackCombinedErrorMatrix() const;
  AmgSymMatrix(4) get4x4EMTrackUncombinedErrorMatrix() const;
  AmgSymMatrix(4) get4x4EMPhotonErrorMatrix() const;
 
 
  /****************************************************************/
  /* Converted photon related parameters  :   Get Parameters*/
  /****************************************************************/
  
  double EMconvertedphoton_perigee_d0 ()  const;
  double EMconvertedphoton_perigee_z0 ()  const;
  double EMconvertedphoton_perigee_phi0 ()  const; 
  double EMconvertedphoton_perigee_theta ()  const;
//   double EMconvertedphoton_perigee_Eclus ()  const;
  double EMconvertedphoton_perigee_eta ()  const;
  double EMconvertedphoton_perigee_momentum ()  const; 
 
  double EMconvertedphoton_perigee_Covd0d0 ()  const;    
  double EMconvertedphoton_perigee_Covd0z0 ()  const;    
  double EMconvertedphoton_perigee_Covd0phi ()  const;  
  double EMconvertedphoton_perigee_Covd0theta ()  const;
//   double EMconvertedphoton_perigee_Covd0Eclus ()  const;
  double EMconvertedphoton_perigee_Covz0z0   ()  const;
  double EMconvertedphoton_perigee_Covz0phi  ()  const;
  double EMconvertedphoton_perigee_Covz0theta ()  const;
//   double EMconvertedphoton_perigee_Covz0Eclus ()  const;
  double EMconvertedphoton_perigee_Covphiphi ()  const;
  double EMconvertedphoton_perigee_Covphitheta ()  const;
//   double EMconvertedphoton_perigee_CovphiEclus ()  const;
  double EMconvertedphoton_perigee_Covthetatheta ()  const;
//   double EMconvertedphoton_perigee_CovthetaEclus ()  const;
//   double EMconvertedphoton_perigee_CovEclusEclus ()  const;
 
 
  /****************************************************************/
  /* Converted photon related parameters  :   Set Parameters*/
  /****************************************************************/
 
  void EMconvertedphoton_perigee_d0 (double);
  void EMconvertedphoton_perigee_z0 (double);
  void EMconvertedphoton_perigee_phi0 (double); 
  void EMconvertedphoton_perigee_theta (double);
//   void EMconvertedphoton_perigee_Eclus (double);
  void EMconvertedphoton_perigee_eta (double);
  void EMconvertedphoton_perigee_momentum (double);
    
  void EMconvertedphoton_perigee_Covd0d0 (double);    
  void EMconvertedphoton_perigee_Covd0z0 (double) ;    
  void EMconvertedphoton_perigee_Covd0phi (double) ;  
  void EMconvertedphoton_perigee_Covd0theta (double) ;
//   void EMconvertedphoton_perigee_Covd0Eclus (double) ;
  void EMconvertedphoton_perigee_Covz0z0   (double) ;
  void EMconvertedphoton_perigee_Covz0phi  (double) ;
  void EMconvertedphoton_perigee_Covz0theta (double) ;
//   void EMconvertedphoton_perigee_Covz0Eclus (double) ;
  void EMconvertedphoton_perigee_Covphiphi (double) ;
  void EMconvertedphoton_perigee_Covphitheta (double) ;
//   void EMconvertedphoton_perigee_CovphiEclus (double) ;
  void EMconvertedphoton_perigee_Covthetatheta (double) ;
//   void EMconvertedphoton_perigee_CovthetaEclus (double) ;
//   void EMconvertedphoton_perigee_CovEclusEclus (double) ;
 
 
 
  /***************************************************/
  /* Track related parameters  :   Get Parameters*/
  /***************************************************/
 
  double EMtrack_perigee_d0    ()  const;
  double EMtrack_perigee_phi0  ()  const;
//   /** @brief cluster energy */
//   double EMtrack_perigee_Eclus () const;
  double EMtrack_perigee_z0    ()  const;
  double EMtrack_perigee_theta ()  const;
  double EMtrack_perigee_eta    ()  const;
  double EMtrack_perigee_momentum ()  const; 
  
  double EMtrack_perigee_Covd0d0         () const;
  double EMtrack_perigee_Covd0z0         () const;
  double EMtrack_perigee_Covd0phi        () const;
  double EMtrack_perigee_Covd0theta      () const;
//   /** @brief Covariance matrix item (d0,Eclus) */
//   double EMtrack_perigee_Covd0Eclus     () const;
  double EMtrack_perigee_Covz0z0         () const;
  double EMtrack_perigee_Covz0phi        () const;
  double EMtrack_perigee_Covz0theta      () const;
//   /** @brief Covariance matrix item (z0,Eclus) */
//   double EMtrack_perigee_Covz0Eclus     () const;
  double EMtrack_perigee_Covphiphi       () const;
  double EMtrack_perigee_Covphitheta     () const;
//   /** @brief Covariance matrix item (phi,Eclus) */
//   double EMtrack_perigee_CovphiEclus    () const;
  double EMtrack_perigee_Covthetatheta   () const;
//   /** @brief Covariance matrix item (theta,Eclus) */
//   double EMtrack_perigee_CovthetaEclus  () const;
//   /** @brief Covariance matrix item (Eclus, Eclus) */
//   double EMtrack_perigee_CovEclusEclus () const;
 
      
  /***************************************************/
  /* Track related parameters  :   Set Parameters*/
  /***************************************************/
 
 
  void EMtrack_perigee_d0    (double)  ;
  void EMtrack_perigee_phi0  (double)  ;
//   /** @brief Set the Eclus estimate according to track cluster */
//   void EMtrack_perigee_Eclus(double)  ;
  void EMtrack_perigee_z0    (double)  ;
  void EMtrack_perigee_theta (double)  ;
   void EMtrack_perigee_eta    (double)  ;
  void EMtrack_perigee_momentum (double)  ;
 
  
  void EMtrack_perigee_Covd0d0         (double) ;
  void EMtrack_perigee_Covd0z0         (double) ;
  void EMtrack_perigee_Covd0phi        (double) ;
  void EMtrack_perigee_Covd0theta      (double) ;
//   /** @brief Set the Covariance matrix item (d0,Eclus) */
//   void EMtrack_perigee_Covd0Eclus     (double) ;
  void EMtrack_perigee_Covz0z0         (double) ;
  void EMtrack_perigee_Covz0phi        (double) ;
  void EMtrack_perigee_Covz0theta      (double) ;
//   /** @brief Set the Covariance matrix item (z0,Eclus) */
//   void EMtrack_perigee_Covz0Eclus     (double) ;
  void EMtrack_perigee_Covphiphi       (double) ;
  void EMtrack_perigee_Covphitheta     (double) ;
//   /** @brief Set the Covariance matrix item (phi,Eclus) */
//   void EMtrack_perigee_CovphiEclus    (double) ;
  void EMtrack_perigee_Covthetatheta   (double) ;
//   /** @brief Set the Covariance matrix item (theta,Eclus) */
//   void EMtrack_perigee_CovthetaEclus  (double) ;
//   /** @brief Set the Covariance matrix item (Eclus,Eclus) */
//   void EMtrack_perigee_CovEclusEclus (double) ; 
 
  /***************************************************/
  /* Photon related parameters : Get Parameters */
  /***************************************************/
    
  double EMphoton_eta ()  const;
  double EMphoton_phi0 ()  const;
  double EMphoton_Eclus ()  const;
   
 
  double EMphoton_Covetaeta      () const;
  double EMphoton_Covetaphi     () const;
  double EMphoton_CovetaEclus      () const;
  double EMphoton_Covphiphi    () const;
  double EMphoton_CovphiEclus    () const;
  double EMphoton_CovEclusEclus () const;
 
 
  /***************************************************/
  /* Photon related parameters : Set Parameters */
  /***************************************************/
 
  void EMphoton_eta (double);
  void EMphoton_phi0 (double);
  void EMphoton_Eclus (double);
   
 
  void EMphoton_Covetaeta      (double);
  void EMphoton_Covetaphi     (double);
  void EMphoton_CovetaEclus      (double);
  void EMphoton_Covphiphi    (double);
  void EMphoton_CovphiEclus    (double);
  void EMphoton_CovEclusEclus (double);
 
  /***********************************************************************/
  /* Combined track & cluster related parameters : Set Parameters */
  /***********************************************************************/
 
  double EMtrack_comb_Covd0d0         () const;
  double EMtrack_comb_Covd0z0         () const;
  double EMtrack_comb_Covd0phi        () const;
  double EMtrack_comb_Covd0eta      () const;
  double EMtrack_comb_Covd0P     () const;
  double EMtrack_comb_Covz0z0         () const;
  double EMtrack_comb_Covz0phi        () const;
  double EMtrack_comb_Covz0eta      () const;
  double EMtrack_comb_Covz0P     () const;
  double EMtrack_comb_Covphiphi       () const;
  double EMtrack_comb_Covphieta     () const;
  double EMtrack_comb_CovphiP    () const;
  double EMtrack_comb_Covetaeta   () const;
  double EMtrack_comb_CovetaP  () const;
  double EMtrack_comb_CovPP () const;
 
  void EMtrack_comb_Covd0d0         (double) ;
  void EMtrack_comb_Covd0z0         (double) ;
  void EMtrack_comb_Covd0phi        (double) ;
  void EMtrack_comb_Covd0eta      (double) ;
  void EMtrack_comb_Covd0P     (double) ;
  void EMtrack_comb_Covz0z0         (double) ;
  void EMtrack_comb_Covz0phi        (double) ;
  void EMtrack_comb_Covz0eta      (double) ;
  void EMtrack_comb_Covz0P     (double) ;
  void EMtrack_comb_Covphiphi       (double) ;
  void EMtrack_comb_Covphieta     (double) ;
  void EMtrack_comb_CovphiP    (double) ;
  void EMtrack_comb_Covetaeta   (double) ;
  void EMtrack_comb_CovetaP  (double) ;
  void EMtrack_comb_CovPP (double) ; 
 
 
  /***************************************************/
  /* Link Index for tracks and vertices */
  /***************************************************/
 
  int linkIndex ()  const;
 
  void set_linkIndex (int);
 
  int hasSiliconHits() const;
  void set_hasSiliconHits (int x);
 
  static double getClusterEtaPosError(const egamma*, 
                   const EMClusterErrorsParametrizations*,
                   bool forcePhoton = false) ;
 
private:
 
  void set_parameterInt(egammaParameters::ParamDef, int, bool overwrite=false) ; 
 
  static double caloEta(const egamma*, double clusterEta) ;
  static double getClusterEnergyError(const egamma*, const EMClusterErrorsParametrizations*, bool forcePhoton = false) ;
  static double getClusterEtaError(const egamma*, const EMClusterErrorsParametrizations*, bool forcePhoton = false) ;
  static double getClusterPhiError(const egamma*, const EMClusterErrorsParametrizations*, bool forcePhoton = false) ;
 
    
  //template <int DIM, class T, class S> bool fillConvertedPhotonMatrixElements(const Trk::ParametersT< DIM, T, S>* ); 
 
  //bool fillConvertedPhotonErrorMatrix(const AmgSymMatrix(5)*);
 
  //template <int DIM, class T, class S> bool fillTrackPerigeeMatrixElements(const Trk::ParametersT< DIM, T, S>* ) ;
 
  //bool fillTrackPerigeeErrorMatrix(const AmgSymMatrix(5)*);
 
  /* Obsolete: Fill the photon parameter details */
  //bool fillPhotonMatrixElements(const egamma*, const EMClusterErrorsParametrizations*, 
  //                const Amg::Vector3D&, bool forcePhoton=false);
  //Obsolete Fill the perigree error details */
  //bool fillPhotonErrorMatrix(const egamma*, const EMClusterErrorsParametrizations*, bool);
 
  //** @brief is it an electron? */
  // Should maybe make it return electron, photon, or conversion in the future **/
  static bool isElectron(const egamma*, bool forcePhoton) ;
 
  // jacobians
  static AmgSymMatrix(5) P5Jacobiand0z0PhiThetaE2d0z0PhiEtaE(const double phi) ;
  static AmgSymMatrix(4) P4JacobiandEThetaPhiM2EEtaPhiM(const double theta) ;
 
  std::vector< std::pair<egammaParameters::ParamDef,double> > m_parameters;
  std::vector< std::pair<egammaParameters::ParamDef,int> > m_parametersInt;
  static const std::string s_className;
 
};
 
#endif