CP::IsoVariableHelper Class Reference

#include <IsoVariableHelper.h>

Inheritance diagram for CP::IsoVariableHelper:

Collaboration diagram for CP::IsoVariableHelper:

Public Member Functions
CorrectionCode	getOriginalIsolation (const xAOD::IParticle *particle, float &value) const
CorrectionCode	getIsolation (const xAOD::IParticle *particle, float &value) const
CorrectionCode	backupIsolation (const xAOD::IParticle *particle) const
CorrectionCode	setIsolation (const xAOD::IParticle *P, float value) const
IsoType	isotype () const
std::string	name () const
	IsoVariableHelper (IsoType type, const std::string &backupPreFix, const std::string &isoDecSuffix="")
void	lockDecorations (const SG::AuxVectorData &parts) const
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Functions providing the same interface as AthMessaging
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

Private Member Functions
CorrectionCode	getIsolationFromOriginal (const xAOD::IParticle *particle, float &value) const
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
IsoType	m_isoType
bool	m_BackupIso
CharDecorator	m_dec_IsoIsBackup
CharAccessor	m_acc_IsoIsBackup
FloatAccessor	m_acc_iso_variable
FloatDecorator	m_dec_iso_variable
FloatAccessor	m_acc_iso_backup
FloatDecorator	m_dec_iso_backup
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

Definition at line 20 of file IsoVariableHelper.h.

Constructor & Destructor Documentation

IsoVariableHelper()

CP::IsoVariableHelper::IsoVariableHelper	(	IsoType	type,
		const std::string &	backupPreFix,
		const std::string &	isoDecSuffix = "" )

Definition at line 14 of file IsoVariableHelper.cxx.

                                                                                                                                :
        asg::AsgMessaging{"IsoVariableHelper_ "+ std::string(xAOD::Iso::toString(type))},
        m_isoType(type),
        m_BackupIso(!backupPreFix.empty()),
        m_dec_IsoIsBackup("IsBackup_" + std::string(xAOD::Iso::toString(type)) + (backupPreFix.empty() ? "" : "_") + backupPreFix),
        m_acc_IsoIsBackup("IsBackup_" + std::string(xAOD::Iso::toString(type)) + (backupPreFix.empty() ? "" : "_") + backupPreFix),
        m_acc_iso_variable(xAOD::Iso::toString(type)),
        m_dec_iso_variable(xAOD::Iso::toString(type) + (isoDecSuffix.empty() ? "" : "_") + isoDecSuffix),
        m_acc_iso_backup(std::string(xAOD::Iso::toString(type)) + (backupPreFix.empty() ? "" : "_") + backupPreFix),
        m_dec_iso_backup(std::string(xAOD::Iso::toString(type)) + (backupPreFix.empty() ? "" : "_") + backupPreFix) {}

Member Function Documentation

backupIsolation()

CorrectionCode CP::IsoVariableHelper::backupIsolation

(

const xAOD::IParticle *

particle

)

const

Definition at line 64 of file IsoVariableHelper.cxx.

                                                                                         {
        if (!particle) {
            ATH_MSG_ERROR(__func__<<"() -- "<<__LINE__<<": no particle given");
            return CorrectionCode::Error;
        }
        if (m_BackupIso && (!m_acc_IsoIsBackup.isAvailable(*particle) || !m_acc_IsoIsBackup(*particle))) {
            float Isovalue = 0;
            if (getIsolation(particle, Isovalue) == CorrectionCode::Error) { 
                return CorrectionCode::Error; 
            }
            m_dec_IsoIsBackup(*particle) = true;
            m_dec_iso_backup(*particle) = Isovalue;
        }
        return CorrectionCode::Ok;
    }

getIsolation()

CorrectionCode CP::IsoVariableHelper::getIsolation	(	const xAOD::IParticle *	particle,
		float &	value ) const

Definition at line 55 of file IsoVariableHelper.cxx.

                                                                                                    {
        if (!particle || !m_acc_iso_variable.isAvailable(*particle)) {
           ATH_MSG_ERROR(__func__<<"() -- "<<__LINE__<<": Failed to retrieve isolation "<<
                         SG::AuxTypeRegistry::instance().getName(m_acc_iso_variable.auxid()));
            return CorrectionCode::Error;
        }
        value = m_acc_iso_variable(*particle);
        return CorrectionCode::Ok;
    }

getIsolationFromOriginal()

CorrectionCode CP::IsoVariableHelper::getIsolationFromOriginal ( const xAOD::IParticle * particle, float & value ) const

private

Definition at line 45 of file IsoVariableHelper.cxx.

                                                                                                                {
        const xAOD::IParticle* originalParticle = xAOD::getOriginalObject(*particle);
        if (originalParticle && getIsolation(originalParticle, value) == CorrectionCode::Error)
            return CorrectionCode::Error;
        else if (!originalParticle) {
            ATH_MSG_DEBUG(__func__<<"() -- "<<__LINE__<<": No orignal object was found");
            return getIsolation(particle, value);
        }
        return CorrectionCode::Ok;
    }

getOriginalIsolation()

CorrectionCode CP::IsoVariableHelper::getOriginalIsolation	(	const xAOD::IParticle *	particle,
		float &	value ) const

Definition at line 25 of file IsoVariableHelper.cxx.

                                                                                                            {
        if (!particle) {
            ATH_MSG_ERROR(__func__<<"() -- "<<__LINE__<<": no particle given");
            return CorrectionCode::Error;
        }
        if (!m_BackupIso) {
            return getIsolationFromOriginal(particle, value);
        } else {
            if (!m_acc_IsoIsBackup.isAvailable(*particle) || !m_acc_IsoIsBackup(*particle)) {
                ATH_MSG_WARNING(__func__<<"() -- "<<__LINE__<<":"
                        <<" No isolation value was backuped thus far. "
                        <<"Did you call the BackupIsolation before for "
                        <<SG::AuxTypeRegistry::instance().getName(m_acc_IsoIsBackup.auxid()));
                return CorrectionCode::Error;
            } else {
                value = m_acc_iso_backup(*particle);
            }
        }
        return CorrectionCode::Ok;
    }

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

isotype()

IsoType CP::IsoVariableHelper::isotype

(

)

const

Definition at line 91 of file IsoVariableHelper.cxx.

{ return m_isoType; }

lockDecorations()

void CP::IsoVariableHelper::lockDecorations

(

const SG::AuxVectorData &

parts

)

const

Definition at line 94 of file IsoVariableHelper.cxx.

    {
      SG::AuxVectorData& parts_nc ATLAS_THREAD_SAFE =
        const_cast<SG::AuxVectorData&> (parts);
      parts_nc.lockDecoration (m_dec_IsoIsBackup.auxid());
      parts_nc.lockDecoration (m_dec_iso_variable.auxid());
      parts_nc.lockDecoration (m_dec_iso_backup.auxid());
    }

msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const

inherited

The standard message stream.

Returns

A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

                                      {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg();
#else // not XAOD_STANDALONE
      return m_msg;
#endif // not XAOD_STANDALONE
   }

msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns

A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

                                                          {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg( lvl );
#else // not XAOD_STANDALONE
      m_msg << lvl;
      return m_msg;
#endif // not XAOD_STANDALONE
   }

msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns

boolean Indicting if messages at given level will be printed

true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

                                                       {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msgLvl( lvl );
#else // not XAOD_STANDALONE
      return m_msg.msgLevel( lvl );
#endif // not XAOD_STANDALONE
   }

name()

std::string CP::IsoVariableHelper::name

(

)

const

Definition at line 92 of file IsoVariableHelper.cxx.

{ return std::string(xAOD::Iso::toCString(isotype())); }

setIsolation()

CorrectionCode CP::IsoVariableHelper::setIsolation	(	const xAOD::IParticle *	P,
		float	value ) const

Definition at line 79 of file IsoVariableHelper.cxx.

                                                                                                   {
        if (!particle) {
             ATH_MSG_ERROR(__func__<<"() -- "<<__LINE__<<": no particle given");
            return CorrectionCode::Error;
        }
        if (std::isnan(value) || std::isinf(value)) {
            ATH_MSG_ERROR(__func__<<"() -- "<<__LINE__<<": the value is not a number");
            return CorrectionCode::Error;
        }
        m_dec_iso_variable(*particle) = value;
        return CorrectionCode::Ok;
    }

setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_acc_iso_backup

FloatAccessor CP::IsoVariableHelper::m_acc_iso_backup

private

Definition at line 44 of file IsoVariableHelper.h.

m_acc_iso_variable

FloatAccessor CP::IsoVariableHelper::m_acc_iso_variable

private

Definition at line 41 of file IsoVariableHelper.h.

m_acc_IsoIsBackup

CharAccessor CP::IsoVariableHelper::m_acc_IsoIsBackup

private

Definition at line 39 of file IsoVariableHelper.h.

m_BackupIso

bool CP::IsoVariableHelper::m_BackupIso

private

Definition at line 37 of file IsoVariableHelper.h.

m_dec_iso_backup

FloatDecorator CP::IsoVariableHelper::m_dec_iso_backup

private

Definition at line 45 of file IsoVariableHelper.h.

m_dec_iso_variable

FloatDecorator CP::IsoVariableHelper::m_dec_iso_variable

private

Definition at line 42 of file IsoVariableHelper.h.

m_dec_IsoIsBackup

CharDecorator CP::IsoVariableHelper::m_dec_IsoIsBackup

private

Definition at line 38 of file IsoVariableHelper.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_isoType

IsoType CP::IsoVariableHelper::m_isoType

private

Definition at line 36 of file IsoVariableHelper.h.

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

---

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

• IsoVariableHelper.h
• IsoVariableHelper.cxx