ana::ORTool Class Reference

QuickAna tool for applying standard overlap removal. More...

#include <ORTool.h>

Inheritance diagram for ana::ORTool:
ana::AnaTool ana::IAnaTool asg::AsgTool CP::ISystematicsTool asg::IAsgTool asg::IAsgTool

List of all members.

Public Member Functions

 ORTool (const std::string &name)
 Standard constructor.
virtual StatusCode setObjectType (ObjectType type, const std::string &workingPoint) override
StatusCode initialize () override
 Initialize this tool.
virtual AnalysisStep step () const override
 Returns the processing step we are working on.
virtual unsigned inputTypes () const override
virtual unsigned outputTypes () const override
virtual StatusCode execute (IEventObjects &objects) override
 Apply overlap removal to the objects.

Detailed Description

QuickAna tool for applying standard overlap removal.

This AnaTool uses the overlap removal tools from AssociationUtils. It is able to apply either the harmonization note recommendations or the updated overlap removal recommendations via the RecommendationSet configuration property.

For more details on the overlap removal recommendations, see the AssociationUtils documentation: https://svnweb.cern.ch/trac/atlasoff/browser/PhysicsAnalysis/AnalysisCommon/AssociationUtils/trunk/doc/README.rst

Author:
Steve Farrell <Steven.Farrell@cern.ch>

Constructor & Destructor Documentation

ana::ORTool::ORTool ( const std::string &  name  ) 

Standard constructor.

guarantee: strong
failures: out of memory II

Member Function Documentation

StatusCode ana::ORTool::execute ( IEventObjects objects  )  [override, virtual]

Apply overlap removal to the objects.

guarantee: basic
failures: tool dependent

Implements ana::IAnaTool.

StatusCode ana::ORTool::initialize ( void   )  [override, virtual]

Initialize this tool.

guarantee: basic
failures: configuration errors

Reimplemented from asg::AsgTool.

unsigned ana::ORTool::inputTypes (  )  const [override, virtual]

a bit-map indicating which object types we use

Guarantee
no-fail

Implements ana::IAnaTool.

unsigned ana::ORTool::outputTypes (  )  const [override, virtual]

a bit-map indicating which output types we will create

Guarantee
no-fail

Implements ana::IAnaTool.

StatusCode ana::ORTool::setObjectType ( ObjectType  type,
const std::string &  workingPoint 
) [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.

AnalysisStep ana::ORTool::step (  )  const [override, virtual]

Returns the processing step we are working on.

guarantee: no-fail

Implements ana::IAnaTool.


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