#include <Pileup1DResidualCalibStep.h>

Inheritance diagram for Pileup1DResidualCalibStep:

Collaboration diagram for Pileup1DResidualCalibStep:

Public Member Functions
	Pileup1DResidualCalibStep (const std::string &name="Pileup1DResidualCalibStep")

virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual StatusCode	calibrate (xAOD::JetContainer &jetCont) const override
	Apply calibration to a jet container. More...

double	getResidualOffset (double abseta, double mu, double NPV, int nJet, bool MuOnly, bool NOnly) const

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

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

bool	msgLvl (const MSG::Level lvl) const

virtual StatusCode	getNominalResolutionData (const xAOD::Jet &, const JetHelper::JetContext &, double &) const

virtual StatusCode	getNominalResolutionMC (const xAOD::Jet &, const JetHelper::JetContext &, double &) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< bool >	m_isData {this, "IsData", false, ""}

Gaudi::Property< bool >	m_doJetArea {this, "DoJetArea", false, "doc"}

SG::ReadDecorHandleKey< xAOD::EventInfo >	m_muKey

SG::ReadHandleKey< xAOD::EventShape >	m_rhoKey {this, "RhoKey", "auto"}

SG::ReadHandleKey< xAOD::VertexContainer >	m_pvKey {this, "PrimaryVerticesContainerName", "PrimaryVertices"}

Gaudi::Property< bool >	m_doMuOnly {this, "ApplyOnlyMuResidual", false, "doc"}

Gaudi::Property< bool >	m_doNPVOnly {this, "ApplyOnlyNPVResidual", false, "doc"}

Gaudi::Property< bool >	m_doNJetOnly {this, "ApplyOnlyNJetResidual", false, "doc"}

Gaudi::Property< float >	m_NPV_ref {this , "DefaultNPVRef", -99., ""}

Gaudi::Property< float >	m_mu_ref {this , "DefaultMuRef", -99., ""}

Gaudi::Property< float >	m_nJet_ref {this , "DefaultNjetRef", -99., ""}

Gaudi::Property< float >	m_muSF {this , "MuScaleFactor", 1., ""}

SG::ReadHandleKey< xAOD::JetContainer >	m_nJetContainerKey

Gaudi::Property< bool >	m_useNjet {this , "UseNjet", false, ""}

Gaudi::Property< int >	m_njetThreshold {this , "nJetThreshold", 20, ""}

Gaudi::Property< std::string >	m_calibFile {this, "CalibFile", "none", "residual offset calib file"}

Gaudi::Property< std::string >	m_corrName {this, "CorrectionName", "none", ""}

Gaudi::Property< std::string >	m_corrDesc {this, "CorrectionDesc", "none", ""}

Gaudi::Property< std::vector< double > >	m_offsetEtaBins {this, "AbsEtaBins", {} ,""}

Gaudi::Property< std::vector< double > >	m_resOffsetMu {this, "MuTerm", {} ,""}

Gaudi::Property< std::vector< double > >	m_resOffsetNjet {this, "nJetTerm", {} ,""}

Gaudi::Property< std::vector< double > >	m_resOffsetNPV {this, "NPVTerm", {} ,""}

TAxis *	m_resOffsetBins =nullptr

Gaudi::Property< bool >	m_applyNPVBeamspotCorrection {this, "ApplyNPVBeamspotCorrection", false, "doc"}

NPVBeamspotCorrection *	m_npvBeamspotCorr {}

Gaudi::Property< bool >	m_doSequentialResidual {this, "DoSequentialResidual", false, "doc"}

Gaudi::Property< bool >	m_doOnlyResidual {this, "OnlyResidual", false, ""}

Gaudi::Property< std::string >	m_originScale {this, "OriginScale", "", "scale from which correction is applied" }

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 33 of file Pileup1DResidualCalibStep.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ Pileup1DResidualCalibStep()

Pileup1DResidualCalibStep::Pileup1DResidualCalibStep ( const std::string & name = "Pileup1DResidualCalibStep" )

Definition at line 21 of file Pileup1DResidualCalibStep.cxx.

22 : asg::AsgTool( name ) { }

Member Function Documentation

◆ calibrate()

StatusCode Pileup1DResidualCalibStep::calibrate ( xAOD::JetContainer & jets ) const

overridevirtual

Apply calibration to a jet container.

Implements IJetCalibStep.

Definition at line 105 of file Pileup1DResidualCalibStep.cxx.

                                                                                {
  
   SG::ReadDecorHandle<xAOD::EventInfo,float> eventInfoDecor(m_muKey);
   CHECK_THEN_ERROR( ! eventInfoDecor.isPresent() , "EventInfo decoration not available! "<< m_muKey.key() );
   double mu = eventInfoDecor(0) ;
   
   
   SG::ReadHandle<xAOD::VertexContainer> PVCont(m_pvKey);
   CHECK_THEN_ERROR( ! PVCont.isValid() , "No Primary Vertices "<< m_pvKey.key() );
   double NPV = JetCalibUtils::countNPV(*PVCont);
  
   SG::ReadHandle<xAOD::EventShape> eventShape(m_rhoKey);
   CHECK_THEN_ERROR( ! eventShape.isValid() , "Could not retrieve xAOD::EventShape DataHandle : "<< m_rhoKey.key());
   double rho=0;
   CHECK_THEN_ERROR( ! eventShape->getDensity(xAOD::EventShape::Density, rho ),
           "Could not retrieve xAOD::EventShape::Density from xAOD::EventShape "<< m_rhoKey.key() );
  
   int nJets=0;
   if(m_useNjet){
     SG::ReadHandle<xAOD::JetContainer> nJetCont(m_nJetContainerKey);
     CHECK_THEN_ERROR( !nJetCont.isValid() , "Jet container needed for nJet not found: "<< m_nJetContainerKey.key());
     for(const xAOD::Jet*jet: *nJetCont){
       if(jet->pt()/1000. > m_njetThreshold)
     nJets += 1;
     }      
   }
  
  
   ATH_MSG_DEBUG("  Rho = " << 0.001*rho << " GeV");
   static const double toGeV = 0.001;
   const xAOD::JetAttributeAccessor::AccessorWrapper<xAOD::JetFourMom_t> areaAcc("ActiveArea4vec");  
   const xAOD::JetAttributeAccessor::AccessorWrapper<xAOD::JetFourMom_t> puScaleMomAcc("JetPileupScaleMomentum");  
   SG::AuxElement::Accessor<int> puCorrectedAcc("PileupCorrected");
  
   for( xAOD::Jet * jet : jetCont){
  
     // Assume Jet start scale is ok (?)
     xAOD::JetFourMom_t jetStartP4 = jet->jetP4();
     
     const double E_det = jetStartP4.e();
     const double pT_det = jetStartP4.pt();
     const double eta_det = jetStartP4.eta();
     const double mass_det = jetStartP4.mass();
  
     if ( E_det < mass_det ) {
       ATH_MSG_ERROR( "JetPileupCorrection::calibrateImpl : Current jet has mass=" << mass_det*toGeV << " GeV, which is greater than it's energy=" << E_det*toGeV << " GeV?? Aborting." );
       return StatusCode::FAILURE;
     }
  
     xAOD::JetFourMom_t jetareaP4 = areaAcc.getAttribute(*jet);
     ATH_MSG_VERBOSE("    Area = " << jetareaP4);
  
     double offsetET  = 0;  // pT residual subtraction
     double pT_offset = pT_det; // pT difference before/after pileup corrections
     double pileup_SF = 1; // final calibration factor applied to the four vector
  
     xAOD::JetFourMom_t calibP4;
     if(!m_doSequentialResidual){ // Default, both corrections are applied simultaneously
  
       offsetET = getResidualOffset(fabs(eta_det), mu, NPV, nJets, m_doMuOnly, m_doNPVOnly||m_doNJetOnly);
  
       // Calculate the pT after jet areas and residual offset
       pT_offset = m_doJetArea ? pT_det - rho*jetareaP4.pt() - offsetET : pT_det - offsetET;
  
       // Set the jet pT to 10 MeV if the pT is negative after the jet area and residual offset corrections
       pileup_SF = pT_offset >= 0 ? pT_offset / pT_det : 10./pT_det;
  
       calibP4 = jetStartP4*pileup_SF;
       
     }else{
       // Calculate mu-based correction factor
       offsetET    = getResidualOffset(fabs(eta_det), mu, NPV, nJets, true, false);
       pT_offset   = m_doJetArea ? pT_det - rho*jetareaP4.pt() - offsetET : pT_det - offsetET;
       double muSF = pT_offset >= 0 ? pT_offset / pT_det : 10./pT_det;
  
       calibP4 = jetStartP4*muSF;
  
       // Calculate and apply NPV/Njet-based calibration
       offsetET = getResidualOffset(fabs(eta_det), mu, NPV, nJets, false, true);
       double pT_afterMuCalib = calibP4.pt();
       pT_offset = pT_afterMuCalib - offsetET;
       double SF = pT_offset >= 0 ? pT_offset / pT_afterMuCalib : 10./pT_afterMuCalib;
       calibP4   = calibP4*SF;
       
     }
  
     //Attribute to track if a jet has received the pileup subtraction (always true if this code was run)
     puCorrectedAcc(*jet) = 1 ;    
     //Transfer calibrated jet properties to the Jet object
     puScaleMomAcc.setAttribute(*jet, calibP4 );
     jet->setJetP4( calibP4 );        
     
   }
   
   
   return StatusCode::SUCCESS;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getNominalResolutionData()

virtual StatusCode IJetCalibStep::getNominalResolutionData	(	const xAOD::Jet &	,
		const JetHelper::JetContext &	,
		double &
	)		const

inlinevirtualinherited

Reimplemented in SmearingCalibStep.

Definition at line 38 of file IJetCalibStep.h.

38 { return StatusCode::FAILURE; }

◆ getNominalResolutionMC()

virtual StatusCode IJetCalibStep::getNominalResolutionMC	(	const xAOD::Jet &	,
		const JetHelper::JetContext &	,
		double &
	)		const

inlinevirtualinherited

Reimplemented in SmearingCalibStep.

Definition at line 39 of file IJetCalibStep.h.

39 { return StatusCode::FAILURE; }

◆ getNPVBeamspotCorrection()

double Pileup1DResidualCalibStep::getNPVBeamspotCorrection ( double NPV ) const

private

Definition at line 266 of file Pileup1DResidualCalibStep.cxx.

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

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ getResidualOffset()

double Pileup1DResidualCalibStep::getResidualOffset	(	double	abseta,
		double	mu,
		double	NPV,
		int	nJet,
		bool	MuOnly,
		bool	NOnly
	)		const

Definition at line 204 of file Pileup1DResidualCalibStep.cxx.

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

◆ getResidualOffsetET()

double Pileup1DResidualCalibStep::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 210 of file Pileup1DResidualCalibStep.cxx.

                                                                                       {
  
   static const double toMeV= 1000.;
   //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))*toMeV;
   } 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))*toMeV;
   }
   
 }

◆ initialize()

StatusCode Pileup1DResidualCalibStep::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 27 of file Pileup1DResidualCalibStep.cxx.

                                                  {
  
   if(m_doJetArea && m_doOnlyResidual){
     ATH_MSG_FATAL("If you're trying to apply only the Residual pile up correction, it needs to be specify in the Calibration Sequence. ApplyOnlyResidual should be true in the configuration file and the PileupStartScale should be specified.");
     return StatusCode::FAILURE;
   }
   
   ATH_CHECK( m_muKey.initialize() );
   ATH_CHECK( m_pvKey.initialize() );
   ATH_CHECK( m_rhoKey.initialize() );
   ATH_CHECK(m_nJetContainerKey.initialize(SG::AllowEmpty));
  
   
   
   if(m_doSequentialResidual) ATH_MSG_DEBUG("The pileup residual calibrations will be applied sequentially.");
   else                       ATH_MSG_DEBUG("The pileup residual calibrations will be applied simultaneously (default).");
   if(m_doMuOnly)             ATH_MSG_INFO("Only the pileup mu-based calibration will be applied.");
   if(m_doNPVOnly)            ATH_MSG_INFO("Only the pileup NPV-based calibration will be applied.");
   if(m_doNJetOnly)           ATH_MSG_INFO("Only the pileup NJet-based calibration will be applied.");
   if (m_useNjet)             ATH_MSG_DEBUG("NJet will be used instead of NPV in the pileup corrections.");
  
   // Protections
   CHECK_THEN_ERROR( m_doSequentialResidual && (m_doMuOnly || m_doNPVOnly || m_doNJetOnly) ,
             "Sequential residual calibration can not be applied in doMuOnly or doNPVOnly or doNJetOnly cases.");
   
   CHECK_THEN_ERROR(m_useNjet && (m_doMuOnly || m_doNPVOnly),
            "Conflicting configuation, UseNjet true but doMuOnly or doNPVOnly also true.");
   
   CHECK_THEN_ERROR(m_doMuOnly && m_doNPVOnly,
            "It was requested to apply only the mu-based AND the NPV-based calibrations.");
     
   CHECK_THEN_ERROR(m_doMuOnly && m_doNJetOnly, 
            "It was requested to apply only the mu-based AND the NJet-based calibrations.");
  
   CHECK_THEN_ERROR(!m_useNjet && m_doNJetOnly, 
            "It was requested to apply only the NJet-based calibration but not to use Njet instead of NPV.");
  
   CHECK_THEN_ERROR(m_doNJetOnly && m_doNPVOnly, 
            "It was requested to apply NJet-based and NPV calibrations.");
  
   if(m_doJetArea) ATH_MSG_INFO("Jet area pile up correction will be applied.");
  
  
   CHECK_THEN_ERROR( (m_mu_ref==-99 && !m_doNPVOnly && !m_doNJetOnly),
             "OffsetCorrection.DefaultMuRef not specified.");
     
   CHECK_THEN_ERROR( (m_NPV_ref==-99 && !m_doMuOnly && !m_useNjet),
             "OffsetCorrection.DefaultNPVRef not specified.");
     
   CHECK_THEN_ERROR( (m_nJet_ref==-99 && m_useNjet),
             "OffsetCorrection.DefaultNjetRef not specified.");
  
   
   m_resOffsetBins = new TAxis(m_offsetEtaBins.size()-1,&m_offsetEtaBins[0]);
  
   if(!m_doNPVOnly && !m_doNJetOnly){  
     CHECK_THEN_ERROR( (int)m_resOffsetMu.size()!=(m_resOffsetBins->GetNbins()+1),
               "Incorrect specification of MuTerm binning"  );
   }
   
   if(m_useNjet) {
     CHECK_THEN_ERROR( (int)m_resOffsetNjet.size()!= (m_resOffsetBins->GetNbins()+1), 
               "Incorrect specification of nJetTerm binning."  );
   } else if(!m_doMuOnly){
     CHECK_THEN_ERROR( (int)m_resOffsetNPV.size()!= (m_resOffsetBins->GetNbins()+1), 
               "Incorrect specification of NPVTerm binning."  );
  
     if( m_applyNPVBeamspotCorrection) {
       m_npvBeamspotCorr = new NPVBeamspotCorrection();
       ATH_MSG_INFO("\n  NPV beamspot correction will be applied.");
     } 
   }
   
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_applyNPVBeamspotCorrection

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_applyNPVBeamspotCorrection {this, "ApplyNPVBeamspotCorrection", false, "doc"}

private

Definition at line 104 of file Pileup1DResidualCalibStep.h.

◆ m_calibFile

Gaudi::Property<std::string> Pileup1DResidualCalibStep::m_calibFile {this, "CalibFile", "none", "residual offset calib file"}

private

Definition at line 92 of file Pileup1DResidualCalibStep.h.

◆ m_corrDesc

Gaudi::Property<std::string> Pileup1DResidualCalibStep::m_corrDesc {this, "CorrectionDesc", "none", ""}

private

Definition at line 95 of file Pileup1DResidualCalibStep.h.

◆ m_corrName

Gaudi::Property<std::string> Pileup1DResidualCalibStep::m_corrName {this, "CorrectionName", "none", ""}

private

Definition at line 94 of file Pileup1DResidualCalibStep.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doJetArea

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_doJetArea {this, "DoJetArea", false, "doc"}

private

Definition at line 66 of file Pileup1DResidualCalibStep.h.

◆ m_doMuOnly

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_doMuOnly {this, "ApplyOnlyMuResidual", false, "doc"}

private

Definition at line 76 of file Pileup1DResidualCalibStep.h.

◆ m_doNJetOnly

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_doNJetOnly {this, "ApplyOnlyNJetResidual", false, "doc"}

private

Definition at line 78 of file Pileup1DResidualCalibStep.h.

◆ m_doNPVOnly

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_doNPVOnly {this, "ApplyOnlyNPVResidual", false, "doc"}

private

Definition at line 77 of file Pileup1DResidualCalibStep.h.

◆ m_doOnlyResidual

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_doOnlyResidual {this, "OnlyResidual", false, ""}

private

Definition at line 109 of file Pileup1DResidualCalibStep.h.

◆ m_doSequentialResidual

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_doSequentialResidual {this, "DoSequentialResidual", false, "doc"}

private

Definition at line 107 of file Pileup1DResidualCalibStep.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_isData

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_isData {this, "IsData", false, ""}

private

Definition at line 65 of file Pileup1DResidualCalibStep.h.

◆ m_mu_ref

Gaudi::Property<float> Pileup1DResidualCalibStep::m_mu_ref {this , "DefaultMuRef", -99., ""}

private

Definition at line 81 of file Pileup1DResidualCalibStep.h.

◆ m_muKey

SG::ReadDecorHandleKey<xAOD::EventInfo> Pileup1DResidualCalibStep::m_muKey

private

Initial value:

{this, "averageInteractionsPerCrossingKey",

"EventInfo.averageInteractionsPerCrossing","Decoration for Average Interaction Per Crossing"}

Definition at line 68 of file Pileup1DResidualCalibStep.h.

◆ m_muSF

Gaudi::Property<float> Pileup1DResidualCalibStep::m_muSF {this , "MuScaleFactor", 1., ""}

private

Definition at line 83 of file Pileup1DResidualCalibStep.h.

◆ m_nJet_ref

Gaudi::Property<float> Pileup1DResidualCalibStep::m_nJet_ref {this , "DefaultNjetRef", -99., ""}

private

Definition at line 82 of file Pileup1DResidualCalibStep.h.

◆ m_nJetContainerKey

SG::ReadHandleKey<xAOD::JetContainer> Pileup1DResidualCalibStep::m_nJetContainerKey

private

Initial value:

{this, "nJetContainerName",

"","a jet container such as HLT_xAOD__JetContainer_a4tcemsubjesISFS"}

Definition at line 85 of file Pileup1DResidualCalibStep.h.

◆ m_njetThreshold

Gaudi::Property<int> Pileup1DResidualCalibStep::m_njetThreshold {this , "nJetThreshold", 20, ""}

private

Definition at line 89 of file Pileup1DResidualCalibStep.h.

◆ m_NPV_ref

Gaudi::Property<float> Pileup1DResidualCalibStep::m_NPV_ref {this , "DefaultNPVRef", -99., ""}

private

Definition at line 80 of file Pileup1DResidualCalibStep.h.

◆ m_npvBeamspotCorr

NPVBeamspotCorrection* Pileup1DResidualCalibStep::m_npvBeamspotCorr {}

private

Definition at line 105 of file Pileup1DResidualCalibStep.h.

◆ m_offsetEtaBins

Gaudi::Property<std::vector<double> > Pileup1DResidualCalibStep::m_offsetEtaBins {this, "AbsEtaBins", {} ,""}

private

Definition at line 97 of file Pileup1DResidualCalibStep.h.

◆ m_originScale

Gaudi::Property<std::string> Pileup1DResidualCalibStep::m_originScale {this, "OriginScale", "", "scale from which correction is applied" }

private

Definition at line 111 of file Pileup1DResidualCalibStep.h.

◆ m_pvKey

SG::ReadHandleKey<xAOD::VertexContainer> Pileup1DResidualCalibStep::m_pvKey {this, "PrimaryVerticesContainerName", "PrimaryVertices"}

private

Definition at line 73 of file Pileup1DResidualCalibStep.h.

◆ m_resOffsetBins

TAxis* Pileup1DResidualCalibStep::m_resOffsetBins =nullptr

private

Definition at line 101 of file Pileup1DResidualCalibStep.h.

◆ m_resOffsetMu

Gaudi::Property<std::vector<double> > Pileup1DResidualCalibStep::m_resOffsetMu {this, "MuTerm", {} ,""}

private

Definition at line 98 of file Pileup1DResidualCalibStep.h.

◆ m_resOffsetNjet

Gaudi::Property<std::vector<double> > Pileup1DResidualCalibStep::m_resOffsetNjet {this, "nJetTerm", {} ,""}

private

Definition at line 99 of file Pileup1DResidualCalibStep.h.

◆ m_resOffsetNPV

Gaudi::Property<std::vector<double> > Pileup1DResidualCalibStep::m_resOffsetNPV {this, "NPVTerm", {} ,""}

private

Definition at line 100 of file Pileup1DResidualCalibStep.h.

◆ m_rhoKey

SG::ReadHandleKey<xAOD::EventShape> Pileup1DResidualCalibStep::m_rhoKey {this, "RhoKey", "auto"}

private

Definition at line 72 of file Pileup1DResidualCalibStep.h.

◆ m_useNjet

Gaudi::Property<bool> Pileup1DResidualCalibStep::m_useNjet {this , "UseNjet", false, ""}

private

Definition at line 88 of file Pileup1DResidualCalibStep.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ Pileup1DResidualCalibStep()

Member Function Documentation

◆ calibrate()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getNominalResolutionData()

◆ getNominalResolutionMC()

◆ getNPVBeamspotCorrection()

◆ getProperty()

◆ getResidualOffset()

◆ getResidualOffsetET()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_applyNPVBeamspotCorrection

◆ m_calibFile

◆ m_corrDesc

◆ m_corrName

◆ m_detStore

◆ m_doJetArea

◆ m_doMuOnly

◆ m_doNJetOnly

◆ m_doNPVOnly

◆ m_doOnlyResidual

◆ m_doSequentialResidual

◆ m_evtStore

◆ m_isData

◆ m_mu_ref

◆ m_muKey

◆ m_muSF

◆ m_nJet_ref

◆ m_nJetContainerKey

◆ m_njetThreshold

◆ m_NPV_ref

◆ m_npvBeamspotCorr

◆ m_offsetEtaBins

◆ m_originScale

◆ m_pvKey

◆ m_resOffsetBins

◆ m_resOffsetMu

◆ m_resOffsetNjet

◆ m_resOffsetNPV

◆ m_rhoKey

◆ m_useNjet

◆ m_varHandleArraysDeclared

◆ m_vhka