ORUtils::OverlapDecorationHelper Class Reference

Encapsulates the code needed to access and set overlap-related decorations. More...

#include <OverlapDecorationHelper.h>

List of all members.

Public Member Functions

 OverlapDecorationHelper (const std::string &inputLabel, const std::string &outputLabel, bool outputPassValue=false)
 Constructor.
bool isInputObject (const xAOD::IParticle &obj) const
 Check if object is flagged as input for OR.
bool isRejectedObject (const xAOD::IParticle &obj) const
 Check if an object has been rejected by decoration.
bool isSurvivingObject (const xAOD::IParticle &obj) const
 Check if object is surviving OR thus far.
char getObjectPriority (const xAOD::IParticle &obj) const
 Get the user priority score, which is currently the input decoration.
void setOverlapDecoration (const xAOD::IParticle &obj, bool result)
 Set output decoration on object, pass or fail.
void setObjectPass (const xAOD::IParticle &obj)
 Shorthand way to set an object as passing overlap removal.
void setObjectFail (const xAOD::IParticle &obj)
 Shorthand way to set an object as failing overlap removal.
bool isDecorated (const xAOD::IParticleContainer &container) const
void initializeDecorations (const xAOD::IParticleContainer &container)
void resetDecorations (const xAOD::IParticleContainer &container)
 Helper method for setting all objects as passing.

Detailed Description

Encapsulates the code needed to access and set overlap-related decorations.

This utility class is used by the OverlapTools, but in principle could probably be used by a user as well.

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

Constructor & Destructor Documentation

ORUtils::OverlapDecorationHelper::OverlapDecorationHelper ( const std::string &  inputLabel,
const std::string &  outputLabel,
bool  outputPassValue = false 
)

Constructor.

Parameters:
inputLabel Input decoration name
outputLabel Output decoration name
outputPassValue Specifies the boolean value to assign to passing, or non-overlapping objects. Default value is false for historical reasons.

Member Function Documentation

void ORUtils::OverlapDecorationHelper::initializeDecorations ( const xAOD::IParticleContainer container  ) 

Initialize decorations for a container to "pass". Note that the value written depends on the output pass-value.

bool ORUtils::OverlapDecorationHelper::isDecorated ( const xAOD::IParticleContainer container  )  const

Check if output decoration has been applied to a container. Returns false if the container is empty. Output logic independent.


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