Class HistoInput1D User interface to read 1D histograms. More...

#include <HistoInput1D.h>

Inheritance diagram for JetHelper::HistoInput1D:

Collaboration diagram for JetHelper::HistoInput1D:

Public Member Functions
	HistoInput1D (const std::string &name)
	Constructor for standalone usage.
virtual StatusCode	initialize () override
	Function initialising the tool.
virtual float	getValue (const xAOD::Jet &jet, const JetContext &event) const override
	return value of histogram at jet variable
virtual bool	runUnitTests () const
	standalone test, no implemented yet
std::string	getFileName () const
	Return the name of the file that containt the histograms.
std::string	getHistName () const
	Return the name of the histogram.
TH1 &	getHistogram ()
	Returns the underlying histogram.
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Types
enum class	InterpType { UNKNOWN =0 , Full , None , OnlyX , OnlyY , OnlyZ }

Protected Member Functions
bool	readHistoFromFile ()
	This function open the InputFile and assign the histogram to m_hist.
double	enforceAxisRange (const TAxis &axis, const double inputValue) const
	This function ensure that the histogram is NOT evaluated outside range.
double	readFromHisto (const double X, const double Y=0, const double Z=0) const
	This function evaluate the histogram using the TH1::Interpolate.
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Protected Attributes
std::unique_ptr< TH1 > m_hist	ATLAS_THREAD_SAFE {}
Gaudi::Property< std::string >	m_interpStr {this, "InterpType", "Full", "Interpolation to run: Full/OnlyX/OnlyY/None"}
InterpType	m_interpNum {InterpType::UNKNOWN}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< IVarTool >	m_vartool {this, "varTool1", "VarTool", "InputVariable instance" }
	interface to read xAOD::jet variable to be defined by user
Gaudi::Property< std::string >	m_fileName { this, "inputfile", "JetUncertainties/CalibArea-08/rel21/Summer2019/R4_AllComponents.root", "File containing histograms" }
	path to the file with histrograms
Gaudi::Property< std::string >	m_histName { this, "histName", "Zjet_MuStat3_AntiKt4EMPFlow", "name of histrogram" }
	name of the histogram
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Class HistoInput1D User interface to read 1D histograms.

Definition at line 19 of file HistoInput1D.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

◆ InterpType

enum class JetHelper::HistoInputBase::InterpType

strongprotectedinherited

Enumerator
UNKNOWN
Full
None
OnlyX
OnlyY
OnlyZ

Definition at line 56 of file HistoInputBase.h.

        {
            UNKNOWN=0,  // Unknown/unset/etc
            Full,       // Full interpolation
            None,       // No interpolation
            OnlyX,      // Interpolate only in the x dimension
            OnlyY,       // Interpolate only in the y dimension
            OnlyZ       // Interpolate only in the z dimension
        };

Constructor & Destructor Documentation

◆ HistoInput1D()

JetHelper::HistoInput1D::HistoInput1D ( const std::string & name )

Constructor for standalone usage.

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ enforceAxisRange()

double JetHelper::HistoInputBase::enforceAxisRange	(	const TAxis &	axis,
		const double	inputValue ) const

protectedinherited

This function ensure that the histogram is NOT evaluated outside range.

◆ evtStore()

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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ getFileName()

std::string JetHelper::HistoInputBase::getFileName ( ) const

inlineinherited

Return the name of the file that containt the histograms.

Definition at line 34 of file HistoInputBase.h.

34{ return m_fileName; };

JetHelper::HistoInputBase::m_fileName

Gaudi::Property< std::string > m_fileName

path to the file with histrograms

Definition HistoInputBase.h:42

◆ getHistName()

std::string JetHelper::HistoInputBase::getHistName ( ) const

inlineinherited

Return the name of the histogram.

Definition at line 36 of file HistoInputBase.h.

36{ return m_histName; };

JetHelper::HistoInputBase::m_histName

Gaudi::Property< std::string > m_histName

name of the histogram

Definition HistoInputBase.h:44

◆ getHistogram()

TH1 & JetHelper::HistoInputBase::getHistogram ( )

inlineinherited

Returns the underlying histogram.

Definition at line 38 of file HistoInputBase.h.

38{ return *m_hist; };

◆ 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
   }

◆ getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

◆ getValue()

virtual float JetHelper::HistoInput1D::getValue	(	const xAOD::Jet &	jet,
		const JetContext &	event ) const

overridevirtual

return value of histogram at jet variable

Implements JetHelper::IInputVariable.

◆ initialize()

virtual StatusCode JetHelper::HistoInput1D::initialize ( )

overridevirtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

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

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ 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 AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

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

◆ readFromHisto()

double JetHelper::HistoInputBase::readFromHisto	(	const double	X,
		const double	Y = 0,
		const double	Z = 0 ) const

protectedinherited

This function evaluate the histogram using the TH1::Interpolate.

◆ readHistoFromFile()

bool JetHelper::HistoInputBase::readHistoFromFile ( )

protectedinherited

This function open the InputFile and assign the histogram to m_hist.

◆ 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();
  }

◆ runUnitTests()

virtual bool JetHelper::HistoInput1D::runUnitTests ( ) const

virtual

standalone test, no implemented yet

◆ 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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

◆ ATLAS_THREAD_SAFE

std::unique_ptr<TH1> m_hist JetHelper::HistoInputBase::ATLAS_THREAD_SAFE {}

protectedinherited

Definition at line 47 of file HistoInputBase.h.

47{};

◆ 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_fileName

Gaudi::Property< std::string > JetHelper::HistoInputBase::m_fileName { this, "inputfile", "JetUncertainties/CalibArea-08/rel21/Summer2019/R4_AllComponents.root", "File containing histograms" }

privateinherited

path to the file with histrograms

Definition at line 42 of file HistoInputBase.h.

42{ this, "inputfile", "JetUncertainties/CalibArea-08/rel21/Summer2019/R4_AllComponents.root", "File containing histograms" };

◆ m_histName

Gaudi::Property< std::string > JetHelper::HistoInputBase::m_histName { this, "histName", "Zjet_MuStat3_AntiKt4EMPFlow", "name of histrogram" }

privateinherited

name of the histogram

Definition at line 44 of file HistoInputBase.h.

44{ this, "histName", "Zjet_MuStat3_AntiKt4EMPFlow", "name of histrogram" };

◆ m_interpNum

InterpType JetHelper::HistoInputBase::m_interpNum {InterpType::UNKNOWN}

protectedinherited

Definition at line 65 of file HistoInputBase.h.

65{InterpType::UNKNOWN};

JetHelper::HistoInputBase::InterpType::UNKNOWN

@ UNKNOWN

Definition HistoInputBase.h:58

◆ m_interpStr

Gaudi::Property<std::string> JetHelper::HistoInputBase::m_interpStr {this, "InterpType", "Full", "Interpolation to run: Full/OnlyX/OnlyY/None"}

protectedinherited

Definition at line 55 of file HistoInputBase.h.

55{this, "InterpType", "Full", "Interpolation to run: Full/OnlyX/OnlyY/None"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vartool

ToolHandle<IVarTool> JetHelper::HistoInput1D::m_vartool {this, "varTool1", "VarTool", "InputVariable instance" }

private

interface to read xAOD::jet variable to be defined by user

Definition at line 38 of file HistoInput1D.h.

38{this, "varTool1", "VarTool", "InputVariable instance" };

◆ 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 file:

HistoInput1D.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ InterpType

Constructor & Destructor Documentation

◆ HistoInput1D()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ enforceAxisRange()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getFileName()

◆ getHistName()

◆ getHistogram()

◆ getKey()

◆ getName()

◆ getProperty()

◆ getValue()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ readFromHisto()

◆ readHistoFromFile()

◆ renounce()

◆ renounceArray()

◆ runUnitTests()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_detStore

◆ m_evtStore

◆ m_fileName

◆ m_histName

◆ m_interpNum

◆ m_interpStr

◆ m_varHandleArraysDeclared

◆ m_vartool

◆ m_vhka