ATLAS Offline Software
Public Member Functions | Static Public Member Functions | List of all members
IAFPSiLayerMonitor Class Referenceabstract

Interface of a class monitoring one silicon layer. More...

#include <IAFPSiLayerMonitor.h>

Inheritance diagram for IAFPSiLayerMonitor:
Collaboration diagram for IAFPSiLayerMonitor:

Public Member Functions

virtual ~IAFPSiLayerMonitor ()
 Does nothing. More...
 
virtual StatusCode initialize ()=0
 Initilise tool. More...
 
virtual StatusCode finalize ()=0
 Finalise tool. More...
 
virtual void setParentMonitor (AFPHitsMonitorTool *parent)=0
 Sets variable storing pointer to the main monitoring object. More...
 
virtual void bookHistograms (ManagedMonitorToolBase *toolToStoreHistograms, const std::string &histsDirName="")=0
 Creates, adds axes descriptions and books histograms filled by this monitor. More...
 
virtual void fillHistograms (const xAOD::AFPSiHit &hit)=0
 Fills histograms which have to be filled for each hit. More...
 
virtual void eventEnd ()
 Method that should be called when event processing is finished. More...
 
virtual void endOfLumiBlock ()
 Process histograms at the end of lumiblock. More...
 
virtual int layerID () const =0
 Pixel plane ID number. More...
 
virtual std::string makeHistName (const std::string &name) const =0
 Returns a name suffixed with station and layer numbers. More...
 
virtual std::string makeHistTitle (const std::string &title) const =0
 Returns a title suffixed with station and layer numbers. More...
 
virtual const std::string & histsDirName () const =0
 Returns name of the ROOT file directory where histograms are stored. More...
 
virtual const std::string & layerFullName () const =0
 Returns layer and station name used to label bins in summary histograms. More...
 
virtual double correctHitsForPileUp (double hits) const =0
 Normalises number of hits in an event to 0 pile-up. More...
 
virtual double hitsInEvent () const =0
 Number of pixels fired in an event. More...
 
virtual double hitsInEventScaled () const =0
 Returns number of pixels fired in an event corrected for pile-up. More...
 
virtual double hitsInEventHotSpot () const =0
 Number of pixels fired in an event in a hot-spot. More...
 
virtual double hitsInEventHotSpotScaled () const =0
 Number of hits in hot-spot corrected for pile-up. More...
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 

Detailed Description

Interface of a class monitoring one silicon layer.

Definition at line 22 of file IAFPSiLayerMonitor.h.

Constructor & Destructor Documentation

◆ ~IAFPSiLayerMonitor()

virtual IAFPSiLayerMonitor::~IAFPSiLayerMonitor ( )
inlinevirtual

Does nothing.

Definition at line 29 of file IAFPSiLayerMonitor.h.

29 {}

Member Function Documentation

◆ bookHistograms()

virtual void IAFPSiLayerMonitor::bookHistograms ( ManagedMonitorToolBase toolToStoreHistograms,
const std::string &  histsDirName = "" 
)
pure virtual

Creates, adds axes descriptions and books histograms filled by this monitor.

Implemented in AFPSiLayerMonitor.

◆ correctHitsForPileUp()

virtual double IAFPSiLayerMonitor::correctHitsForPileUp ( double  hits) const
pure virtual

Normalises number of hits in an event to 0 pile-up.

Implemented in AFPSiLayerMonitor.

◆ endOfLumiBlock()

virtual void IAFPSiLayerMonitor::endOfLumiBlock ( )
inlinevirtual

Process histograms at the end of lumiblock.

Default implementation does nothing.

Reimplemented in AFPSiLayerMonitor.

Definition at line 54 of file IAFPSiLayerMonitor.h.

54 {}

◆ eventEnd()

virtual void IAFPSiLayerMonitor::eventEnd ( )
inlinevirtual

Method that should be called when event processing is finished.

Default implementation does nothing.

Reimplemented in AFPSiLayerMonitor.

Definition at line 49 of file IAFPSiLayerMonitor.h.

49 {}

◆ fillHistograms()

virtual void IAFPSiLayerMonitor::fillHistograms ( const xAOD::AFPSiHit hit)
pure virtual

Fills histograms which have to be filled for each hit.

Implemented in AFPSiLayerMonitor.

◆ finalize()

virtual StatusCode IAFPSiLayerMonitor::finalize ( )
pure virtual

Finalise tool.

Implemented in AFPSiLayerMonitor.

◆ histsDirName()

virtual const std::string& IAFPSiLayerMonitor::histsDirName ( ) const
pure virtual

Returns name of the ROOT file directory where histograms are stored.

Implemented in AFPSiLayerMonitor.

◆ hitsInEvent()

virtual double IAFPSiLayerMonitor::hitsInEvent ( ) const
pure virtual

Number of pixels fired in an event.

Implemented in AFPSiLayerMonitor.

◆ hitsInEventHotSpot()

virtual double IAFPSiLayerMonitor::hitsInEventHotSpot ( ) const
pure virtual

Number of pixels fired in an event in a hot-spot.

Implemented in AFPSiLayerMonitor.

◆ hitsInEventHotSpotScaled()

virtual double IAFPSiLayerMonitor::hitsInEventHotSpotScaled ( ) const
pure virtual

Number of hits in hot-spot corrected for pile-up.

Implemented in AFPSiLayerMonitor.

◆ hitsInEventScaled()

virtual double IAFPSiLayerMonitor::hitsInEventScaled ( ) const
pure virtual

Returns number of pixels fired in an event corrected for pile-up.

Implemented in AFPSiLayerMonitor.

◆ initialize()

virtual StatusCode IAFPSiLayerMonitor::initialize ( )
pure virtual

Initilise tool.

Implemented in AFPSiLayerMonitor.

◆ interfaceID()

static const InterfaceID& IAFPSiLayerMonitor::interfaceID ( )
inlinestatic

Definition at line 25 of file IAFPSiLayerMonitor.h.

26  {return IID_IAFPSiLayerMonitor;}

◆ layerFullName()

virtual const std::string& IAFPSiLayerMonitor::layerFullName ( ) const
pure virtual

Returns layer and station name used to label bins in summary histograms.

Implemented in AFPSiLayerMonitor.

◆ layerID()

virtual int IAFPSiLayerMonitor::layerID ( ) const
pure virtual

Pixel plane ID number.

Implemented in AFPSiLayerMonitor.

◆ makeHistName()

virtual std::string IAFPSiLayerMonitor::makeHistName ( const std::string &  name) const
pure virtual

Returns a name suffixed with station and layer numbers.

Implemented in AFPSiLayerMonitor.

◆ makeHistTitle()

virtual std::string IAFPSiLayerMonitor::makeHistTitle ( const std::string &  title) const
pure virtual

Returns a title suffixed with station and layer numbers.

Implemented in AFPSiLayerMonitor.

◆ setParentMonitor()

virtual void IAFPSiLayerMonitor::setParentMonitor ( AFPHitsMonitorTool parent)
pure virtual

Sets variable storing pointer to the main monitoring object.

Implemented in AFPSiLayerMonitor.


The documentation for this class was generated from the following file: