ana::AnaToolSelect< XAODContainer > Class Template Reference

The base class for tools implementing basic object selection. More...

#include <AnaToolSelect.h>

Inheritance diagram for ana::AnaToolSelect< XAODContainer >:
ana::IAnaTool ana::AnaTool CP::ISystematicsTool ana::IAnaTool asg::AsgTool asg::IAsgTool CP::ISystematicsTool asg::IAsgTool asg::IAsgTool

List of all members.

Public Types

typedef XAODContainer ContainerType
 the container type we are operating on
typedef
XAODContainer::base_value_type 
XAODObject
 the object type we are operating on

Public Member Functions

virtual StatusCode setObjectType (ObjectType type, const std::string &workingPoint) override
 AnaToolSelect (const std::string &name)
 standard constructor
virtual AnalysisStep step () const override
virtual unsigned inputTypes () const override
virtual unsigned outputTypes () const override
virtual StatusCode useConfiguration (const InternalConfiguration &configuration) override
virtual StatusCode execute (IEventObjects &objects) override
virtual StatusCode selectObject (XAODObject &object)=0
 run the selection on this object
void registerCut (SelectionStep step, const std::string &name, SelectionCut &cut)
 add a cut with the given name and selection step

Detailed Description

template<class XAODContainer>
class ana::AnaToolSelect< XAODContainer >

The base class for tools implementing basic object selection.


Constructor & Destructor Documentation

template<class XAODContainer >
ana::AnaToolSelect< XAODContainer >::AnaToolSelect ( const std::string &  name  )  [inline]

standard constructor

Guarantee
strong
Failures
out of memory II

Member Function Documentation

template<class XAODContainer >
StatusCode ana::AnaToolSelect< XAODContainer >::execute ( IEventObjects objects  )  [inline, override, virtual]

apply this analysis tool to the objects

Parameters:
objects the objects to apply this too
Guarantee
basic
Failures
tool dependent

Implements ana::IAnaTool.

template<class XAODContainer >
unsigned ana::AnaToolSelect< XAODContainer >::inputTypes (  )  const [inline, override, virtual]

a bit-map indicating which object types we use

Guarantee
no-fail

Implements ana::IAnaTool.

template<class XAODContainer >
unsigned ana::AnaToolSelect< XAODContainer >::outputTypes (  )  const [inline, override, virtual]

a bit-map indicating which output types we will create

Guarantee
no-fail

Implements ana::IAnaTool.

template<class XAODContainer >
void ana::AnaToolSelect< XAODContainer >::registerCut ( SelectionStep  step,
const std::string &  name,
SelectionCut cut 
) [inline]

add a cut with the given name and selection step

Guarantee
strong
Failures
out of memory II
Precondition:
!isInitialized()
template<class XAODContainer>
virtual StatusCode ana::AnaToolSelect< XAODContainer >::selectObject ( XAODObject object  )  [pure virtual]

run the selection on this object

Parameters:
object the object to evaluate
[out] accept whether the object passes object selection
Guarantee
basic
Failures
tool dependent
template<class XAODContainer >
StatusCode ana::AnaToolSelect< XAODContainer >::setObjectType ( ObjectType  type,
const std::string &  workingPoint 
) [inline, override, virtual]

set the object type to work on this is called straight after the tool is created and before it is initialized. the primary reason for this function is to allow jet definitions to be used for either jets or fat jets.

Parameters:
type the object type we work on
workingPoint the name of the working point we are working on or the empty string if this is a sole working point or working points do not apply
Guarantee
strong
Failures
unsupported object type this interface may change when I introduce multiple simultaneous working points

Implements ana::IAnaTool.

template<class XAODContainer >
AnalysisStep ana::AnaToolSelect< XAODContainer >::step (  )  const [inline, override, virtual]

the processing step we are working on

Guarantee
no-fail

Implements ana::IAnaTool.

template<class XAODContainer >
StatusCode ana::AnaToolSelect< XAODContainer >::useConfiguration ( const InternalConfiguration configuration  )  [inline, override, virtual]

extract whatever we need from the given configuration object

Guarantee
basic
Failures
tool failures

Reimplemented from ana::AnaTool.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1