ATLAS Offline Software
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
JetContainerHistoFiller Class Reference

#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. More...
 
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 More...
 
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. 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 ()
 

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. 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< JetHistoBasem_histoTools
 The list of histogramming tools. More...
 
SG::ReadHandleKey< xAOD::JetContainerm_jetContainerName {this, "JetContainer", ""}
 the jet container to build histos from More...
 
SG::ReadHandleKey< xAOD::EventInfom_EventInfoKey {this, "EventInfoKey", "EventInfo"}
 
std::vector< HistDatam_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< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

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

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

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.

37  { file = 0, eventsBlock, lumiBlock,
39  run, fill, all,
40 
41  useToolInterval // used to use the value from the tool's m_interval property
42  };

Constructor & Destructor Documentation

◆ JetContainerHistoFiller()

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

Definition at line 7 of file JetContainerHistoFiller.cxx.

8  , m_histoTools(this)
9 {
10  declareInterface<JetContainerHistoFiller>(this);
11  declareProperty("HistoTools", m_histoTools);
12 
13 }

◆ ~JetContainerHistoFiller()

virtual JetContainerHistoFiller::~JetContainerHistoFiller ( )
inlinevirtual

Definition at line 36 of file JetContainerHistoFiller.h.

36 {}

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.

45  {
46  return m_vBookedHistograms;
47 }

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

Reimplemented from HistoGroupBase.

Definition at line 76 of file JetContainerHistoFiller.cxx.

76  {
77  int count=0;
78 
79  ATH_MSG_DEBUG ("Building hists " );
80 
81  // ask subtools to build their histos
82  for( auto jtool : m_histoTools){
83  count+=jtool->buildHistos();
84  ATH_MSG_DEBUG (" *** Built hist : "<<jtool->name() );
85 
86  // keep a pointer to histos :
87  const auto & hdata = jtool->bookedHistograms();
88  for( const auto & hd : hdata ){
89  m_vBookedHistograms.push_back(hd);
90  }
91  }
92  return count;
93 }

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

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

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

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

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

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

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

200  {
201  return PBASE::declareProperty(t);
202  }

◆ 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
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ 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
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

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

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ 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
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ 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
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

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

simply call fillHistosFromContainer() for each tool...

Reimplemented from HistoGroupBase.

Definition at line 33 of file JetContainerHistoFiller.cxx.

33  {
34 
35  ATH_MSG_DEBUG ("Filling hists " << name() << "..." << m_jetContainerName.key());
36 
38  if (!evtInfo.isValid()) {
39  ATH_MSG_DEBUG("Unable to retrieve xAOD::EventInfo");
40  return 1;
41  }
42 
43  //LAr event veto: skip events rejected by LAr
44  if(evtInfo->errorState(xAOD::EventInfo::LAr)==xAOD::EventInfo::Error){
45  ATH_MSG_DEBUG("SKIP for LAR error");
46  return 1;
47  }
48 
50  if( !jCont.isValid() ) {
51  ATH_MSG_DEBUG (" No container " << m_jetContainerName.key()<< " in Evt store. Returning.");
52  return 0;
53  }
54 
55  float weight = evtInfo->beamSpotWeight();
56 
58  int count = 0;
59  for( auto jtool : m_histoTools){
60  ATH_MSG_DEBUG ("Filling hists " << jtool->name() << "..." << jCont);
61 
62  count += jtool->fillHistosFromContainer(*jCont, weight);
63  }
64 
65  return count;
66 }

◆ finalizeHistos()

int JetContainerHistoFiller::finalizeHistos ( )
virtual

Reimplemented from HistoGroupBase.

Definition at line 96 of file JetContainerHistoFiller.cxx.

96  {
97  int count = 0;
98  for( auto jtool : m_histoTools){
99  count+=jtool->finalizeHistos();
100  }
101  return count;
102 }

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

119  {
120 
121 #ifdef XAOD_STANDALONE
122  // In case we use @c xAOD::TEvent, we have a direct function call
123  // for this.
124  return evtStore()->event()->getKey( ptr );
125 #else
126  const SG::DataProxy* proxy = evtStore()->proxy( ptr );
127  return ( proxy == nullptr ? 0 : proxy->sgkey() );
128 #endif // XAOD_STANDALONE
129  }

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

106  {
107 
108 #ifdef XAOD_STANDALONE
109  // In case we use @c xAOD::TEvent, we have a direct function call
110  // for this.
111  return evtStore()->event()->getName( ptr );
112 #else
113  const SG::DataProxy* proxy = evtStore()->proxy( ptr );
114  static const std::string dummy = "";
115  return ( proxy == nullptr ? dummy : proxy->name() );
116 #endif // XAOD_STANDALONE
117  }

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

15  {
16 
17  CHECK( m_histoTools.retrieve() );
18 
19  if(m_jetContainerName.empty()) {
20  ATH_MSG_ERROR("Jet Container name not set. Please set the JetContainer property");
21  return StatusCode::FAILURE;
22  }
23  CHECK( m_jetContainerName.initialize() );
25 
26  if(m_histoDir.empty()) m_histoDir = m_jetContainerName.key()+"/";
27 
28  return StatusCode::SUCCESS;
29 }

◆ 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& JetContainerHistoFiller::interfaceID ( )
inlinestatic

Definition at line 50 of file JetContainerHistoFiller.h.

50 {return IID_JetContainerHistoFiller;}

◆ msg() [1/2]

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

Definition at line 24 of file AthCommonMsg.h.

24  {
25  return this->msgStream();
26  }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

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

101  {
102 
103  return MSG::name( msg().level() );
104  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30  {
31  return this->msgLevel(lvl);
32  }

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

104  {
105  for( auto jtool : m_histoTools){
106  jtool->prefixHistoDir(preDir+m_histoDir);
107  }
108 }

◆ print()

void asg::AsgTool::print ( ) const
virtualinherited

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

50  {
51 
52  if( h == nullptr ) return;
53 
54  if( ityp == useToolInterval) ityp = (Interval_t) m_interval;
55 
56  std::string path = m_histoDir+subD;
57  std::string prefix="";
58  if( m_prefixedHistoName) {
59  prefix = path;
60  std::replace( prefix.begin(), prefix.end(), '/', '_');
61  }
62  h->SetName( (prefix+h->GetName()).c_str() );
63 
64  m_vBookedHistograms.push_back( {h, path, ityp} );
65 }

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

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

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

364  {
365  handlesArray.renounce();
366  }

◆ setInterval()

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

Reimplemented from HistoGroupBase.

Definition at line 68 of file JetContainerHistoFiller.cxx.

68  {
69  // propagate interval to sub-tools
70  for( auto jtool : m_histoTools){
71  jtool->setInterval(ityp,force);
72  }
73 }

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

308  {
309  // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310  // << " size: " << m_vhka.size() << endmsg;
311  for (auto &a : m_vhka) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

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.

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

◆ 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:
HistoGroupBase::m_prefixedHistoName
bool m_prefixedHistoName
true if the histo name should contain the full hierarchy path
Definition: HistoGroupBase.h:99
replace
std::string replace(std::string s, const std::string &s2, const std::string &s3)
Definition: hcg.cxx:307
HistoGroupBase::all
@ all
Definition: HistoGroupBase.h:39
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
athena.path
path
python interpreter configuration --------------------------------------—
Definition: athena.py:128
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
calibdata.force
bool force
Definition: calibdata.py:19
HistoGroupBase::file
@ file
Definition: HistoGroupBase.h:37
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:70
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
HistoGroupBase::fill
@ fill
Definition: HistoGroupBase.h:39
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
dbg::ptr
void * ptr(T *p)
Definition: SGImplSvc.cxx:74
HistoGroupBase::m_interval
int m_interval
Definition: HistoGroupBase.h:101
xAOD::EventInfo_v1::LAr
@ LAr
The LAr calorimeter.
Definition: EventInfo_v1.h:335
HistoGroupBase::medStat
@ medStat
Definition: HistoGroupBase.h:38
XMLtoHeader.count
count
Definition: XMLtoHeader.py:85
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
xAOD::EventInfo_v1::Error
@ Error
The sub-detector issued an error.
Definition: EventInfo_v1.h:349
dqt_zlumi_pandas.weight
int weight
Definition: dqt_zlumi_pandas.py:189
IDTPMcnv.htype
htype
Definition: IDTPMcnv.py:29
HistoGroupBase::useToolInterval
@ useToolInterval
Definition: HistoGroupBase.h:41
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
python.utils.AtlRunQueryDQUtils.p
p
Definition: AtlRunQueryDQUtils.py:210
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
HistoGroupBase::run
@ run
Definition: HistoGroupBase.h:39
beamspotman.n
n
Definition: beamspotman.py:731
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
extractSporadic.h
list h
Definition: extractSporadic.py:97
checkCorrelInHIST.prefix
dictionary prefix
Definition: checkCorrelInHIST.py:391
HistoGroupBase::lumiBlock
@ lumiBlock
Definition: HistoGroupBase.h:37
python.xAODType.dummy
dummy
Definition: xAODType.py:4
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
CHECK
#define CHECK(...)
Evaluate an expression and check for errors.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:422
JetContainerHistoFiller::m_histoTools
ToolHandleArray< JetHistoBase > m_histoTools
The list of histogramming tools.
Definition: JetContainerHistoFiller.h:59
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
SG::VarHandleKey::initialize
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:103
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
HistoGroupBase::m_histoDir
std::string m_histoDir
The path where histos in this group leave.
Definition: HistoGroupBase.h:93
JetContainerHistoFiller::m_EventInfoKey
SG::ReadHandleKey< xAOD::EventInfo > m_EventInfoKey
Definition: JetContainerHistoFiller.h:62
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
HistoGroupBase::lowStat
@ lowStat
Definition: HistoGroupBase.h:38
HistoGroupBase::Interval_t
Interval_t
Redefinition of fill intervals as in ManagedMonitorToolBase.
Definition: HistoGroupBase.h:37
a
TList * a
Definition: liststreamerinfos.cxx:10
h
HistoGroupBase::eventsBlock
@ eventsBlock
Definition: HistoGroupBase.h:37
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:623
HistoGroupBase::HistoGroupBase
HistoGroupBase(const std::string &t)
Definition: HistoGroupBase.cxx:10
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
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:798
JetContainerHistoFiller::m_jetContainerName
SG::ReadHandleKey< xAOD::JetContainer > m_jetContainerName
the jet container to build histos from
Definition: JetContainerHistoFiller.h:61
SG::DataProxy
Definition: DataProxy.h:45
HistoGroupBase::m_vBookedHistograms
std::vector< HistData > m_vBookedHistograms
The list of histos in this group.
Definition: HistoGroupBase.h:90
HistoGroupBase::higStat
@ higStat
Definition: HistoGroupBase.h:38
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
fitman.k
k
Definition: fitman.py:528