JetContainerHistoFiller Class Reference

Fill a list of histos on a JetContainer. More...

#include <JetContainerHistoFiller.h>

Inheritance diagram for JetContainerHistoFiller:

Collaboration diagram for JetContainerHistoFiller:

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
	JetContainerHistoFiller (const std::string &t)
virtual	~JetContainerHistoFiller ()
virtual StatusCode	initialize ()
	Dummy implementation of the initialisation function.
virtual int	buildHistos ()
virtual int	fillHistos ()
virtual int	finalizeHistos ()
virtual void	prefixHistoDir (const std::string &preDir)
	redefine from base class to forward prefix path to sub histos
virtual void	setInterval (Interval_t ityp, bool force=false)
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	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
ToolHandleArray< JetHistoBase >	m_histoTools
	The list of histogramming tools.
SG::ReadHandleKey< xAOD::JetContainer >	m_jetContainerName {this, "JetContainer", ""}
	the jet container to build histos from
SG::ReadHandleKey< xAOD::EventInfo >	m_EventInfoKey {this, "EventInfoKey", "EventInfo"}
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

Fill a list of histos on a JetContainer.

Definition at line 28 of file JetContainerHistoFiller.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

JetContainerHistoFiller()

JetContainerHistoFiller::JetContainerHistoFiller

(

const std::string &

t

)

Definition at line 7 of file JetContainerHistoFiller.cxx.

                                                                   : HistoGroupBase(n)
                                                                       , m_histoTools(this)
{
  declareInterface<JetContainerHistoFiller>(this);
  declareProperty("HistoTools", m_histoTools);
 
}

~JetContainerHistoFiller()

virtual JetContainerHistoFiller::~JetContainerHistoFiller ( )

inlinevirtual

Definition at line 36 of file JetContainerHistoFiller.h.

{}

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.

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

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

buildHistos()

int JetContainerHistoFiller::buildHistos ( )

virtual

Reimplemented from HistoGroupBase.

Definition at line 76 of file JetContainerHistoFiller.cxx.

                                        {
  int count=0;
 
  ATH_MSG_DEBUG ("Building hists " );
 
  // ask subtools to build their histos
  for( auto jtool : m_histoTools){
    count+=jtool->buildHistos();
    ATH_MSG_DEBUG (" *** Built hist :  "<<jtool->name()  );
    
    // keep a pointer to histos :
    const auto & hdata = jtool->bookedHistograms();
    for( const auto & hd : hdata ){ 
      m_vBookedHistograms.push_back(hd);
    }
  }
  return count;    
}

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.

{ return m_detStore; }

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.

{ 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 JetContainerHistoFiller::fillHistos ( )

virtual

simply call fillHistosFromContainer() for each tool...

Reimplemented from HistoGroupBase.

Definition at line 33 of file JetContainerHistoFiller.cxx.

                                       {
 
  ATH_MSG_DEBUG ("Filling hists " << name() << "..." << m_jetContainerName.key());
 
  SG::ReadHandle<xAOD::EventInfo> evtInfo{m_EventInfoKey};
  if (!evtInfo.isValid()) {
    ATH_MSG_DEBUG("Unable to retrieve xAOD::EventInfo");
    return 1;
  }
 
  //LAr event veto: skip events rejected by LAr
  if(evtInfo->errorState(xAOD::EventInfo::LAr)==xAOD::EventInfo::Error){
    ATH_MSG_DEBUG("SKIP for LAR error");
    return 1;
  }
  
  SG::ReadHandle<xAOD::JetContainer> jCont{m_jetContainerName};
  if( !jCont.isValid() ) {
    ATH_MSG_DEBUG (" No container  " << m_jetContainerName.key()<< " in Evt store. Returning.");
    return 0;
  }
 
  float weight = evtInfo->beamSpotWeight();

  int count = 0;
  for( auto jtool : m_histoTools){
    ATH_MSG_DEBUG ("Filling hists " << jtool->name() << "..." << jCont);
 
    count += jtool->fillHistosFromContainer(*jCont, weight);
  }
 
  return count;    
}

finalizeHistos()

int JetContainerHistoFiller::finalizeHistos ( )

virtual

Reimplemented from HistoGroupBase.

Definition at line 96 of file JetContainerHistoFiller.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 JetContainerHistoFiller::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.

Definition at line 15 of file JetContainerHistoFiller.cxx.

                                               {
 
  CHECK( m_histoTools.retrieve() );
 
  if(m_jetContainerName.empty()) {
    ATH_MSG_ERROR("Jet Container name not set. Please set the JetContainer property");
    return StatusCode::FAILURE;
  }
  CHECK( m_jetContainerName.initialize() );
  CHECK( m_EventInfoKey.initialize() );
 
  if(m_histoDir.empty()) m_histoDir =  m_jetContainerName.key()+"/";
 
  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 & JetContainerHistoFiller::interfaceID ( )

inlinestatic

Definition at line 50 of file JetContainerHistoFiller.h.

{return IID_JetContainerHistoFiller;}

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 JetContainerHistoFiller::prefixHistoDir ( const std::string & preDir )

virtual

redefine from base class to forward prefix path to sub histos

Reimplemented from HistoGroupBase.

Definition at line 104 of file JetContainerHistoFiller.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 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()

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

virtual

Reimplemented from HistoGroupBase.

Definition at line 68 of file JetContainerHistoFiller.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 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_EventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> JetContainerHistoFiller::m_EventInfoKey {this, "EventInfoKey", "EventInfo"}

protected

Definition at line 62 of file JetContainerHistoFiller.h.

{this, "EventInfoKey", "EventInfo"};

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> JetContainerHistoFiller::m_histoTools

protected

The list of histogramming tools.

Definition at line 59 of file JetContainerHistoFiller.h.

m_interval

int HistoGroupBase::m_interval

protectedinherited

Definition at line 101 of file HistoGroupBase.h.

m_jetContainerName

SG::ReadHandleKey<xAOD::JetContainer> JetContainerHistoFiller::m_jetContainerName {this, "JetContainer", ""}

protected

the jet container to build histos from

Definition at line 61 of file JetContainerHistoFiller.h.

{this, "JetContainer", ""};

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:

• JetContainerHistoFiller.h
• JetContainerHistoFiller.cxx