ORUtils::OverlapDecorationHelper Class Reference

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

#include <OverlapDecorationHelper.h>

Collaboration diagram for ORUtils::OverlapDecorationHelper:

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

Private Attributes
bool	m_useInputLabel
	Toggle usage of input label. More...
ort::inputAccessor_t	m_inputAccessor
	Input label accessor. More...
ort::outputDecorator_t	m_outputDecorator
	Output decorator. More...
bool	m_outputPassValue
	Output decoration logic. More...

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 Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 26 of file OverlapDecorationHelper.h.

Constructor & Destructor Documentation

OverlapDecorationHelper()

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.

Definition at line 14 of file OverlapDecorationHelper.cxx.

    : m_useInputLabel(!inputLabel.empty()),
      m_inputAccessor("OverlapDecorationHelper_Dummy"),
      m_outputDecorator(outputLabel),
      m_outputPassValue(outputPassValue)
  {
    if(m_useInputLabel)
      m_inputAccessor = ort::inputAccessor_t(inputLabel);
  }

Member Function Documentation

getObjectPriority()

char ORUtils::OverlapDecorationHelper::getObjectPriority

(

const xAOD::IParticle &

obj

)

const

Get the user priority score, which is currently the input decoration.

Definition at line 59 of file OverlapDecorationHelper.cxx.

  {
    // We current reuse the input decoration as the priority score
    return m_inputAccessor(obj);
  }

initializeDecorations()

void ORUtils::OverlapDecorationHelper::initializeDecorations

(

const xAOD::IParticleContainer &

container

)

const

Initialize decorations for a container to "pass".

Note that the value written depends on the output pass-value.

Definition at line 98 of file OverlapDecorationHelper.cxx.

  {
    if(!isDecorated(container))
      resetDecorations(container);
  }

isDecorated()

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.

Definition at line 88 of file OverlapDecorationHelper.cxx.

  {
    return container.size() > 0 &&
           m_outputDecorator.isAvailable(*container[0]);
  }

isInputObject()

bool ORUtils::OverlapDecorationHelper::isInputObject

(

const xAOD::IParticle &

obj

)

const

Check if object is flagged as input for OR.

Definition at line 30 of file OverlapDecorationHelper.cxx.

  {
    // Input label is turned off if empty string
    if(!m_useInputLabel) return true;
    return m_inputAccessor(obj);
  }

isRejectedObject()

bool ORUtils::OverlapDecorationHelper::isRejectedObject

(

const xAOD::IParticle &

obj

)

const

Check if an object has been rejected by decoration.

Definition at line 41 of file OverlapDecorationHelper.cxx.

  {
    // isRejected = isInput && (output == fail)
    return isInputObject(obj) && ( m_outputDecorator(obj) != m_outputPassValue );
  }

isSurvivingObject()

bool ORUtils::OverlapDecorationHelper::isSurvivingObject

(

const xAOD::IParticle &

obj

)

const

Check if object is surviving OR thus far.

Definition at line 50 of file OverlapDecorationHelper.cxx.

  {
    // isSurviving = isInput && (output == pass)
    return isInputObject(obj) && ( m_outputDecorator(obj) == m_outputPassValue );
  }

resetDecorations()

void ORUtils::OverlapDecorationHelper::resetDecorations

(

const xAOD::IParticleContainer &

container

)

const

Helper method for setting all objects as passing.

Definition at line 108 of file OverlapDecorationHelper.cxx.

  {
    for(auto obj : container){
      // This isn't terrible intuitive, but in order to support both output
      // logic modes in a reasonable way, we initialize the output flag to the
      // logical AND of isInput and outputPassValue. This results in non-input
      // objects being initialized to 'false' regardless of output logic.
      bool result = ( isInputObject(*obj) && m_outputPassValue );
      setOverlapDecoration(*obj, result);
    }
    //for(auto obj : container) setObjectPass(*obj);
  }

setObjectFail()

void ORUtils::OverlapDecorationHelper::setObjectFail

(

const xAOD::IParticle &

obj

)

const

Shorthand way to set an object as failing overlap removal.

Definition at line 80 of file OverlapDecorationHelper.cxx.

  {
    setOverlapDecoration(obj, !m_outputPassValue);
  }

setObjectPass()

void ORUtils::OverlapDecorationHelper::setObjectPass

(

const xAOD::IParticle &

obj

)

const

Shorthand way to set an object as passing overlap removal.

Definition at line 75 of file OverlapDecorationHelper.cxx.

  {
    setOverlapDecoration(obj, m_outputPassValue);
  }

setOverlapDecoration()

void ORUtils::OverlapDecorationHelper::setOverlapDecoration	(	const xAOD::IParticle &	obj,
		bool	result
	)		const

Set output decoration on object, pass or fail.

Definition at line 69 of file OverlapDecorationHelper.cxx.

  {
    m_outputDecorator(obj) = result;
  }

Member Data Documentation

m_inputAccessor

ort::inputAccessor_t ORUtils::OverlapDecorationHelper::m_inputAccessor

private

Input label accessor.

Definition at line 81 of file OverlapDecorationHelper.h.

m_outputDecorator

ort::outputDecorator_t ORUtils::OverlapDecorationHelper::m_outputDecorator

private

Output decorator.

Definition at line 83 of file OverlapDecorationHelper.h.

m_outputPassValue

bool ORUtils::OverlapDecorationHelper::m_outputPassValue

private

Output decoration logic.

Definition at line 86 of file OverlapDecorationHelper.h.

m_useInputLabel

bool ORUtils::OverlapDecorationHelper::m_useInputLabel

private

Toggle usage of input label.

Definition at line 78 of file OverlapDecorationHelper.h.

---

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

• OverlapDecorationHelper.h
• OverlapDecorationHelper.cxx