IPileupReweightingTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 

#ifndef PILEUPREWEIGHTING_IPILEUPREWEIGHTINGTOOL_H
#define PILEUPREWEIGHTING_IPILEUPREWEIGHTINGTOOL_H
 
#include "AsgTools/IAsgTool.h"
#include "TString.h"
#include "xAODEventInfo/EventInfo.h"
 
#include "PATInterfaces/ISystematicsTool.h"
#include "AsgAnalysisInterfaces/IGoodRunsListSelectionTool.h"

 
 
 
class TH1;
 
namespace CP {
class TPileupReweighting;
 
   class IPileupReweightingTool : virtual public CP::ISystematicsTool
{
 
      ASG_TOOL_INTERFACE( CP::IPileupReweightingTool )
 
      public:
 

         virtual float getCombinedWeight( const xAOD::EventInfo& eventInfo, bool correctUnrepresented=false ) = 0;

         virtual float getCombinedWeight( const xAOD::EventInfo& eventInfo,Double_t x, Double_t y=0., bool correctUnrepresented=false ) = 0;

         virtual float getCombinedWeight( const xAOD::EventInfo& eventInfo , const TString& trigger, bool mu_dependent=true, bool correctUnrepresented=false ) = 0;

         virtual float getUnrepresentedDataWeight( const xAOD::EventInfo& eventInfo ) = 0;

         virtual float getDataWeight( const xAOD::EventInfo& eventInfo, const TString& trigger, bool mu_dependent=true ) = 0;

        virtual float getPrescaleWeight( const xAOD::EventInfo& eventInfo , const TString& trigger, bool mu_dependent=true ) = 0;

         virtual int getRandomRunNumber( const xAOD::EventInfo& eventInfo , bool mu_dependent=true) = 0;

         virtual float getCorrectedMu( const xAOD::EventInfo& eventInfo, bool includedDataScaleFactor=false ) {
            return getCorrectedAverageInteractionsPerCrossing( eventInfo, includedDataScaleFactor );
         }
         virtual float getCorrectedAverageInteractionsPerCrossing( const xAOD::EventInfo& eventInfo, bool includedDataScaleFactor=false ) = 0;
         
         virtual float getCorrectedActualInteractionsPerCrossing( const xAOD::EventInfo& eventInfo, bool includedDataScaleFactor=false ) = 0;
         
         virtual double getLumiBlockIntegratedLumi( const xAOD::EventInfo& eventInfo ) = 0;

         virtual StatusCode apply ( const xAOD::EventInfo& eventInfo, bool mu_dependent=true ) = 0;
 

         virtual ULong64_t getPRWHash( const xAOD::EventInfo& eventInfo ) = 0;
 
         // methods that go straight to the underlying pileup tool 

         virtual UInt_t GetRandomLumiBlockNumber(UInt_t runNumber) = 0;

         virtual Double_t GetSumOfEventWeights(Int_t channel) = 0;
         virtual Double_t GetNumberOfEvents(Int_t channel) = 0;

         virtual Double_t GetIntegratedLumi(UInt_t start, UInt_t end) = 0;
         virtual Double_t GetIntegratedLumi(const TString& trigger="") = 0;
         virtual Double_t GetIntegratedLumi(Int_t periodNumber, UInt_t start, UInt_t end) = 0;
         virtual Double_t GetIntegratedLumiFraction(Int_t periodNumber, UInt_t start, UInt_t end) = 0;
         virtual Double_t GetIntegratedLumiFraction(Int_t periodNumber, Double_t mu, UInt_t start, UInt_t end) = 0;
 

         virtual Int_t AddPeriod(Int_t periodNumber, UInt_t start, UInt_t end) = 0;
         virtual Int_t SetBinning(Int_t nbinsx, Double_t* xbins, Int_t nbinsy=0, Double_t* ybins=0) = 0;
         virtual Int_t SetUniformBinning(Int_t nbinsx, Double_t xlow, Double_t xup, Int_t nbinsy=0, Double_t ylow=0, Double_t yup=0) = 0;
         virtual Int_t SetBinning(TH1* hist) = 0;

         virtual int fill( const xAOD::EventInfo& eventInfo ) = 0;

         virtual int fill( const xAOD::EventInfo& eventInfo, Double_t x, Double_t y=0.) = 0;
 

         virtual CP::TPileupReweighting* expert() = 0;
 
 
   };
 
}
 
 
 
#endif