ana::AnaToolWeight< XAODContainer > Class Template Reference

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

#include <AnaToolWeight.h>

Inheritance diagram for ana::AnaToolWeight< XAODContainer >:

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
	AnaToolWeight (const std::string &name)
	standard constructor
virtual StatusCode	setObjectType (ObjectType type, const std::string &workingPoint) override
virtual AnalysisStep	step () const override
virtual unsigned	inputTypes () const override
virtual unsigned	outputTypes () const override
virtual StatusCode	execute (IEventObjects &objects) override
virtual StatusCode	objectWeight (const XAODObject &object, float &weight)=0
	calculate the weight for this event

---

Detailed Description

template<class XAODContainer>
class ana::AnaToolWeight< XAODContainer >

The base class for tools implementing basic object weights.

---

Constructor & Destructor Documentation

template<class XAODContainer >

ana::AnaToolWeight< XAODContainer >::AnaToolWeight

(

const std::string &

name

)

[inline]

standard constructor

Guarantee

strong

Failures

out of memory II

---

Member Function Documentation

template<class XAODContainer >

StatusCode ana::AnaToolWeight< 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.

Reimplemented in ana::JetToolWeight.

template<class XAODContainer >

unsigned ana::AnaToolWeight< XAODContainer >::inputTypes

(

)

const [inline, override, virtual]

a bit-map indicating which object types we use

Guarantee

no-fail

Implements ana::IAnaTool.

Reimplemented in ana::JetToolWeight.

template<class XAODContainer>

virtual StatusCode ana::AnaToolWeight< XAODContainer >::objectWeight	(	const XAODObject &	object,
		float &	weight
	)			[pure virtual]

calculate the weight for this event

Parameters:

	object	the object to evaluate
[out]	weight	the calculated weight

Guarantee

basic

Failures

tool dependent

Postcondition:

result > 0

template<class XAODContainer >

unsigned ana::AnaToolWeight< XAODContainer >::outputTypes

(

)

const [inline, override, virtual]

a bit-map indicating which output types we will create

Guarantee

no-fail

Implements ana::IAnaTool.

Reimplemented in ana::JetToolWeight.

template<class XAODContainer >

StatusCode ana::AnaToolWeight< 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::AnaToolWeight< XAODContainer >::step

(

)

const [inline, override, virtual]

the processing step we are working on

Guarantee

no-fail

Implements ana::IAnaTool.

---

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

• /cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.31/QuickAna/QuickAna/AnaToolWeight.h
• /cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.31/QuickAna/QuickAna/AnaToolWeight.icc