A base class for tool building a group of histogram. More...

#include <JetHistoBase.h>

Inheritance diagram for JetHistoBase:

Collaboration diagram for JetHistoBase:

Public Types
enum	Interval_t { file = 0 , eventsBlock , lumiBlock , lowStat , medStat , higStat , run , fill , all , useToolInterval }
	Redefinition of fill intervals as in ManagedMonitorToolBase. More...

Public Member Functions
	JetHistoBase (const std::string &t)
	~JetHistoBase ()
virtual StatusCode	initialize ()
	Dummy implementation of the initialisation function.
virtual int	fillHistosFromContainer (const xAOD::JetContainer &cont, float weight)
virtual int	fillHistosFromJet (const xAOD::Jet &j, float)
virtual int	finalizeHistos ()
virtual int	buildHistos ()
virtual int	fillHistos ()
virtual void	prefixHistoDir (const std::string &preDir)
	allows a higher level tool to put the histos in this group as a sub-dir of 'preDir'
template<class T>
T *	bookHisto (T *h, Interval_t ityp=useToolInterval)
	register the histo h in this group (if h!=NULL). The histo name is changed if m_prefixedHistoName==true. Returns h.
template<class T>
T *	bookHistoInSubDir (const std::string &subD, T *h, Interval_t ityp=useToolInterval)
	Same as bookHistom but put the histo under subdirectory subD.
const std::vector< HistData > &	bookedHistograms ()
	return all the histos in this group
virtual void	setInterval (Interval_t ityp, bool force=false)
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.

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
virtual void	renameAndRegister (TH1 *h, const std::string &subD="", Interval_t ityp=useToolInterval)
	Rename an histo according to the tool's path.
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::vector< HistData >	m_vBookedHistograms
	The list of histos in this group.
std::string	m_histoDir
	The path where histos in this group leave.
int	m_monIntervalType
	when used in Athena monitoring context, the histos of this group will have this type of interval
bool	m_prefixedHistoName
	true if the histo name should contain the full hierarchy path
int	m_interval

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

A base class for tool building a group of histogram.

Specialization

This class defines 2 filling call dedicated to jets :

fillHistosFromContainer(JetContainer&)
fillHistosFromJet(Jet&) The default implementation of the first is loops over the container and calls fillHistosFromJet() on each jet.

Definition at line 27 of file JetHistoBase.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

◆ Interval_t

enum HistoGroupBase::Interval_t

inherited

Redefinition of fill intervals as in ManagedMonitorToolBase.

Enumerator
file
eventsBlock
lumiBlock
lowStat
medStat
higStat
run
fill
all
useToolInterval

Definition at line 37 of file HistoGroupBase.h.

                  { file = 0, eventsBlock, lumiBlock,
                    lowStat, medStat, higStat,
                    run, fill, all,
                    
                    useToolInterval // used to use the value from the tool's m_interval property  
  };

Constructor & Destructor Documentation

◆ JetHistoBase()

JetHistoBase::JetHistoBase ( const std::string & t )

Definition at line 10 of file JetHistoBase.cxx.

                                             : HistoGroupBase(n)
{
  declareInterface<JetHistoBase>(this);
 
}

◆ ~JetHistoBase()

JetHistoBase::~JetHistoBase ( )

inline

Definition at line 34 of file JetHistoBase.h.

34{}

Member Function Documentation

◆ bookedHistograms()

const std::vector< HistoGroupBase::HistData > & HistoGroupBase::bookedHistograms ( )

inherited

return all the histos in this group

Definition at line 45 of file HistoGroupBase.cxx.

                                                                          {
  return m_vBookedHistograms;
}

◆ bookHisto()

template<class T>

T * HistoGroupBase::bookHisto	(	T *	h,
		Interval_t	ityp = useToolInterval )

inlineinherited

register the histo h in this group (if h!=NULL). The histo name is changed if m_prefixedHistoName==true. Returns h.

Definition at line 69 of file HistoGroupBase.h.

69{ renameAndRegister(h,"",ityp); return h;}

HistoGroupBase::renameAndRegister

virtual void renameAndRegister(TH1 *h, const std::string &subD="", Interval_t ityp=useToolInterval)

Rename an histo according to the tool's path.

Definition HistoGroupBase.cxx:50

extractSporadic.h

list h

Definition extractSporadic.py:96

◆ bookHistoInSubDir()

template<class T>

T * HistoGroupBase::bookHistoInSubDir	(	const std::string &	subD,
		T *	h,
		Interval_t	ityp = useToolInterval )

inlineinherited

Same as bookHistom but put the histo under subdirectory subD.

Definition at line 73 of file HistoGroupBase.h.

73{ renameAndRegister(h, subD,ityp); return h;}

◆ buildHistos()

int HistoGroupBase::buildHistos ( )

virtualinherited

Reimplemented in EfficiencyResponseHistos, HIEfficiencyResponseHistos, HIJetUEMonitoring, HistosForJetSelection, JetAttributeHisto, JetContainerHistoFiller, JetKinematicHistos, JetSubStructureHistos, and LeadingJetsRelations.

Definition at line 29 of file HistoGroupBase.cxx.

                                { 
  return 0;
}

◆ 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

◆ 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

◆ fillHistos()

int HistoGroupBase::fillHistos ( )

virtualinherited

Reimplemented in JetContainerHistoFiller.

Definition at line 33 of file HistoGroupBase.cxx.

                              {
  return 0;  
}

◆ fillHistosFromContainer()

int JetHistoBase::fillHistosFromContainer	(	const xAOD::JetContainer &	cont,
		float	weight )

virtual

Reimplemented in EfficiencyResponseHistos, HIEfficiencyResponseHistos, HistosForJetSelection, JetAttributeHisto, JetKinematicHistos, and LeadingJetsRelations.

Definition at line 24 of file JetHistoBase.cxx.

                                                                                    {
  int count=0;
  for( const xAOD::Jet* jet : cont ){ count+=fillHistosFromJet( *jet, weight );}
  return count;    
}

◆ fillHistosFromJet()

int JetHistoBase::fillHistosFromJet	(	const xAOD::Jet &	j,
		float	)

virtual

Reimplemented in HIJetUEMonitoring, JetAttributeHisto, JetKinematicHistos, and JetSubStructureHistos.

Definition at line 30 of file JetHistoBase.cxx.

30{ return 0;}

◆ finalizeHistos()

int JetHistoBase::finalizeHistos ( )

virtual

Reimplemented from HistoGroupBase.

Reimplemented in HistosForJetSelection.

Definition at line 32 of file JetHistoBase.cxx.

32{return 0;}

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

◆ initialize()

StatusCode JetHistoBase::initialize ( void )

virtual

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 HistoGroupBase.

Reimplemented in EfficiencyResponseHistos, HIEfficiencyResponseHistos, HIJetUEMonitoring, HistosForJetSelection, JetAttributeHisto, and LeadingJetsRelations.

Definition at line 16 of file JetHistoBase.cxx.

                                    {
 
  //if(m_histoDir=="") {m_histoDir = "Jets/"; m_histoDir+=m_inputContainer+"/";}
  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.

◆ interfaceID()

const InterfaceID & JetHistoBase::interfaceID ( )

inlinestatic

Definition at line 45 of file JetHistoBase.h.

45{return IID_JetHistoBase;}

IID_JetHistoBase

static const InterfaceID IID_JetHistoBase("JetHistoBase", 1, 0)

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

◆ prefixHistoDir()

void HistoGroupBase::prefixHistoDir ( const std::string & preDir )

virtualinherited

allows a higher level tool to put the histos in this group as a sub-dir of 'preDir'

Reimplemented in HistosForJetSelection, and JetContainerHistoFiller.

Definition at line 41 of file HistoGroupBase.cxx.

                                                           {
  m_histoDir = preDir + m_histoDir;
}

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

◆ renameAndRegister()

void HistoGroupBase::renameAndRegister	(	TH1 *	h,
		const std::string &	subD = "",
		Interval_t	ityp = useToolInterval )

protectedvirtualinherited

Rename an histo according to the tool's path.

Reimplemented in JetAttributeHisto.

Definition at line 50 of file HistoGroupBase.cxx.

                                                                                     {
 
  if( h == nullptr ) return;
 
  if( ityp == useToolInterval) ityp = (Interval_t) m_interval;
 
  std::string path = m_histoDir+subD;
  std::string prefix="";
  if( m_prefixedHistoName) { 
    prefix = path;
    std::replace( prefix.begin(), prefix.end(), '/', '_');
  }
  h->SetName( (prefix+h->GetName()).c_str() );
 
  m_vBookedHistograms.push_back( {h, std::move(path), ityp} );
}

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

◆ setInterval()

virtual void HistoGroupBase::setInterval	(	Interval_t	ityp,
		bool	force = false )

inlinevirtualinherited

Reimplemented in HistosForJetSelection, and JetContainerHistoFiller.

Definition at line 79 of file HistoGroupBase.h.

79{ if(force || (m_interval==-1) ) m_interval = ityp;}

◆ 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

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

std::string HistoGroupBase::m_histoDir

protectedinherited

The path where histos in this group leave.

Definition at line 93 of file HistoGroupBase.h.

◆ m_interval

int HistoGroupBase::m_interval

protectedinherited

Definition at line 101 of file HistoGroupBase.h.

◆ m_monIntervalType

int HistoGroupBase::m_monIntervalType

protectedinherited

when used in Athena monitoring context, the histos of this group will have this type of interval

Definition at line 96 of file HistoGroupBase.h.

◆ m_prefixedHistoName

bool HistoGroupBase::m_prefixedHistoName

protectedinherited

true if the histo name should contain the full hierarchy path

Definition at line 99 of file HistoGroupBase.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vBookedHistograms

std::vector<HistData> HistoGroupBase::m_vBookedHistograms

protectedinherited

The list of histos in this group.

Definition at line 90 of file HistoGroupBase.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 Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ Interval_t

Constructor & Destructor Documentation

◆ JetHistoBase()

◆ ~JetHistoBase()

Member Function Documentation

◆ bookedHistograms()

◆ bookHisto()

◆ bookHistoInSubDir()

◆ buildHistos()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ fillHistos()

◆ fillHistosFromContainer()

◆ fillHistosFromJet()

◆ finalizeHistos()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ prefixHistoDir()

◆ print()

◆ renameAndRegister()

◆ renounce()

◆ renounceArray()

◆ setInterval()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_histoDir

◆ m_interval

◆ m_monIntervalType

◆ m_prefixedHistoName

◆ m_varHandleArraysDeclared

◆ m_vBookedHistograms

◆ m_vhka