PUCorrection::PU3DCorrectionHelper Struct Reference

#include <PUResidual3DCorrection.h>

Collaboration diagram for PUCorrection::PU3DCorrectionHelper:

Public Member Functions
	~PU3DCorrectionHelper ()
float	correctedPt (float pt, float eta, float area, float rho, float mu, int NPV) const
	Main function which returns the corrected pT.
float	correctionFactor (float pt, float eta, float area, float rho, float mu, int NPV) const
	same as above but returns the ration pT_corrected/pT_uncorrected
float	correction3D (float pt, float eta, float mu, int NPV) const
	calculate the mu,NPV dependent part of the correction.
float	deltaPtCorrection (float pt, float eta) const
	IMPORTANT : the pt must be given in GeV.
void	loadParameters (const std::string &fileName, const std::string &param3D_name="param3D", const std::string &paramDelta_name="paramDeltaPt", const std::string &etaBins_name="etaBins")
	Loads the calib constants from histograms in TFile named fileName.
void	setupClosestNonEmptyBins ()
float	correction3D_noextrap (float pt, float eta, float mu, int NPV) const
	calculate the mu,NPV dependent part of the correction (this is only used for tests and validation) IMPORTANT : the pt must be given in GeV
float	correction3D_interp (float pt, float eta, float mu, int NPV) const

Public Attributes
std::unique_ptr< TAxis >	m_etaBins
std::vector< std::unique_ptr< TH2D > >	m_3Dp0_vs_muNPV
std::vector< std::unique_ptr< TH2D > >	m_3Dp1_vs_muNPV
std::vector< std::unique_ptr< TH2D > >	m_3Dp2_vs_muNPV
TH2D *	m_ref3DHisto = nullptr
bool	m_use3Dp2 =true
std::unique_ptr< TH1F >	m_Dptp0_vs_eta =nullptr
std::unique_ptr< TH1F >	m_Dptp1_vs_eta =nullptr
float	m_maxPt =170.0
float	m_rhoEnergyScale = 0.001
float	m_pTEnergyScale = 0.001
bool	m_applyDeltaPtTerm = true
std::vector< std::vector< int > >	m_closestNonEmpty

Detailed Description

Definition at line 28 of file PUResidual3DCorrection.h.

Constructor & Destructor Documentation

~PU3DCorrectionHelper()

PUCorrection::PU3DCorrectionHelper::~PU3DCorrectionHelper ( )

inline

Definition at line 30 of file PUResidual3DCorrection.h.

                           {
      
    }

Member Function Documentation

correctedPt()

float PUCorrection::PU3DCorrectionHelper::correctedPt ( float pt, float eta, float area, float rho, float mu, int NPV ) const

inline

Main function which returns the corrected pT.

Definition at line 35 of file PUResidual3DCorrection.h.

                                                                                            {
      float areaCorr = area*rho*m_rhoEnergyScale;
 
      float  pt_ref = pt*m_pTEnergyScale ;
      float calibration3D = correction3D(pt_ref - areaCorr ,
                     eta,
                     mu,
                     NPV);
      pt_ref =  pt_ref - areaCorr - calibration3D;
      float deltaPt = 0.0;
      if(m_applyDeltaPtTerm){
        deltaPt = deltaPtCorrection( pt_ref, eta );
      }
 
      return (pt*m_pTEnergyScale -areaCorr - calibration3D + deltaPt)/m_pTEnergyScale;      
    }

correction3D()

float PUCorrection::PU3DCorrectionHelper::correction3D ( float pt, float eta, float mu, int NPV ) const

inline

calculate the mu,NPV dependent part of the correction.

IMPORTANT : the pt must be given in GeV

Definition at line 62 of file PUResidual3DCorrection.h.

                                                                      {
      pt = pt < 1 ? 1 : pt;
      int muNPVbin = std::as_const(m_ref3DHisto)->FindBin(mu, NPV);
      int etaBin = m_etaBins->FindFixBin(std::abs(eta)) - 1;
      float t0 = m_3Dp0_vs_muNPV[ etaBin ]->GetBinContent(muNPVbin);
      if(t0 <= -999.9) {
    muNPVbin = m_closestNonEmpty[etaBin][muNPVbin];
      }
 
      float p0 = m_3Dp0_vs_muNPV[ etaBin ]->GetBinContent(muNPVbin);
      float p1 = m_3Dp1_vs_muNPV[ etaBin ]->GetBinContent(muNPVbin);
      
      if(m_use3Dp2) {
    float p2= m_3Dp2_vs_muNPV[ etaBin ]->GetBinContent(muNPVbin) ;
    return p0+p1*pt+p2*log(pt); 
      }
      return p0+p1*pt;            
    }

correction3D_interp()

float PUCorrection::PU3DCorrectionHelper::correction3D_interp ( float pt, float eta, float mu, int NPV ) const

inline

Definition at line 246 of file PUResidual3DCorrection.h.

                                                                             {
      int etaBin = m_etaBins->FindFixBin(std::abs(eta)) - 1;
      float p0 = m_3Dp0_vs_muNPV[ etaBin ]->Interpolate(mu, NPV);
      float p1 = m_3Dp1_vs_muNPV[ etaBin ]->Interpolate(mu,NPV);
      
      if ( (p0<= -999.9) || (p1<=-999.9) ) return 0;
      
      if(m_use3Dp2) {
    float p2= m_3Dp2_vs_muNPV[ etaBin ]->Interpolate(mu,NPV) ;
    if ( p2<=-999.9 ) return 0;
    return p0+p1*log(pt-p2); 
      }
      return p0+p1*pt;            
    }

correction3D_noextrap()

float PUCorrection::PU3DCorrectionHelper::correction3D_noextrap ( float pt, float eta, float mu, int NPV ) const

inline

calculate the mu,NPV dependent part of the correction (this is only used for tests and validation)
IMPORTANT : the pt must be given in GeV

Definition at line 227 of file PUResidual3DCorrection.h.

                                                                               {
      int muNPVbin = m_ref3DHisto->FindBin(mu, NPV);
      int etaBin = m_etaBins->FindFixBin(std::abs(eta)) - 1;
      float p0 = m_3Dp0_vs_muNPV[ etaBin ]->GetBinContent(muNPVbin);
      float p1 = m_3Dp1_vs_muNPV[ etaBin ]->GetBinContent(muNPVbin);       
 
      
      if ( (p0<= -999.9) || (p1<=-999.9) ) return 0;
      
      if(m_use3Dp2) {
    float p2= m_3Dp2_vs_muNPV[ etaBin ]->GetBinContent(muNPVbin) ;
    if ( p2<=-999.9 ) return 0;
    return p0+p1*log(pt-p2); 
      }
      return p0+p1*pt;            
    }

correctionFactor()

float PUCorrection::PU3DCorrectionHelper::correctionFactor ( float pt, float eta, float area, float rho, float mu, int NPV ) const

inline

same as above but returns the ration pT_corrected/pT_uncorrected

Definition at line 53 of file PUResidual3DCorrection.h.

                                                                                                 {
      float ptCorr = correctedPt(pt,eta,area,rho,mu,NPV);
      return ptCorr/pt;
    }

deltaPtCorrection()

float PUCorrection::PU3DCorrectionHelper::deltaPtCorrection ( float pt, float eta ) const

inline

IMPORTANT : the pt must be given in GeV.

Definition at line 84 of file PUResidual3DCorrection.h.

                                                       {
      int etabin = m_Dptp0_vs_eta->FindBin(std::abs(eta)) ;
      float p0 = m_Dptp0_vs_eta->GetBinContent(etabin);
      float p1 = m_Dptp1_vs_eta->GetBinContent(etabin);
      return p0+pt*p1;
    }

loadParameters()

void PUCorrection::PU3DCorrectionHelper::loadParameters ( const std::string & fileName, const std::string & param3D_name = "param3D", const std::string & paramDelta_name = "paramDeltaPt", const std::string & etaBins_name = "etaBins" )

inline

Loads the calib constants from histograms in TFile named fileName.

Definition at line 94 of file PUResidual3DCorrection.h.

             {
      std::unique_ptr<TFile> tmpF(TFile::Open( fileName.c_str() ));
      std::vector<float> * etaBins_v = (std::vector<float>*)tmpF->Get(etaBins_name.c_str());
      std::vector<double> tmp(etaBins_v->begin(), etaBins_v->end() );
      m_etaBins.reset( new TAxis( tmp.size()-1, tmp.data() ) );
      TList *param3D_l = (TList*) tmpF->Get(param3D_name.c_str());
 
      TList *param3D_p0 = (TList*) param3D_l->At(0);
      m_3Dp0_vs_muNPV.resize( param3D_p0->GetSize() );
      TList *param3D_p1 = (TList*) param3D_l->At(1);
      m_3Dp1_vs_muNPV.resize( param3D_p1->GetSize() );
 
      TList *param3D_p2 = nullptr;
      if(m_use3Dp2) {
    param3D_p2 = (TList*) param3D_l->At(2);
    m_3Dp2_vs_muNPV.resize( param3D_p2->GetSize() );
      }
 
      for(size_t i=0 ; i<(etaBins_v->size()-1); i++){
    m_3Dp0_vs_muNPV[i].reset((TH2D*)param3D_p0->At(i));
    m_3Dp0_vs_muNPV[i]->SetDirectory(nullptr);
    m_3Dp1_vs_muNPV[i].reset((TH2D*)param3D_p1->At(i));
    m_3Dp1_vs_muNPV[i]->SetDirectory(nullptr);
    if(m_use3Dp2) {
      m_3Dp2_vs_muNPV[i].reset( (TH2D*)param3D_p2->At(i) );
      m_3Dp2_vs_muNPV[i]->SetDirectory(nullptr);
    }
      }
      m_ref3DHisto = m_3Dp0_vs_muNPV[0].get();
      
      TList* paramDelta_l = (TList*) tmpF->Get(paramDelta_name.c_str());
      m_Dptp0_vs_eta.reset( (TH1F*) paramDelta_l->At(0) );
      m_Dptp0_vs_eta->SetDirectory(nullptr);
      m_Dptp1_vs_eta.reset( (TH1F*) paramDelta_l->At(1) ) ;      
      m_Dptp1_vs_eta->SetDirectory(nullptr);
      setupClosestNonEmptyBins();
    }

setupClosestNonEmptyBins()

void PUCorrection::PU3DCorrectionHelper::setupClosestNonEmptyBins ( )

inline

Definition at line 138 of file PUResidual3DCorrection.h.

                                   {
      // Pre calculate the positions of the closest non empty bins 
 
      // we have a map (bin -> non-empty bin) for each eta slice :
      m_closestNonEmpty.resize( m_3Dp0_vs_muNPV.size() );
      for(size_t etabin=0;  etabin< m_closestNonEmpty.size() ;etabin++ ){
 
    TH2D *refHisto =  m_3Dp0_vs_muNPV[etabin].get() ;
    int nTot = refHisto->GetNcells();
    TAxis * xax = refHisto->GetXaxis();
    TAxis * yax = refHisto->GetYaxis();
    float xscale = 1./(xax->GetXmax()-xax->GetXmin()); xscale *= xscale;
    float yscale = 1./(yax->GetXmax()-yax->GetXmin()); yscale *= yscale;
    int nbinX = xax->GetNbins();
    int nbinY = yax->GetNbins();
    // initialize the map with -1 :
    m_closestNonEmpty[etabin].resize( nTot, -1 );
 
    // loop over each bin
    for(int xi=1;xi<nbinX+1;xi++) for(int yi=1;yi<nbinY+1;yi++) {
        int bi = refHisto->GetBin(xi,yi);
        if(refHisto->GetBinContent( bi ) >-999.) continue; // non empty bin, we don't need to find anything for it.
 
        int clBin = -1;
        float x0 = xax->GetBinCenter(xi);
        float y0 = yax->GetBinCenter(yi);
        float minDr2=1e10; // just pick a bigger value than any distance in the (mu,NPV) plan
        // loop over other bins to find the closest non-empty :
        for(int xj=1;xj<nbinX+1;xj++) for(int yj=1;yj<nbinY+1;yj++) {
        int bj = refHisto->GetBin(xj,yj);
        if(refHisto->GetBinContent( bj ) <=-999.) continue; // this is an empty bin
        float x = xax->GetBinCenter(xj);
        float y = yax->GetBinCenter(yj);
        float dr2 = (x0-x)*(x0-x)*xscale+(y0-y)*(y0-y)*yscale;
        if(dr2<minDr2){ minDr2 = dr2; clBin = bj;} // found a closest-bin candidate
          }
        m_closestNonEmpty[etabin][bi] = clBin;
      }
 
      }
    }

Member Data Documentation

m_3Dp0_vs_muNPV

std::vector<std::unique_ptr<TH2D> > PUCorrection::PU3DCorrectionHelper::m_3Dp0_vs_muNPV

Definition at line 187 of file PUResidual3DCorrection.h.

m_3Dp1_vs_muNPV

std::vector<std::unique_ptr<TH2D> > PUCorrection::PU3DCorrectionHelper::m_3Dp1_vs_muNPV

Definition at line 188 of file PUResidual3DCorrection.h.

m_3Dp2_vs_muNPV

std::vector<std::unique_ptr<TH2D> > PUCorrection::PU3DCorrectionHelper::m_3Dp2_vs_muNPV

Definition at line 189 of file PUResidual3DCorrection.h.

m_applyDeltaPtTerm

bool PUCorrection::PU3DCorrectionHelper::m_applyDeltaPtTerm = true

Definition at line 203 of file PUResidual3DCorrection.h.

m_closestNonEmpty

std::vector< std::vector<int> > PUCorrection::PU3DCorrectionHelper::m_closestNonEmpty

Definition at line 207 of file PUResidual3DCorrection.h.

m_Dptp0_vs_eta

std::unique_ptr<TH1F> PUCorrection::PU3DCorrectionHelper::m_Dptp0_vs_eta =nullptr

Definition at line 194 of file PUResidual3DCorrection.h.

m_Dptp1_vs_eta

std::unique_ptr<TH1F> PUCorrection::PU3DCorrectionHelper::m_Dptp1_vs_eta =nullptr

Definition at line 195 of file PUResidual3DCorrection.h.

m_etaBins

std::unique_ptr<TAxis> PUCorrection::PU3DCorrectionHelper::m_etaBins

Definition at line 186 of file PUResidual3DCorrection.h.

m_maxPt

float PUCorrection::PU3DCorrectionHelper::m_maxPt =170.0

Definition at line 199 of file PUResidual3DCorrection.h.

m_pTEnergyScale

float PUCorrection::PU3DCorrectionHelper::m_pTEnergyScale = 0.001

Definition at line 201 of file PUResidual3DCorrection.h.

m_ref3DHisto

TH2D* PUCorrection::PU3DCorrectionHelper::m_ref3DHisto = nullptr

Definition at line 190 of file PUResidual3DCorrection.h.

m_rhoEnergyScale

float PUCorrection::PU3DCorrectionHelper::m_rhoEnergyScale = 0.001

Definition at line 200 of file PUResidual3DCorrection.h.

m_use3Dp2

bool PUCorrection::PU3DCorrectionHelper::m_use3Dp2 =true

Definition at line 191 of file PUResidual3DCorrection.h.

---

The documentation for this struct was generated from the following file:

• PUResidual3DCorrection.h