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

This class provides an interface between event filtering algorithms and athena input/output streams,. More...

#include <ICutFlowSvc.h>

Inheritance diagram for ICutFlowSvc:
Collaboration diagram for ICutFlowSvc:

Public Member Functions

 DeclareInterfaceID (ICutFlowSvc, 1, 0)
 
virtual ~ICutFlowSvc ()
 
virtual CutIdentifier registerFilter (const std::string &name, const std::string &description, bool nominalOnly)=0
 Register filter in the CutFlowSvc and returns the CutID of the corresponding EventBookkeeper. More...
 
virtual CutIdentifier registerTopFilter ATLAS_NOT_THREAD_SAFE (const std::string &name, const std::string &description, unsigned int logic, const std::string &outputStream, bool nominalOnly)=0
 Tells CutFlowSvc that a filter is used directly by an outputStream with a given logical context. More...
 
virtual CutIdentifier registerCut (const std::string &name, const std::string &description, CutIdentifier parentCutID, bool nominalOnly)=0
 Register cut as child of a filter in the CutFlowSvc and returns the CutID of the corresponding EventBookkeeper. More...
 
virtual void setFilterDescription (CutIdentifier cutID, const std::string &descr)=0
 Set the description of an existing EventBookkeeper. More...
 
virtual void addEvent (CutIdentifier cutID, const std::vector< float > &weights)=0
 Tells CutFlowSvc to update the weighted event counter of a CutIdentifier A vector of weights is provided for all systematic variations. More...
 
virtual void addEvent (CutIdentifier cutID, double weight)=0
 Tells CutFlowSvc to update the weighted event counter of a CutIdentifier The same weight is for all systematic variations. More...
 
virtual uint64_t getNAcceptedEvents (const CutIdentifier cutID) const =0
 Get number of accepted events for a cut. More...
 

Detailed Description

This class provides an interface between event filtering algorithms and athena input/output streams,.

and returns a comprehensive summary of filters "Cut Flow" by internally using T/P EventBookkeeper objects.

ICutFlowSvc also supports flat TTree format for D3PD usage.

Definition at line 36 of file ICutFlowSvc.h.

Constructor & Destructor Documentation

◆ ~ICutFlowSvc()

ICutFlowSvc::~ICutFlowSvc ( )
virtual

Definition at line 30 of file ICutFlowSvc.cxx.

31 {}

Member Function Documentation

◆ addEvent() [1/2]

virtual void ICutFlowSvc::addEvent ( CutIdentifier  cutID,
const std::vector< float > &  weights 
)
pure virtual

Tells CutFlowSvc to update the weighted event counter of a CutIdentifier A vector of weights is provided for all systematic variations.

◆ addEvent() [2/2]

virtual void ICutFlowSvc::addEvent ( CutIdentifier  cutID,
double  weight 
)
pure virtual

Tells CutFlowSvc to update the weighted event counter of a CutIdentifier The same weight is for all systematic variations.

◆ ATLAS_NOT_THREAD_SAFE()

virtual CutIdentifier registerTopFilter ICutFlowSvc::ATLAS_NOT_THREAD_SAFE ( const std::string &  name,
const std::string &  description,
unsigned int  logic,
const std::string &  outputStream,
bool  nominalOnly 
)
pure virtual

Tells CutFlowSvc that a filter is used directly by an outputStream with a given logical context.

The only foreseen client should the DecisionSvc, with its Accept/Require/Veto.

◆ DeclareInterfaceID()

ICutFlowSvc::DeclareInterfaceID ( ICutFlowSvc  ,
,
 
)

◆ getNAcceptedEvents()

virtual uint64_t ICutFlowSvc::getNAcceptedEvents ( const CutIdentifier  cutID) const
pure virtual

Get number of accepted events for a cut.

◆ registerCut()

virtual CutIdentifier ICutFlowSvc::registerCut ( const std::string &  name,
const std::string &  description,
CutIdentifier  parentCutID,
bool  nominalOnly 
)
pure virtual

Register cut as child of a filter in the CutFlowSvc and returns the CutID of the corresponding EventBookkeeper.

This method should be used by filters to register their internal cuts that are not the Algs themselves.

◆ registerFilter()

virtual CutIdentifier ICutFlowSvc::registerFilter ( const std::string &  name,
const std::string &  description,
bool  nominalOnly 
)
pure virtual

Register filter in the CutFlowSvc and returns the CutID of the corresponding EventBookkeeper.

This method should be used by filters that register themselves. Systematic variations are optional.

◆ setFilterDescription()

virtual void ICutFlowSvc::setFilterDescription ( CutIdentifier  cutID,
const std::string &  descr 
)
pure virtual

Set the description of an existing EventBookkeeper.


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