#include <SmearingCalibStep.h>

Inheritance diagram for SmearingCalibStep:

Collaboration diagram for SmearingCalibStep:

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

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

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

virtual StatusCode	getNominalResolutionData (const xAOD::Jet &jet, const JetHelper::JetContext &jc, double &resolution) const override

virtual StatusCode	getNominalResolutionMC (const xAOD::Jet &jet, const JetHelper::JetContext &jc, double &resolution) const override

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

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
enum	SmearType { SmearType::UNKNOWN =0, SmearType::Pt, SmearType::Mass, SmearType::FourVec }

typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	getSigmaSmear (xAOD::Jet &jet, const JetHelper::JetContext &jc, double &sigmaSmear) const

StatusCode	getNominalResolution (const xAOD::Jet &jet, JetHelper::JetContext jc, double &resolution) const

TRandom3 *	getTLSRandomGen (unsigned long seed) 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< std::string >	m_jetStartScale {this, "JSCStartingScale", "JetGSCScaleMomentum", "Starting jet scale"}

Gaudi::Property< std::string >	m_jetOutScale {this, "JSCOutScale", "JetSmearedMomentum", "Ending jet scale"}

Gaudi::Property< std::string >	m_smearType {this, "SmearType", "", "How to smear: pt, eta or FourVec"}

ToolHandle< JetHelper::IVarTool >	m_histToolMC {this, "HistoReaderMC", "HistoInput2D", "Instance of HistoInput1D or HistoInput2D for reading histogram for MC"}

ToolHandle< JetHelper::IVarTool >	m_histToolData {this, "HistoReaderData", "HistoInput2D", "Instance of HistoInput1D or HistoInput2D for reading histogram for data"}

SmearType	m_smearTypeClass = SmearType::UNKNOWN

boost::thread_specific_ptr< TRandom3 >	m_rand_tls

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 29 of file SmearingCalibStep.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ SmearType

enum SmearingCalibStep::SmearType

strongprivate

Enumerator
UNKNOWN
Pt
Mass
FourVec

Definition at line 60 of file SmearingCalibStep.h.

         {
             UNKNOWN=0,  // Unknown/unset/etc
             Pt,         // pT smearing (JpTR)
             Mass,       // Mass smearing (JMR)
             FourVec     // Four-vector smearing (JER)
         };

Constructor & Destructor Documentation

◆ SmearingCalibStep()

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

Definition at line 15 of file SmearingCalibStep.cxx.

16 : asg::AsgTool( name ){ }

Member Function Documentation

◆ calibrate()

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

overridevirtual

Apply calibration to a jet container.

Implements IJetCalibStep.

Definition at line 116 of file SmearingCalibStep.cxx.

                                                                     {
     ATH_MSG_DEBUG("Applying smearing calibration step to jet collection.");
  
     JetHelper::JetContext jc;
  
     for(const auto jet: jets){
  
     const xAOD::JetFourMom_t jetStartP4 = jet->jetP4();
     
     double sigmaSmear = 0;
     if (getSigmaSmear(*jet, jc, sigmaSmear).isFailure())
         return StatusCode::FAILURE;
     
     // Set the random seed deterministically using jet phi
     unsigned long seed = static_cast<unsigned long>(1.e5*fabs(jet->phi()));
     // SetSeed(0) uses the clock, so avoid this
     if(seed == 0) seed = 45583453; // arbitrary number which the seed couldn't otherwise be
     TRandom3* rng = getTLSRandomGen(seed);
  
     // Get the Gaussian-distributed random number
     // Force this to be a positive value
     // Negative values should be extraordinarily rare, but they do exist
     double smearingFactor = -1;
     while (smearingFactor < 0)
         smearingFactor = rng->Gaus(1.,sigmaSmear);
  
     xAOD::JetFourMom_t calibP4 = jetStartP4;
  
     switch (m_smearTypeClass)
     {
         case SmearType::Pt:
             calibP4 = xAOD::JetFourMom_t(jet->pt()*smearingFactor,jet->eta(),jet->phi(),jet->m());
             break;
  
         case SmearType::Mass:
             calibP4 = xAOD::JetFourMom_t(jet->pt(),jet->eta(),jet->phi(),smearingFactor*jet->m());
             break;
  
         case SmearType::FourVec:
             calibP4 = xAOD::JetFourMom_t(jet->pt()*smearingFactor,jet->eta(),jet->phi(),jet->m()*smearingFactor);
             break;
  
         default:
             // We should never reach this, it was checked during initialization
             ATH_MSG_ERROR("Cannot smear the jet, the smearing type was not set");
             return StatusCode::FAILURE;
     }
  
     // Set the output scale
     jet->setAttribute<xAOD::JetFourMom_t>(m_jetOutScale,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
    }

◆ getNominalResolution()

StatusCode SmearingCalibStep::getNominalResolution	(	const xAOD::Jet &	jet,
		JetHelper::JetContext	jc,
		double &	resolution
	)		const

private

◆ getNominalResolutionData()

StatusCode SmearingCalibStep::getNominalResolutionData	(	const xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		double &	resolution
	)		const

overridevirtual

Reimplemented from IJetCalibStep.

Definition at line 104 of file SmearingCalibStep.cxx.

 {
     resolution = m_histToolData->getValue(jet, jc); 
     return StatusCode::SUCCESS;
 }

◆ getNominalResolutionMC()

StatusCode SmearingCalibStep::getNominalResolutionMC	(	const xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		double &	resolution
	)		const

overridevirtual

Reimplemented from IJetCalibStep.

Definition at line 110 of file SmearingCalibStep.cxx.

 {
     resolution = m_histToolMC->getValue(jet, jc); 
     return StatusCode::SUCCESS;
 }

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ getSigmaSmear()

StatusCode SmearingCalibStep::getSigmaSmear	(	xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		double &	sigmaSmear
	)		const

private

Definition at line 68 of file SmearingCalibStep.cxx.

 {
     /*
         Nominal jet smearing
             If sigma_data > sigma_MC, then we want to smear MC to match data
             If sigma_data < sigma_MC, then we do not want to smear data to match MC
             The second case is instead the source of an uncertainty (see JetUncertainties)
  
         To make MC agree with data:
             if (sigma_data > sigma_MC) then sigma_smear^2 = sigma_data^2 - sigma_MC^2
             if (sigma_data < sigma_MC) then do nothing
             Smearing using a Gaussian centered at 1 and with a width of sigma_smear
  
         Note that data is never smeared, as blocked in JetCalibrationTool.cxx 
     --> TODO: JetCalibrationTool.cxx throws an error if you try to run smearing calibration on data - include this in new tool
     */
  
     double resolutionMC = 0;
     if (getNominalResolutionMC(jet, jc, resolutionMC).isFailure())
         return StatusCode::FAILURE;
  
     double resolutionData = 0;
     if (getNominalResolutionData(jet, jc, resolutionData).isFailure())
         return StatusCode::FAILURE;
  
     // Nominal smearing only if data resolution is larger than MC resolution
     // This is because we want to smear the MC to match the data
     // if MC is larger than data, don't make the nominal data worse, so smear is 0
     if (resolutionMC < resolutionData)
         sigmaSmear = sqrt(resolutionData*resolutionData - resolutionMC*resolutionMC);
     else
         sigmaSmear = 0;
     
     return StatusCode::SUCCESS;
 }

◆ getTLSRandomGen()

TRandom3 * SmearingCalibStep::getTLSRandomGen ( unsigned long seed ) const

private

Definition at line 57 of file SmearingCalibStep.cxx.

 {
   TRandom3* random = m_rand_tls.get();
   if (!random) {
     random = new TRandom3();
     m_rand_tls.reset(random);
   }
   random->SetSeed(seed);
   return random;
 }

◆ initialize()

StatusCode SmearingCalibStep::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 19 of file SmearingCalibStep.cxx.

                                         {
  
     ATH_MSG_DEBUG ("Initializing " << name() );
  
     ATH_MSG_INFO("Reading from " << m_jetStartScale << " and writing to " << m_jetOutScale);
  
     // Check the specified smearing type    
     if (m_smearType == "")
     {
         ATH_MSG_FATAL("No jet smearing type was specified.  Aborting.");
         return StatusCode::FAILURE;
     }
     else if (m_smearType=="pt")
     {
         m_smearTypeClass = SmearType::Pt;
     }
     else if (m_smearType=="mass")
     {
         m_smearTypeClass = SmearType::Mass;
     }
     else if (m_smearType=="FourVec")
     {
         m_smearTypeClass = SmearType::FourVec;
     }
     else
     {
         ATH_MSG_FATAL("Unrecognized jet smearing type: " << m_smearType << "--> the available options are 'pt', 'mass' or 'FourVec'");
         return StatusCode::FAILURE;
     }
  
  
     // Retrieve the histograms
     ATH_CHECK( m_histToolMC.retrieve() );
     ATH_CHECK( m_histToolData.retrieve() );
  
     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_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_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_histToolData

ToolHandle<JetHelper::IVarTool> SmearingCalibStep::m_histToolData {this, "HistoReaderData", "HistoInput2D", "Instance of HistoInput1D or HistoInput2D for reading histogram for data"}

private

Definition at line 52 of file SmearingCalibStep.h.

◆ m_histToolMC

ToolHandle<JetHelper::IVarTool> SmearingCalibStep::m_histToolMC {this, "HistoReaderMC", "HistoInput2D", "Instance of HistoInput1D or HistoInput2D for reading histogram for MC"}

private

Definition at line 51 of file SmearingCalibStep.h.

◆ m_jetOutScale

Gaudi::Property<std::string> SmearingCalibStep::m_jetOutScale {this, "JSCOutScale", "JetSmearedMomentum", "Ending jet scale"}

private

Definition at line 46 of file SmearingCalibStep.h.

◆ m_jetStartScale

Gaudi::Property<std::string> SmearingCalibStep::m_jetStartScale {this, "JSCStartingScale", "JetGSCScaleMomentum", "Starting jet scale"}

private

Definition at line 45 of file SmearingCalibStep.h.

◆ m_rand_tls

boost::thread_specific_ptr<TRandom3> SmearingCalibStep::m_rand_tls

mutableprivate

Definition at line 69 of file SmearingCalibStep.h.

◆ m_smearType

Gaudi::Property<std::string> SmearingCalibStep::m_smearType {this, "SmearType", "", "How to smear: pt, eta or FourVec"}

private

Definition at line 47 of file SmearingCalibStep.h.

◆ m_smearTypeClass

SmearType SmearingCalibStep::m_smearTypeClass = SmearType::UNKNOWN

private

Definition at line 67 of file SmearingCalibStep.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

Member Enumeration Documentation

◆ SmearType

Constructor & Destructor Documentation

◆ SmearingCalibStep()

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()

◆ getNominalResolution()

◆ getNominalResolutionData()

◆ getNominalResolutionMC()

◆ getProperty()

◆ getSigmaSmear()

◆ getTLSRandomGen()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_histToolData

◆ m_histToolMC

◆ m_jetOutScale

◆ m_jetStartScale

◆ m_rand_tls

◆ m_smearType

◆ m_smearTypeClass

◆ m_varHandleArraysDeclared

◆ m_vhka