Mēnsūra
Public Member Functions | Protected Attributes | List of all members
PileUpReader Class Reference

Abstract base class for a reader plugin that provides information about pile-up. More...

#include <PileUpReader.hpp>

Inheritance diagram for PileUpReader:
ReaderPlugin Plugin PECPileUpReader

Public Member Functions

 PileUpReader (std::string const name="PileUp")
 Creates plugin with the given name. More...
 
 PileUpReader (PileUpReader const &)=default
 Default copy constructor.
 
 PileUpReader (PileUpReader &&)=default
 Default move constructor.
 
PileUpReaderoperator= (PileUpReader const &)=delete
 Assignment operator is deleted.
 
virtual ~PileUpReader ()
 Trivial destructor.
 
unsigned GetNumVertices () const
 Returns number of reconstructed primary vertices.
 
double GetExpectedPileUp () const
 Returns expected amount of pile-up (aka "true" number of interactions) More...
 
double GetRho () const
 Returns median angular pt density (GeV)
 
- Public Member Functions inherited from ReaderPlugin
 ReaderPlugin (std::string const &name)
 Constructor.
 
 ReaderPlugin (ReaderPlugin const &)=default
 Default copy constructor.
 
 ReaderPlugin (ReaderPlugin &&)=default
 Default move constructor.
 
ReaderPluginoperator= (ReaderPlugin const &)=default
 Default assignment operator.
 
virtual ~ReaderPlugin ()
 Trivial destructor.
 
- Public Member Functions inherited from Plugin
 Plugin (std::string const &name)
 Constructor.
 
 Plugin (Plugin const &)=default
 Default copy constructor.
 
 Plugin (Plugin &&)=default
 Default move constructor.
 
Pluginoperator= (Plugin const &)=default
 Default assignment operator.
 
virtual ~Plugin ()
 Trivial destructor.
 
virtual void BeginRun (Dataset const &dataset)
 Performs initialization needed when processing of a new dataset starts. More...
 
virtual PluginClone () const =0
 Clones the object. More...
 
virtual void EndRun ()
 Performs necessary actions needed after processing of a dataset is finished. More...
 
Processor const & GetMaster () const
 Returns a reference to the master. More...
 
std::string const & GetName () const
 Returns name of the plugin.
 
EventOutcome ProcessEventToOutcome ()
 Processes a new event from the current dataset. More...
 
void SetMaster (Processor const *processor)
 Provides a pointer to an instance of Processor class that owns the plugin. More...
 

Protected Attributes

unsigned numVertices
 Number of reconstructed primary vertices.
 
double expectedPileUp
 Expected pile-up.
 
double rho
 Median angular pt density, GeV.
 

Additional Inherited Members

- Public Types inherited from Plugin
enum  EventOutcome { EventOutcome::Ok, EventOutcome::FilterFailed, EventOutcome::NoEvents }
 Outcome of processing of an event. More...
 
- Protected Member Functions inherited from Plugin
Plugin const * GetDependencyPlugin (std::string const &name) const
 Returns a pointer to a precedent plugin in the path with the given name. More...
 

Detailed Description

Abstract base class for a reader plugin that provides information about pile-up.

Constructor & Destructor Documentation

PileUpReader::PileUpReader ( std::string const  name = "PileUp")

Creates plugin with the given name.

User is encouraged to keep the default name.

Member Function Documentation

double PileUpReader::GetExpectedPileUp ( ) const

Returns expected amount of pile-up (aka "true" number of interactions)

In data zero is returned.


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