#include <HistosForJetSelection.h>

Inheritance diagram for HistosForJetSelection:

Collaboration diagram for HistosForJetSelection:

Public Types
enum	SelectionType { AllJets, LeadingJet, SubLeadingJet, FromTool }
	Describes the selection type : built-in or use of an external type. More...

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
	HistosForJetSelection (const std::string &t)

virtual	~HistosForJetSelection ()

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

virtual int	buildHistos ()

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

virtual int	finalizeHistos ()

virtual void	prefixHistoDir (const std::string &preDir)
	redefine to forward to sub histos More...

virtual void	setInterval (Interval_t ityp, bool force=false)
	redefine to forward to sub histos More...

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

virtual int	fillHistos ()

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

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

const std::vector< HistData > &	bookedHistograms ()
	return all the histos in this group More...

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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Public Attributes
bool	m_inverseToolSelection = false

Protected Member Functions
virtual void	modifyNameAndTitle (TH1 *h)

virtual void	renameAndRegister (TH1 *h, const std::string &subD="", Interval_t ityp=useToolInterval)
	Rename an histo according to the tool's path. More...

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

Protected Attributes
ToolHandleArray< JetHistoBase >	m_histoTools
	List of histo tools to call on selected jets. More...

ToolHandle< IJetSelector >	m_selTool

int	m_selType
	used only if m_selType == FromTool More...

std::string	m_titleSuffix
	Suffix of the histos titles. If the property is not set and using a built-in type, it will be automatically chosen. More...

std::string	m_nameSuffix
	Suffix of the histos names. More...

std::vector< HistData >	m_vBookedHistograms
	The list of histos in this group. More...

std::string	m_histoDir
	The path where histos in this group leave. More...

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

bool	m_prefixedHistoName
	true if the histo name should contain the full hierarchy path More...

int	m_interval

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	ASG_TOOL_CLASS0 (HistosForJetSelection)

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

Fills a list of histograms on a selected subset of a JetContainer.

The tool has 2 sort of properties

a JetSelector Tool (actually, to be implemented) or an option to use a built-in selection (none, or (sub)leading jet)
a list of JetHistoBase (ToolHandleArray) The tool uses the selector on the JetContainer it is passed. It then calls each of its JetHistoBase on the selected jets.

Definition at line 27 of file HistosForJetSelection.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  
   };

◆ SelectionType

enum HistosForJetSelection::SelectionType

Describes the selection type : built-in or use of an external type.

Enumerator
AllJets
LeadingJet
SubLeadingJet
FromTool

Definition at line 51 of file HistosForJetSelection.h.

                      {
     AllJets,
     LeadingJet,
     SubLeadingJet,
     FromTool
   };

Constructor & Destructor Documentation

◆ HistosForJetSelection()

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

Definition at line 9 of file HistosForJetSelection.cxx.

                                                                : JetHistoBase(t) 
                                                                    , m_histoTools(this)
                                                                    , m_selType(AllJets)
                                                                    , m_titleSuffix("")
                                                                    , m_nameSuffix("")
 {
   declareProperty("SelectionType", m_selType=AllJets);
   declareProperty("HistoTools", m_histoTools);
   declareProperty("HistoTitleSuffix", m_titleSuffix);
   declareProperty("HistoNameSuffix", m_nameSuffix);
   declareProperty("JetSelectorTool", m_selTool);
   declareProperty("InverseToolSelection", m_inverseToolSelection);
 }

◆ ~HistosForJetSelection()

HistosForJetSelection::~HistosForJetSelection ( )

virtualdefault

Member Function Documentation

◆ ASG_TOOL_CLASS0()

HistosForJetSelection::ASG_TOOL_CLASS0 ( HistosForJetSelection )

private

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

◆ 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 HistosForJetSelection::buildHistos ( )

virtual

Reimplemented from HistoGroupBase.

Definition at line 59 of file HistosForJetSelection.cxx.

                                       {
   // build histos of each subtools
   int count=0;
   for( auto jtool : m_histoTools){
     count+=jtool->buildHistos();
     // keep a pointer to histos :
     const auto & hdata = jtool->bookedHistograms();
     ATH_MSG_DEBUG(" Histo tool "<< jtool->name() << "  count= "<< count<< " nh="<<hdata.size());
     for( const auto & hd : hdata ){ 
       TH1 * h = const_cast<TH1*>(hd.hist);
       ATH_MSG_DEBUG(" Histo tool  h "<< h->GetName() );
       m_vBookedHistograms.push_back(hd);
       modifyNameAndTitle(h);
     }
   }
   return count;
 }

◆ 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

◆ fillHistos()

int HistoGroupBase::fillHistos ( )

virtualinherited

Reimplemented in JetContainerHistoFiller.

Definition at line 33 of file HistoGroupBase.cxx.

                               {
   return 0;  
 }

◆ fillHistosFromContainer()

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

virtual

Set the contPtr to the relevant container according to m_selType

Reimplemented from JetHistoBase.

Definition at line 79 of file HistosForJetSelection.cxx.

                                                                                              {
  
   ConstDataVector< xAOD::JetContainer > tmpCont(SG::VIEW_ELEMENTS);
   const xAOD::JetContainer * contPtr = nullptr;
  
   switch((SelectionType)m_selType){
   case LeadingJet:
     {
       if(!cont.empty()){
         tmpCont.push_back(cont[0]);
         contPtr = tmpCont.asDataVector();
       } else return 0;
     }
     break;
  
   case SubLeadingJet:
     {
       if(cont.size()>1){
         tmpCont.push_back(cont[1]);
         contPtr = tmpCont.asDataVector();
       }else return 0;
     }
     break;
  
   case AllJets:
     contPtr = &cont;
     break;
  
   case FromTool:
     {
       // filter :
       for(const xAOD::Jet* jet : cont ) { 
     if( m_inverseToolSelection ) 
       {
         if(! m_selTool->keep(*jet) ) 
           {
         tmpCont.push_back(jet) ;
           }
       }
     else if( m_selTool->keep(*jet) ) 
       {
         tmpCont.push_back(jet) ;
       }
       }
       contPtr = tmpCont.asDataVector();
     }
     break;
   default:
     break;
   }
  
   // then fill histos
   for( auto jtool : m_histoTools){
     ATH_MSG_DEBUG ("    Filling  " << jtool->name() << "..." );
     jtool->fillHistosFromContainer(*contPtr, weight);
   }
   return 0;
 }

◆ fillHistosFromJet()

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

virtualinherited

Reimplemented in JetAttributeHisto, JetKinematicHistos, JetSubStructureHistos, and HIJetUEMonitoring.

Definition at line 30 of file JetHistoBase.cxx.

30 { return 0;}

◆ finalizeHistos()

int HistosForJetSelection::finalizeHistos ( )

virtual

Reimplemented from JetHistoBase.

Definition at line 144 of file HistosForJetSelection.cxx.

                                          {
   int count = 0;
   for( auto jtool : m_histoTools){
     count+=jtool->finalizeHistos();
   }
   return count;
  
 }

◆ 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 HistosForJetSelection::initialize ( )

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

Definition at line 25 of file HistosForJetSelection.cxx.

                                              {
   CHECK( m_histoTools.retrieve() );
   CHECK( JetHistoBase::initialize() );
  
   // build the title and name modifiers
  
   switch((SelectionType)m_selType){
   case LeadingJet:
     m_titleSuffix = " (Leading Jet)";
     m_nameSuffix = "leadingjet";
     break;
   case SubLeadingJet:
     m_titleSuffix = " (SubLeading Jet)";
     m_nameSuffix = "subleadingjet";
     break;
   case FromTool:
     {
       CHECK(m_selTool.retrieve());
       if( (m_nameSuffix.empty() ) || (m_titleSuffix.empty()) ) {
         ATH_MSG_ERROR("When using a selection tool, please set BOTH of HistoTitleSuffix (="<<m_titleSuffix<<") and HistoNameSuffix (="<<m_nameSuffix<<") or set them explicitely to 'none'. This is to avoid histo names clashes.");
         return StatusCode::FAILURE;      
       }
       if(m_nameSuffix == "none")  m_nameSuffix="";
       if(m_titleSuffix == "none") m_titleSuffix="";
       // either ask from tool or let m_xxSuffix be properties
     }
     break;
   default:
     break;
   }
   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()

static const InterfaceID& JetHistoBase::interfaceID ( )

inlinestaticinherited

Definition at line 45 of file JetHistoBase.h.

45 {return IID_JetHistoBase;}

◆ modifyNameAndTitle()

void HistosForJetSelection::modifyNameAndTitle ( TH1 * h )

protectedvirtual

Definition at line 139 of file HistosForJetSelection.cxx.

                                                     {
   h->SetName( (h->GetName()+m_nameSuffix).c_str());
   h->SetTitle( (h->GetTitle()+m_titleSuffix).c_str() );
 }

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

◆ prefixHistoDir()

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

virtual

redefine to forward to sub histos

Reimplemented from HistoGroupBase.

Definition at line 153 of file HistosForJetSelection.cxx.

                                                                   {
   for( auto jtool : m_histoTools){
     jtool->prefixHistoDir(preDir+m_histoDir);
   }
 }

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

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

void HistosForJetSelection::setInterval	(	Interval_t	ityp,
		bool	force = `false`
	)

virtual

redefine to forward to sub histos

Reimplemented from HistoGroupBase.

Definition at line 159 of file HistosForJetSelection.cxx.

                                                                    {
   // propagate interval to sub-tools
   for( auto jtool : m_histoTools){
     jtool->setInterval(ityp,force);
   }
 }

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

std::string HistoGroupBase::m_histoDir

protectedinherited

The path where histos in this group leave.

Definition at line 93 of file HistoGroupBase.h.

◆ m_histoTools

ToolHandleArray<JetHistoBase> HistosForJetSelection::m_histoTools

protected

List of histo tools to call on selected jets.

Definition at line 64 of file HistosForJetSelection.h.

◆ m_interval

int HistoGroupBase::m_interval

protectedinherited

Definition at line 101 of file HistoGroupBase.h.

◆ m_inverseToolSelection

bool HistosForJetSelection::m_inverseToolSelection = false

Definition at line 48 of file HistosForJetSelection.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_nameSuffix

std::string HistosForJetSelection::m_nameSuffix

protected

Suffix of the histos names.

Definition at line 74 of file HistosForJetSelection.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_selTool

ToolHandle<IJetSelector> HistosForJetSelection::m_selTool

protected

Definition at line 66 of file HistosForJetSelection.h.

◆ m_selType

int HistosForJetSelection::m_selType

protected

used only if m_selType == FromTool

Flag for the selection

Definition at line 69 of file HistosForJetSelection.h.

◆ m_titleSuffix

std::string HistosForJetSelection::m_titleSuffix

protected

Suffix of the histos titles. If the property is not set and using a built-in type, it will be automatically chosen.

Definition at line 72 of file HistosForJetSelection.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

Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ Interval_t

◆ SelectionType

Constructor & Destructor Documentation

◆ HistosForJetSelection()

◆ ~HistosForJetSelection()

Member Function Documentation

◆ ASG_TOOL_CLASS0()

◆ bookedHistograms()

◆ bookHisto()

◆ bookHistoInSubDir()

◆ buildHistos()

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

◆ fillHistos()

◆ fillHistosFromContainer()

◆ fillHistosFromJet()

◆ finalizeHistos()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ modifyNameAndTitle()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ prefixHistoDir()

◆ print()

◆ renameAndRegister()

◆ renounce()

◆ renounceArray()

◆ setInterval()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_histoDir

◆ m_histoTools

◆ m_interval

◆ m_inverseToolSelection

◆ m_monIntervalType

◆ m_nameSuffix

◆ m_prefixedHistoName

◆ m_selTool

◆ m_selType

◆ m_titleSuffix

◆ m_varHandleArraysDeclared

◆ m_vBookedHistograms

◆ m_vhka