ATLAS Offline Software
Public Member Functions | Protected Attributes | List of all members
AFPSiLayerSummaryProfileHit< T > Class Template Reference

Final class representing a summary distribution filled for every hit. More...

#include <AFPSiLayerSummaryProfileHit.h>

Inheritance diagram for AFPSiLayerSummaryProfileHit< T >:
Collaboration diagram for AFPSiLayerSummaryProfileHit< T >:

Public Member Functions

 AFPSiLayerSummaryProfileHit (AFPHitsMonitorTool *parentTool, const ManagedMonitorToolBase::MonGroup &monGrp, const std::string &name, const std::string &title, T(xAOD::AFPSiHit::*value)() const)
 Assigns values and calls base class constructor. More...
 
void fillHit (const std::string &binName, const xAOD::AFPSiHit &hit) override
 Fills the distribution using data passed in arguments. More...
 
void book ()
 Registers the m_profile as a histogram in m_parentTool. More...
 
TProfileprofile ()
 Returns the profile object m_profile. More...
 

Protected Attributes

T(xAOD::AFPSiHit::* m_value )() const
 pointer to the member method which calculates quantity used to fill the distribution. More...
 
TProfilem_profile
 The summary distribution. TProfile ensures proper merging of mean values. More...
 
AFPHitsMonitorToolm_parentTool
 Pointer to the parent tool in which the distribution is registered. More...
 
ManagedMonitorToolBase::MonGroup m_monGrp
 Configuration of the monitoring options. More...
 

Detailed Description

template<typename T>
class AFPSiLayerSummaryProfileHit< T >

Final class representing a summary distribution filled for every hit.

Definition at line 17 of file AFPSiLayerSummaryProfileHit.h.

Constructor & Destructor Documentation

◆ AFPSiLayerSummaryProfileHit()

template<typename T >
AFPSiLayerSummaryProfileHit< T >::AFPSiLayerSummaryProfileHit ( AFPHitsMonitorTool parentTool,
const ManagedMonitorToolBase::MonGroup monGrp,
const std::string &  name,
const std::string &  title,
T(xAOD::AFPSiHit::*)() const  value 
)
inline

Assigns values and calls base class constructor.

Parameters
parentToolpointer to the main monitoring tool to which the summary distribution belongs
monGrpconfiguration of the monitoring properties e.g. frequency of rebooking (per lumi-block, per run), directory where the distribution should be saved
namename of the distribution, used as key when saving the distribution to a file
titletitle of the distribution, displayed at the top of the distribution
valuepointer to the member method which calculates quantity used to fill the distribution

Definition at line 27 of file AFPSiLayerSummaryProfileHit.h.

27  :
28  AFPSiLayerSummaryProfileBase (parentTool, monGrp, name, title),
29  m_value(value)
30  {}

Member Function Documentation

◆ book()

void AFPSiLayerSummaryProfileBase::book ( )
inherited

Registers the m_profile as a histogram in m_parentTool.

Definition at line 34 of file AFPSiLayerSummaryProfileBase.cxx.

35 {
37 }

◆ fillHit()

template<typename T >
void AFPSiLayerSummaryProfileHit< T >::fillHit ( const std::string &  binName,
const xAOD::AFPSiHit hit 
)
inlineoverridevirtual

Fills the distribution using data passed in arguments.

Parameters
binNamename of the bin (layer) in summary distribution for which entry is to be added
hitpointer to the xAOD::AFPSiHit object which provides value used to fill the distribution

Implements IAFPSiLayerSummaryHit.

Definition at line 33 of file AFPSiLayerSummaryProfileHit.h.

34  {m_profile->Fill(binName.data(), (hit.*m_value)());}

◆ profile()

TProfile* AFPSiLayerSummaryProfileBase::profile ( )
inlineinherited

Returns the profile object m_profile.

Definition at line 35 of file AFPSiLayerSummaryProfileBase.h.

35 {return m_profile;}

Member Data Documentation

◆ m_monGrp

ManagedMonitorToolBase::MonGroup AFPSiLayerSummaryProfileBase::m_monGrp
protectedinherited

Configuration of the monitoring options.

Defines, among others, how often the distribution should be renewed e.g. every luminosity block or every run and sets where the distribution should be saved i.e. in which ROOT file directory.

Definition at line 49 of file AFPSiLayerSummaryProfileBase.h.

◆ m_parentTool

AFPHitsMonitorTool* AFPSiLayerSummaryProfileBase::m_parentTool
protectedinherited

Pointer to the parent tool in which the distribution is registered.

Definition at line 42 of file AFPSiLayerSummaryProfileBase.h.

◆ m_profile

TProfile* AFPSiLayerSummaryProfileBase::m_profile
protectedinherited

The summary distribution. TProfile ensures proper merging of mean values.

Definition at line 39 of file AFPSiLayerSummaryProfileBase.h.

◆ m_value

template<typename T >
T(xAOD::AFPSiHit::* AFPSiLayerSummaryProfileHit< T >::m_value) () const
protected

pointer to the member method which calculates quantity used to fill the distribution.

Definition at line 38 of file AFPSiLayerSummaryProfileHit.h.


The documentation for this class was generated from the following file:
AFPSiLayerSummaryProfileBase::m_monGrp
ManagedMonitorToolBase::MonGroup m_monGrp
Configuration of the monitoring options.
Definition: AFPSiLayerSummaryProfileBase.h:49
AFPSiLayerSummaryProfileBase::AFPSiLayerSummaryProfileBase
AFPSiLayerSummaryProfileBase(AFPHitsMonitorTool *parentTool, const ManagedMonitorToolBase::MonGroup &monGrp, const std::string &name, const std::string &title)
Creates a TPofile object m_profile and sets bin labels according to monitors in m_parentTool.
Definition: AFPSiLayerSummaryProfileBase.cxx:11
AFPSiLayerSummaryProfileBase::m_profile
TProfile * m_profile
The summary distribution. TProfile ensures proper merging of mean values.
Definition: AFPSiLayerSummaryProfileBase.h:39
athena.value
value
Definition: athena.py:122
AFPSiLayerSummaryProfileHit::m_value
T(xAOD::AFPSiHit::* m_value)() const
pointer to the member method which calculates quantity used to fill the distribution.
Definition: AFPSiLayerSummaryProfileHit.h:38
covarianceTool.title
title
Definition: covarianceTool.py:542
AFPSiLayerSummaryProfileBase::m_parentTool
AFPHitsMonitorTool * m_parentTool
Pointer to the parent tool in which the distribution is registered.
Definition: AFPSiLayerSummaryProfileBase.h:42
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:195
TProfile::Fill
int Fill(double, double)
Definition: rootspy.cxx:523
ManagedMonitorToolBase::regHist
virtual StatusCode regHist(TH1 *h, const std::string &system, Interval_t interval, MgmtAttr_t histo_mgmt=ATTRIB_MANAGED, const std::string &chain="", const std::string &merge="")
Registers a TH1 (including TH2, TH3, and TProfile) to be included in the output stream using logical ...
Definition: ManagedMonitorToolBase.cxx:1454