EnergyCorrections.h

Go to the documentation of this file.

#ifndef ENERGYCORRECTIONS_H
#define ENERGYCORRECTIONS_H
//
// EnergyCorrections.h
//
// Corrections to energy based quantities. EnergyCorrections is the home for
// all those functions that provide corrections to energy and related
// quantities. This file provides access to both Calibration Group correction
// factors and also CC shower and muon momentum corrections.
//
// Created:  M. Kordosky -- December, 2005
// Modified: R. Nichol   -- May, 2007
//           xbhuang     -- July, 2009
//
// $Author: xbhuang $
//
// $Revision: 1.24 $
//
// $Name:  $
//
// $Id: EnergyCorrections.h,v 1.24 2009/08/05 16:08:43 xbhuang Exp $
//
// $Log: EnergyCorrections.h,v $
// Revision 1.24  2009/08/05 16:08:43  xbhuang
//
// Modified in order to add correction function for Dogwood0 reconstruction.
//
// Revision 1.23  2009/07/22 17:46:44  xbhuang
//
// The same as previous version except change function ShowerEnergyCorrectionNearDogwood1() to ShowerEnergyCorrectionNearDogwood().
//
// Revision 1.22  2009/07/04 01:53:52  rhatcher
// Remove tabs (replaced w/ spaces per coding conventions).  Did a bit of
// other coding convention cleanup, but there is still a lot of ugliness
// about the formatting that makes the code very hard to read.
//
// Revision 1.21  2009/07/02 22:43:44  xbhuang
//
// kDogwood defined!
//
// Revision 1.20  2007/12/21 15:36:08  rjn
// Added switch for the ability to go back to the May version of the Masaki conversion
//
// Revision 1.19  2007/12/21 11:12:32  rjn
// Added a WeightedShowerEnergyConversionDogwood function
//
// Revision 1.18  2007/12/19 16:39:48  rjn
// Added Masaki's correction from DocDB 3895_v4
//
// Revision 1.17  2007/11/16 11:43:21  rjn
// Added ShowerEnergyConversionDogwood which is the function to be called by CandShowerHandle to apply ourbest knowledge of the conversion from MEU to GeV for the dogwood reconstruction, such that to first order the GeV number in the tree is correct (until we know more at least).
//
// Revision 1.16  2007/11/11 06:41:26  rhatcher
// Part of the ongoing purge of "DetectorType" in favor of "Detector"
// (the former is a synonym of the latter ...)
//
// Revision 1.15  2007/09/28 17:37:10  rjn
// Adding the latest version of EnergyCorrections to the repository. I'm sure this is going to upset somebody, but then again it always does.
//
// Revision 1.14  2007/06/04 18:28:23  rjn
// The preliminary version of the Calibration Group final MEU scale fudge factors are now available.
//
// Things to note for those users who are only interested in calibrating shower energy scale for the CC analysis, you can use the FullyCorrectShowerEnergy function, to apply both Calibration Group corrections and Masaki's shower energy tuning. Note that it is very important that you get the release type correct, for the analysis you should be using:
// Data -- Cedar_phy
// MC -- Cedar R1.24.1
// These are the only data sets for which calibration numbers are provided.
//
//
// If you are interested in making data or MC plots in fully calibrated MEU numbers you can use the CalibrationGroupEnergyCorrections function. This will convert MEU's from the sntp into fully calibrated MEU's. NB: It is very inmportant to be careful not to apply the corrections twice by calling both CalibrationGroupEnergyCorrections and FullyCorrectShowerEnergy. If you wish to do this investigate the WhichCorrection_t options and particular the kNoCalGroup option.
//
// Revision 1.13  2007/05/21 09:55:48  rjn
// Just a tidying up sort of commit. Moved the Calibration Group corrections from the obliquely named CorrectionsForMasaki to the rather easier to understand EnergyCorrections::CalibrationGroupEnergyCorrections. NB: This function is called automatically by FullyCorrectShowerEnergy, so do not pass already corrected values to FullyCorrectShowerEnergy.
//
// Revision 1.12  2007/05/19 12:18:39  rjn
// Added to the FullyCorrect family of EnergyCorrections. Now have corrections for shower energy and track momentum/energy from range. At this point users are encouraged to use these. There will still be a few under the hood changes but at this point I think there is a workable interface.
//
// Revision 1.11  2007/05/18 16:24:54  rjn
// Added FullyCorrectShowerEnergy function that should replaces the previously used shower energy corrections. Should work with birch and cedar. It also applies the appropriate calibration group corrections. Everyone should use this who used any of the previous functions.
//
// Revision 1.10  2007/02/01 20:06:50  ishi
// Semicolons at the end of namespace{} were removed.
//
// Revision 1.9  2007/02/01 17:47:33  kordosky
// New version of EnergyCorrections. EnergyCorrections is now a namespace and calling code should invoke "using namespace EnergyCorrections". This is not expected
// to cause problems since in the previous version all the correction functions were at global scope. Indeed, code including EnergyCorrections.h have been modified. Will handle cedar and birch by using static variables fVersion and fSubVersion, modified via SetCorrectionVersion(). Users need to do this, perhaps in their job macro. So far there is only one correction of each type and fSubVersion should be held at the default 0. Also, note the utility VersionFromFilename().
//
// Revision 1.8  2006/02/15 15:57:30  kordosky
// add correction from for momentum via curvature as advocated in 1430-v2. Only modifies momenta of positively charged tracks.
//
// Revision 1.7  2006/02/13 00:20:02  kordosky
// correction of +1.8% to FD data shower energy
//
// Revision 1.6  2006/02/12 22:09:58  kordosky
// Update momentum correction to account for new density and thickness measurements.
//
// Revision 1.5  2005/12/16 03:38:51  kordosky
// place implementation in a cxx file
//
// Revision 1.4  2005/12/16 02:52:43  kordosky
// Forgot the include guards.  Thansk Niki.
//
// Revision 1.3  2005/12/15 22:44:31  kordosky
// retweaked A Culling formulae in reaction to his presentation this morning
//
// Revision 1.2  2005/12/15 22:26:19  kordosky
// E=sqrt(p*p+m*m)  != p   (almost negligible)
//
// Revision 1.1  2005/12/15 21:57:09  kordosky
// moved from Mad
//
// Revision 1.2  2005/12/14 20:35:59  kordosky
// Updated energy corrections.
//
// Revision 1.1  2005/12/13 19:41:35  kordosky
// Standalone routines to correct the momentum via range to to groom et al range tables. Also, correct data to 7.755 g/cc which is our current best estimate of the detector density.
//
#include <string>
#include "Conventions/Detector.h"
#include "Conventions/ReleaseType.h"
#include "RecoBase/CandShowerHandle.h"

// Shower Energy Correction
// ==========================
//
// All users are recommended to use the FullyCorrectShowerEnergy function to
// apply corrections to shower energy. This function can be used for all
// shower types and performs Calibration Group + other corrections. NB:
// one now needs access to the offline database to call this function.
//



//
// All users are recommended to use the FullyCorrect family of track functions
// apply corrections to track momentum/energy.
//



namespace EnergyCorrections {

  typedef enum EWhichCorrection {
    kDefault = 0,
    kVersion1,
    kVersion2,
    kVersion3,
    kVersion4,
    kVersion5,
    kVersion6,
    kNoCalGroup
  } WhichCorrection_t;


  // The one stop shop for shower energy corrections is
  // FullyCorrectShowerEnergy
  float FullyCorrectShowerEnergy(float E,// Input calorimetric shower energy
                                 const CandShowerHandle::ShowerType_t& st,
                                 VldContext vc, //Context of this specific event
                                 ReleaseType::Release_t release, // Release version of the batch processing
                                 EnergyCorrections::WhichCorrection_t whichCor=EnergyCorrections::kDefault);


  //The following routines should be used to correct track energy
  //and momentum.
  float FullyCorrectMomentumFromRange(float p, //Momentum from range
                                      VldContext vc, //Context of this specific event
                                      ReleaseType::Release_t release, //Release verion of the batch processing
                                      EnergyCorrections::WhichCorrection_t whichCor=EnergyCorrections::kDefault);

  float FullyCorrectEnergyFromRange(float E, //Energy from range
                                    VldContext vc, //Context of this specific event
                                    ReleaseType::Release_t release, //Release verion of the batch processing
                                    EnergyCorrections::WhichCorrection_t whichCor=EnergyCorrections::kDefault);

  float FullyCorrectSignedMomentumFromCurvature(float p, //Momentum from curvature
                                                VldContext vc, //Context of this specific event
                                                ReleaseType::Release_t release, //Release verion of the batch processing
                                                EnergyCorrections::WhichCorrection_t whichCor=EnergyCorrections::kDefault);



  float CalibrationGroupEnergyCorrections(float E, //Energy in MEU, GeV or SigMap
                                          VldContext vc, //Context of this specific event
                                          ReleaseType::Release_t release, //Release verion of the batch processing
                                          EnergyCorrections::WhichCorrection_t whichCor=EnergyCorrections::kDefault);




  //New under the hood shower functions
  float ShowerEnergyCorrectionNearDogwood(float energy,
                                          const CandShowerHandle::ShowerType_t& st,
                                          EnergyCorrections::WhichCorrection_t whichCor);

  float ShowerEnergyCorrectionFarDogwood(float energy,
                                         const CandShowerHandle::ShowerType_t& st,
                                         EnergyCorrections::WhichCorrection_t whichCor);

  float ShowerEnergyCorrectionNearDogwood0(float energy,
                                           const CandShowerHandle::ShowerType_t& st,
                                           EnergyCorrections::WhichCorrection_t whichCor);

  float ShowerEnergyCorrectionFarDogwood0(float energy,
                                          const CandShowerHandle::ShowerType_t& st,
                                          EnergyCorrections::WhichCorrection_t whichCor);

  float ShowerEnergyCorrectionNearCedarPhyBhcurve(float energy,
                                                  const CandShowerHandle::ShowerType_t& st,
                                                  EnergyCorrections::WhichCorrection_t whichCor);

  float ShowerEnergyCorrectionFarCedarPhyBhcurve(float energy,
                                                 const CandShowerHandle::ShowerType_t& st,
                                                 EnergyCorrections::WhichCorrection_t whichCor);

  float ShowerEnergyCorrectionNearCedar(float energy,
                                        const CandShowerHandle::ShowerType_t& st,
                                        EnergyCorrections::WhichCorrection_t whichCor);

  float ShowerEnergyCorrectionFarCedar(float energy,
                                       const CandShowerHandle::ShowerType_t& st,
                                       EnergyCorrections::WhichCorrection_t whichCor);

  //Masaki's correction

  float MasakiNearJune30_2009(float energy,
                              const CandShowerHandle::ShowerType_t& st);
  float MasakiFarJune30_2009(float energy,
                             const CandShowerHandle::ShowerType_t& st);

  float MasakiNear_forDogwood0(float energy,
                              const CandShowerHandle::ShowerType_t& st);
  float MasakiFar_forDogwood0(float energy,
                             const CandShowerHandle::ShowerType_t& st);

  float MasakiNearDec15th(float energy,
                          const CandShowerHandle::ShowerType_t& st);
  float MasakiFarDec15th(float energy,
                         const CandShowerHandle::ShowerType_t& st);

  float MasakiNearDec15thScaled(float energy,
                                const CandShowerHandle::ShowerType_t& st);
  float MasakiFarDec15thScaled(float energy,
                               const CandShowerHandle::ShowerType_t& st);

  float MasakiNearMay17th(float energy,
                          const CandShowerHandle::ShowerType_t& st);
  float MasakiFarMay17th(float energy,
                         const CandShowerHandle::ShowerType_t& st);

  //Masaki's correction scaled by CG group correction
  float MasakiNearMay17thScaled(float energy,
                                const CandShowerHandle::ShowerType_t& st);
  float MasakiFarMay17thScaled(float energy,
                               const CandShowerHandle::ShowerType_t& st);


  //New under the hood track functions
  float SignedMomentumCurvatureCorrectionCedar(float p, VldContext vc, 
                                               WhichCorrection_t whichCor);
  float SignedMomentumCurvatureCorrectionBirch(float p, VldContext vc, 
                                               WhichCorrection_t whichCor);
  float MomentumRangeCorrectionBirch(float p, VldContext vc,
                                     WhichCorrection_t whichCor);
  float MomentumRangeCorrectionCedar(float p, VldContext vc,
                                     WhichCorrection_t whichCor);
  float EnergyRangeCorrectionCedar(float E, VldContext vc,
                                   WhichCorrection_t whichCor);


  //New function to be called directly from CandShowerHandle to set the GeV
  // value in the reco tree to be as close as possible to correct for the
  // forthcoming Dogwood release
  float ShowerEnergyConversionDogwood(float E, VldContext vc);
  float WeightedShowerEnergyConversionDogwood(float E, VldContext vc);


//**************** Legacy ****************************************
//******************************************************************
// At some point in the future these legacy functions will be removed.
// Use the supported functions above
   //CorrectionVersion_t is now deprecated only remains for legacy code
  typedef enum ECorrectionVersion {
    kUnknown,
    kBirch,
    kCedar,
    kDogwood
  } CorrectionVersion_t;


  //These following functions are now deprecated and only remain for legacy use
  // set static variables to control corrections
  void SetCorrectionVersion(const CorrectionVersion_t& ver,
                            Short_t subver=0);
  std::string GetCorrectionAsString();
  void WarnUnknownVersion(const char* caller_routine);
  CorrectionVersion_t VersionFromFilename(const char*);

  // ****************************************************************
  // **************** Legacy ****************************************


  // Track momentum and energy corrections
  // routines to make energy corrections
  float CorrectMomentumFromRange(float p, bool isdata=true,
                                 Detector::Detector_t det=Detector::kNear);

  float CorrectEnergyFromRange(float E, bool isdata=true,
                               Detector::Detector_t det=Detector::kNear);

  float CorrectSignedMomentumFromCurvature(float p,
                                           bool isdata=true,
                                           Detector::Detector_t det=Detector::kNear);


 // The following code is no longer the correct function to call
 // use FullyCorrectShowerEnergy instead
  //Shower energy corrections
  float CorrectShowerEnergy(float E,
                            const Detector::Detector_t& det,
                            const CandShowerHandle::ShowerType_t& st,
                            int mode=1, bool isdata=true);


  // prefer CorrectShowerEnergy to the following two routines
  // should've really put these "under the hood"
  float CorrectShowerEnergyNear(float E,
                                const CandShowerHandle::ShowerType_t& st,
                                int mode=1, bool isdata=true);

  float CorrectShowerEnergyFar(float E,
                               const CandShowerHandle::ShowerType_t& st,
                               int mode=1, bool isdata=true);

  // private:
  // actual workhorse routines

  //  static CorrectionVersion_t fVersion = EnergyCorrections::kUnknown;
  //  static Short_t fSubVersion = 0;


  // corrections for birch

  float CorrectMomentumFromRange_Birch(float p, bool isdata=true,
                                       Detector::Detector_t det=Detector::kNear);

  float CorrectSignedMomentumFromCurvature_Birch(float p,
                                                 bool isdata=true,
                                                 Detector::Detector_t det=Detector::kNear);

  float CorrectShowerEnergyNear_Birch(float E,
                                      const CandShowerHandle::ShowerType_t& st,
                                      int mode=1, bool isdata=true);

  float CorrectShowerEnergyFar_Birch(float E,
                                     const CandShowerHandle::ShowerType_t& st,
                                     int mode=1, bool isdata=true);

  // corrections for cedar

  float CorrectMomentumFromRange_Cedar(float p, bool isdata=true,
                                       Detector::Detector_t det=Detector::kNear);

  float CorrectSignedMomentumFromCurvature_Cedar(float p,
                                                 bool isdata=true,
                                                 Detector::Detector_t det=Detector::kNear);


  float CorrectShowerEnergyNear_Cedar(float E,
                                      const CandShowerHandle::ShowerType_t& st,
                                      int mode=1, bool isdata=true);


  float CorrectShowerEnergyFar_Cedar(float E,
                                     const CandShowerHandle::ShowerType_t& st,
                                     int mode=1, bool isdata=true);

}
#endif

---