#include <ResidualOffsetCorrection.h>

Inheritance diagram for ResidualOffsetCorrection:

Collaboration diagram for ResidualOffsetCorrection:

Public Member Functions
	ResidualOffsetCorrection ()
	ResidualOffsetCorrection (const std::string &name, TEnv *config, TString jetAlgo, TString calibAreaTag, bool isData, bool dev)
virtual	~ResidualOffsetCorrection ()
virtual StatusCode	initialize ()
double	GetResidualOffset (double abseta, double mu, double NPV, int nJet, bool MuOnly, bool NOnly) const
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Functions providing the same interface as AthMessaging
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

Private Member Functions
double	GetResidualOffsetET (double abseta, double mu, double NPV, int nJet, bool MuOnly, bool NOnly, const std::vector< double > &OffsetMu, const std::vector< double > &OffsetNPV, const std::vector< double > &OffsetNjet, const TAxis *OffsetBins) const
double	GetNPVBeamspotCorrection (double NPV) const
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
TEnv *	m_config {}
TString	m_jetAlgo
TString	m_calibAreaTag
bool	m_dev {}
bool	m_isData {}
NPVBeamspotCorrection *	m_npvBeamspotCorr {}
TString	m_resOffsetDesc
TAxis *	m_resOffsetBins {}
bool	m_applyNPVBeamspotCorrection {}
double	m_muSF {}
double	m_mu_ref {}
double	m_NPV_ref {}
double	m_nJet_ref {}
bool	m_useNjet {}
std::vector< double >	m_resOffsetMu
std::vector< double >	m_resOffsetNPV
std::vector< double >	m_resOffsetNjet
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Static Private Attributes
static constexpr float	m_GeV = 1000

Detailed Description

Definition at line 26 of file ResidualOffsetCorrection.h.

Constructor & Destructor Documentation

◆ ResidualOffsetCorrection() [1/2]

ResidualOffsetCorrection::ResidualOffsetCorrection ( )

Definition at line 15 of file ResidualOffsetCorrection.cxx.

  : asg::AsgMessaging("ResidualOffsetCorrection"),
    m_config(nullptr), m_jetAlgo(""), m_calibAreaTag(""), m_dev(false), m_isData(false),
    m_npvBeamspotCorr(nullptr), m_resOffsetBins(nullptr)
{ }

◆ ResidualOffsetCorrection() [2/2]

ResidualOffsetCorrection::ResidualOffsetCorrection	(	const std::string &	name,
		TEnv *	config,
		TString	jetAlgo,
		TString	calibAreaTag,
		bool	isData,
		bool	dev )

Definition at line 21 of file ResidualOffsetCorrection.cxx.

  : asg::AsgMessaging(name),
    m_config(config), m_jetAlgo(std::move(jetAlgo)), m_calibAreaTag(std::move(calibAreaTag)), m_dev(dev), m_isData(isData),
    m_npvBeamspotCorr(nullptr), m_resOffsetBins(nullptr)
{ }

◆ ~ResidualOffsetCorrection()

ResidualOffsetCorrection::~ResidualOffsetCorrection ( )

virtual

Definition at line 27 of file ResidualOffsetCorrection.cxx.

                                                    {
 
  if(m_npvBeamspotCorr) delete m_npvBeamspotCorr;
  if(m_resOffsetBins) delete m_resOffsetBins;
 
}

Member Function Documentation

◆ GetNPVBeamspotCorrection()

double ResidualOffsetCorrection::GetNPVBeamspotCorrection ( double NPV ) const

private

Definition at line 179 of file ResidualOffsetCorrection.cxx.

                                                                          {
  if(!m_isData && m_applyNPVBeamspotCorrection) return std::as_const(m_npvBeamspotCorr)->GetNVertexBsCorrection(NPV);
  return NPV;
}

◆ GetResidualOffset()

double ResidualOffsetCorrection::GetResidualOffset	(	double	abseta,
		double	mu,
		double	NPV,
		int	nJet,
		bool	MuOnly,
		bool	NOnly ) const

Definition at line 118 of file ResidualOffsetCorrection.cxx.

                                                                                               {
  return GetResidualOffsetET(abseta, mu, NPV, nJet, MuOnly, NOnly,
                             m_resOffsetMu, m_resOffsetNPV, m_resOffsetNjet, m_resOffsetBins);
}

◆ GetResidualOffsetET()

double ResidualOffsetCorrection::GetResidualOffsetET	(	double	abseta,
		double	mu,
		double	NPV,
		int	nJet,
		bool	MuOnly,
		bool	NOnly,
		const std::vector< double > &	OffsetMu,
		const std::vector< double > &	OffsetNPV,
		const std::vector< double > &	OffsetNjet,
		const TAxis *	OffsetBins ) const

private

Definition at line 124 of file ResidualOffsetCorrection.cxx.

                                                                                      {
 
  //mu rescaling
  const double muCorr = m_isData ? mu : mu*m_muSF;
  if(m_useNjet) {
    // further correction to nJet if desired
    int nJetCorr = nJet;
 
    double alpha, beta, etaEdge;
    if(!MuOnly){ beta    = OffsetNjet[0];
    } else { beta  = 0; }
    if(!NOnly){ alpha = OffsetMu[0];
    } else { alpha = 0; }
    etaEdge=0;
    int bin=1;
    for (;bin<=OffsetBins->GetNbins();++bin) {
      etaEdge = OffsetBins->GetBinLowEdge(bin);
      const double width=OffsetBins->GetBinWidth(bin);
      if (abseta<etaEdge+width) break;
      if(!NOnly)  alpha += width*OffsetMu[bin];
      if(!MuOnly) beta  += width*OffsetNjet[bin];
    }
    if(!NOnly)  alpha += OffsetMu[bin]*(abseta-etaEdge);
    if(!MuOnly) beta  += OffsetNjet[bin]*(abseta-etaEdge);
    return (alpha*(muCorr-m_mu_ref) + beta*(nJetCorr-m_nJet_ref))*m_GeV;
  } else {
    //NPV beamspot correction
    const double NPVCorr = GetNPVBeamspotCorrection(NPV);
 
    double alpha, beta, etaEdge;
    if(!MuOnly){ beta   = OffsetNPV[0];
    } else { beta  = 0; }
    if(!NOnly){ alpha = OffsetMu[0];
    } else { alpha = 0; }
    etaEdge = 0;
    int bin=1;
    for (;bin<=OffsetBins->GetNbins();++bin) {
      etaEdge = OffsetBins->GetBinLowEdge(bin);
      const double width=OffsetBins->GetBinWidth(bin);
      if (abseta<etaEdge+width) break;
      if(!NOnly)  alpha += width*OffsetMu[bin];
      if(!MuOnly) beta  += width*OffsetNPV[bin];
    }
    if(!NOnly)  alpha += OffsetMu[bin]*(abseta-etaEdge);
    if(!MuOnly) beta  += OffsetNPV[bin]*(abseta-etaEdge);
    return (alpha*(muCorr-m_mu_ref) + beta*(NPVCorr-m_NPV_ref))*m_GeV;
  }
  
}

◆ initialize()

StatusCode ResidualOffsetCorrection::initialize ( )

virtual

Definition at line 34 of file ResidualOffsetCorrection.cxx.

                                                {
 
  //Read mu scale factor from global config
  m_muSF = m_config->GetValue("MuScaleFactor",1.0);
 
  // Read useNjet from global config
  m_useNjet = m_config->GetValue("OffsetCorrection.UseNjet",false);
 
  bool doMuOnly   = m_config->GetValue("ApplyOnlyMuResidual",false);
  bool doNPVOnly  = m_config->GetValue("ApplyOnlyNPVResidual",false);
  bool doNJetOnly = m_config->GetValue("ApplyOnlyNJetResidual",false);
  
  //Read reference mu, NPV and nJet from global config
  m_mu_ref = m_config->GetValue("OffsetCorrection.DefaultMuRef",-99.0);
  if (m_mu_ref==-99 && !doNPVOnly && !doNJetOnly) {
    ATH_MSG_FATAL("OffsetCorrection.DefaultMuRef not specified.");
    return StatusCode::FAILURE;
  }
  m_NPV_ref = m_config->GetValue("OffsetCorrection.DefaultNPVRef",-99.0);
  if (m_NPV_ref==-99 && !doMuOnly && !m_useNjet) {
    ATH_MSG_FATAL("OffsetCorrection.DefaultNPVRef not specified.");
    return StatusCode::FAILURE;
  }
 
  if (m_NPV_ref==-99 && !doMuOnly && !m_useNjet) {
    ATH_MSG_FATAL("OffsetCorrection.DefaultNPVRef not specified.");
    return StatusCode::FAILURE;
  }
  m_nJet_ref = m_config->GetValue("OffsetCorrection.DefaultNjetRef",-99.0);
  if (m_nJet_ref==-99 && m_useNjet) {
    ATH_MSG_FATAL("OffsetCorrection.DefaultNjetRef not specified.");
    return StatusCode::FAILURE;
  }
  
  //Add the residual offset correction factors to the config TEnv
  TString ResidualOffsetCalibFile = m_config->GetValue("ResidualOffset.CalibFile","");
  if(m_dev){
    ResidualOffsetCalibFile.Remove(0,33);
    ResidualOffsetCalibFile.Insert(0,"JetCalibTools/");
  }
  else{ResidualOffsetCalibFile.Insert(14,m_calibAreaTag);}
  TString calibFile = PathResolverFindCalibFile(ResidualOffsetCalibFile.Data());
  m_config->ReadFile(calibFile, kEnvLocal);
  //Retrieve information specific to the residual offset correction from the TEnv
  TString offsetName = m_config->GetValue("ResidualOffsetCorrection.Name","");
  m_resOffsetDesc = m_config->GetValue(offsetName+".Description","");
  ATH_MSG_INFO("Reading residual jet-area pile-up correction factors from: " << calibFile);
  ATH_MSG_INFO("Description: " << m_resOffsetDesc);
 
  //Check if the config is set to apply the beamspot correction to NPV
  m_applyNPVBeamspotCorrection = m_config->GetValue("ApplyNPVBeamspotCorrection",false);
 
  std::vector<double> offsetEtaBins = JetCalibUtils::VectorizeD( m_config->GetValue(offsetName+".AbsEtaBins","") );
  if (offsetEtaBins.size()<3) { ATH_MSG_FATAL(offsetName << ".AbsEtaBins not specified"); return StatusCode::FAILURE; }
  m_resOffsetBins = new TAxis(offsetEtaBins.size()-1,&offsetEtaBins[0]);
 
  if(!doNPVOnly && !doNJetOnly){
    m_resOffsetMu = JetCalibUtils::VectorizeD(m_config->GetValue(offsetName+".MuTerm."+m_jetAlgo,""));
    if ( (int)m_resOffsetMu.size()!=m_resOffsetBins->GetNbins()+1 ) {
      ATH_MSG_FATAL( "Incorrect specification of " << offsetName << ".MuTerm." << m_jetAlgo );
      return StatusCode::FAILURE;
    }
  }
  if(m_useNjet) {
    m_resOffsetNjet = JetCalibUtils::VectorizeD(m_config->GetValue(offsetName+".nJetTerm."+m_jetAlgo,""));
    if ((int)m_resOffsetNjet.size()!=m_resOffsetBins->GetNbins()+1) {
      ATH_MSG_FATAL( "Incorrect specification of " << offsetName << ".nJetTerm." << m_jetAlgo );
      return StatusCode::FAILURE;
    }
  } else if(!doMuOnly){
    m_resOffsetNPV = JetCalibUtils::VectorizeD(m_config->GetValue(offsetName+".NPVTerm."+m_jetAlgo,""));
    if ((int)m_resOffsetNPV.size()!=m_resOffsetBins->GetNbins()+1) {
      ATH_MSG_FATAL( "Incorrect specification of " << offsetName << ".NPVTerm." << m_jetAlgo );
      return StatusCode::FAILURE;
    }
    if( m_applyNPVBeamspotCorrection) {
      m_npvBeamspotCorr = new NPVBeamspotCorrection();
      ATH_MSG_INFO("\n  NPV beamspot correction will be applied.");
    } 
  }
  
  return StatusCode::SUCCESS;
}

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const

inherited

The standard message stream.

Returns: A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

                                      {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg();
#else // not XAOD_STANDALONE
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns: A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

                                                          {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg( lvl );
#else // not XAOD_STANDALONE
      m_msg << lvl;
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns: boolean Indicting if messages at given level will be printed; true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

                                                       {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msgLvl( lvl );
#else // not XAOD_STANDALONE
      return m_msg.msgLevel( lvl );
#endif // not XAOD_STANDALONE
   }

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_applyNPVBeamspotCorrection

bool ResidualOffsetCorrection::m_applyNPVBeamspotCorrection {}

private

Definition at line 58 of file ResidualOffsetCorrection.h.

58{};

◆ m_calibAreaTag

TString ResidualOffsetCorrection::m_calibAreaTag

private

Definition at line 49 of file ResidualOffsetCorrection.h.

◆ m_config

TEnv* ResidualOffsetCorrection::m_config {}

private

Definition at line 48 of file ResidualOffsetCorrection.h.

48{};

◆ m_dev

bool ResidualOffsetCorrection::m_dev {}

private

Definition at line 50 of file ResidualOffsetCorrection.h.

50{};

◆ m_GeV

float ResidualOffsetCorrection::m_GeV = 1000

staticconstexprprivate

Definition at line 52 of file ResidualOffsetCorrection.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_isData

bool ResidualOffsetCorrection::m_isData {}

private

Definition at line 51 of file ResidualOffsetCorrection.h.

51{};

◆ m_jetAlgo

TString ResidualOffsetCorrection::m_jetAlgo

private

Definition at line 49 of file ResidualOffsetCorrection.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_mu_ref

double ResidualOffsetCorrection::m_mu_ref {}

private

Definition at line 60 of file ResidualOffsetCorrection.h.

60{}, m_NPV_ref{}, m_nJet_ref{};

◆ m_muSF

double ResidualOffsetCorrection::m_muSF {}

private

Definition at line 59 of file ResidualOffsetCorrection.h.

59{};

◆ m_nJet_ref

double ResidualOffsetCorrection::m_nJet_ref {}

private

Definition at line 60 of file ResidualOffsetCorrection.h.

60{}, m_NPV_ref{}, m_nJet_ref{};

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_NPV_ref

double ResidualOffsetCorrection::m_NPV_ref {}

private

Definition at line 60 of file ResidualOffsetCorrection.h.

60{}, m_NPV_ref{}, m_nJet_ref{};

◆ m_npvBeamspotCorr

NPVBeamspotCorrection* ResidualOffsetCorrection::m_npvBeamspotCorr {}

private

Definition at line 54 of file ResidualOffsetCorrection.h.

54{};

◆ m_resOffsetBins

TAxis* ResidualOffsetCorrection::m_resOffsetBins {}

private

Definition at line 57 of file ResidualOffsetCorrection.h.

57{};

◆ m_resOffsetDesc

TString ResidualOffsetCorrection::m_resOffsetDesc

private

Definition at line 56 of file ResidualOffsetCorrection.h.

◆ m_resOffsetMu

std::vector<double> ResidualOffsetCorrection::m_resOffsetMu

private

Definition at line 63 of file ResidualOffsetCorrection.h.

◆ m_resOffsetNjet

std::vector<double> ResidualOffsetCorrection::m_resOffsetNjet

private

Definition at line 63 of file ResidualOffsetCorrection.h.

◆ m_resOffsetNPV

std::vector<double> ResidualOffsetCorrection::m_resOffsetNPV

private

Definition at line 63 of file ResidualOffsetCorrection.h.

◆ m_useNjet

bool ResidualOffsetCorrection::m_useNjet {}

private

Definition at line 61 of file ResidualOffsetCorrection.h.

61{};

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ResidualOffsetCorrection() [1/2]

◆ ResidualOffsetCorrection() [2/2]

◆ ~ResidualOffsetCorrection()

Member Function Documentation

◆ GetNPVBeamspotCorrection()

◆ GetResidualOffset()

◆ GetResidualOffsetET()

◆ initialize()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ setLevel()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_applyNPVBeamspotCorrection

◆ m_calibAreaTag

◆ m_config

◆ m_dev

◆ m_GeV

◆ m_imsg

◆ m_isData

◆ m_jetAlgo

◆ m_lvl

◆ m_msg_tls

◆ m_mu_ref

◆ m_muSF

◆ m_nJet_ref

◆ m_nm

◆ m_NPV_ref

◆ m_npvBeamspotCorr

◆ m_resOffsetBins

◆ m_resOffsetDesc

◆ m_resOffsetMu

◆ m_resOffsetNjet

◆ m_resOffsetNPV

◆ m_useNjet