Tool to calculate input variables for the RNN-based tau identification. More...

#include <TauJetRNNUtils.h>

Inheritance diagram for TauJetRNNUtils::VarCalc:

Collaboration diagram for TauJetRNNUtils::VarCalc:

Public Types
using	ScalarCalc = bool (*)(const xAOD::TauJet &, double &)
using	TrackCalc
using	ClusterCalc

Public Member Functions
	VarCalc ()
	~VarCalc ()=default
bool	compute (const std::string &name, const xAOD::TauJet &tau, double &out) const
bool	compute (const std::string &name, const xAOD::TauJet &tau, const std::vector< const xAOD::TauTrack * > &tracks, std::vector< double > &out) const
bool	compute (const std::string &name, const xAOD::TauJet &tau, const std::vector< xAOD::CaloVertexedTopoCluster > &clusters, std::vector< double > &out) const
void	insert (const std::string &name, ScalarCalc func, const std::vector< std::string > &scalar_vars)
void	insert (const std::string &name, TrackCalc func, const std::vector< std::string > &track_vars)
void	insert (const std::string &name, ClusterCalc func, const std::vector< std::string > &cluster_vars)
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
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
std::unordered_map< std::string, ScalarCalc >	m_scalar_map
std::unordered_map< std::string, TrackCalc >	m_track_map
std::unordered_map< std::string, ClusterCalc >	m_cluster_map
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

Tool to calculate input variables for the RNN-based tau identification.

Used to calculate input variables of the RNN-based tau identification on the fly by providing a mapping between variable names (strings) and functions to calculate these variables.

Author: C. Deutsch; W. Davey

Definition at line 29 of file TauJetRNNUtils.h.

Member Typedef Documentation

◆ ClusterCalc

using TauJetRNNUtils::VarCalc::ClusterCalc

Initial value:

bool (*)(const xAOD::TauJet &,

const xAOD::CaloVertexedTopoCluster &, double &)

xAOD::CaloVertexedTopoCluster

Evaluate cluster kinematics with a different vertex / signal state.

Definition Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloVertexedTopoCluster.h:38

xAOD::TauJet

TauJet_v3 TauJet

Definition of the current "tau version".

Definition Event/xAOD/xAODTau/xAODTau/TauJet.h:17

Definition at line 37 of file TauJetRNNUtils.h.

◆ ScalarCalc

using TauJetRNNUtils::VarCalc::ScalarCalc = bool (*)(const xAOD::TauJet &, double &)

Definition at line 32 of file TauJetRNNUtils.h.

◆ TrackCalc

using TauJetRNNUtils::VarCalc::TrackCalc

Initial value:

bool (*)(const xAOD::TauJet &, const xAOD::TauTrack &,

double &)

xAOD::TauTrack

TauTrack_v1 TauTrack

Definition of the current version.

Definition TauTrack.h:16

Definition at line 34 of file TauJetRNNUtils.h.

Constructor & Destructor Documentation

◆ VarCalc()

TauJetRNNUtils::VarCalc::VarCalc ( )

Definition at line 11 of file TauJetRNNUtils.cxx.

11 : asg::AsgMessaging("TauJetRNNUtils::VarCalc") {

12}

◆ ~VarCalc()

TauJetRNNUtils::VarCalc::~VarCalc ( )

default

Member Function Documentation

◆ compute() [1/3]

bool TauJetRNNUtils::VarCalc::compute	(	const std::string &	name,
		const xAOD::TauJet &	tau,
		const std::vector< const xAOD::TauTrack * > &	tracks,
		std::vector< double > &	out ) const

Definition at line 29 of file TauJetRNNUtils.cxx.

                                                    {
    out.clear();
 
    // Retrieve calculator function
    TrackCalc func = nullptr;
    try {
        func = m_track_map.at(name);
    } catch (const std::out_of_range &e) {
        ATH_MSG_ERROR("Variable '" << name << "' not defined");
        throw;
    }
 
    // Calculate variables for selected tracks
    bool success = true;
    double value;
    for (const auto *const trk : tracks) {
        success = success && func(tau, *trk, value);
        out.push_back(value);
    }
 
    return success;
}

◆ compute() [2/3]

bool TauJetRNNUtils::VarCalc::compute	(	const std::string &	name,
		const xAOD::TauJet &	tau,
		const std::vector< xAOD::CaloVertexedTopoCluster > &	clusters,
		std::vector< double > &	out ) const

Definition at line 54 of file TauJetRNNUtils.cxx.

                                                    {
    out.clear();
 
    // Retrieve calculator function
    ClusterCalc func = nullptr;
    try {
        func = m_cluster_map.at(name);
    } catch (const std::out_of_range &e) {
        ATH_MSG_ERROR("Variable '" << name << "' not defined");
        throw;
    }
 
    // Calculate variables for selected clusters
    bool success = true;
    double value;
    for (const xAOD::CaloVertexedTopoCluster& cluster : clusters) {
        success = success && func(tau, cluster, value);
        out.push_back(value);
    }
 
    return success;
}

◆ compute() [3/3]

bool TauJetRNNUtils::VarCalc::compute	(	const std::string &	name,
		const xAOD::TauJet &	tau,
		double &	out ) const

Definition at line 14 of file TauJetRNNUtils.cxx.

                                         {
    // Retrieve calculator function
    ScalarCalc func = nullptr;
    try {
        func = m_scalar_map.at(name);
    } catch (const std::out_of_range &e) {
        ATH_MSG_ERROR("Variable '" << name << "' not defined");
        throw;
    }
 
    // Calculate variable
    return func(tau, out);
}

◆ 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;
  }
}

◆ insert() [1/3]

void TauJetRNNUtils::VarCalc::insert	(	const std::string &	name,
		ClusterCalc	func,
		const std::vector< std::string > &	cluster_vars )

Definition at line 99 of file TauJetRNNUtils.cxx.

                                                                                                      {
    if (std::find(cluster_vars.begin(), cluster_vars.end(), name) == cluster_vars.end()) {
      return;
    }
    if (!func) {
        throw std::invalid_argument("Nullptr passed to VarCalc::insert");
    }
    m_cluster_map[name] = func;
}

◆ insert() [2/3]

void TauJetRNNUtils::VarCalc::insert	(	const std::string &	name,
		ScalarCalc	func,
		const std::vector< std::string > &	scalar_vars )

Definition at line 79 of file TauJetRNNUtils.cxx.

                                                                                                    {
    if (std::find(scalar_vars.begin(), scalar_vars.end(), name) == scalar_vars.end()) {
      return;
    }
    if (!func) {
        throw std::invalid_argument("Nullptr passed to VarCalc::insert");
    }
    m_scalar_map[name] = func;
}

◆ insert() [3/3]

void TauJetRNNUtils::VarCalc::insert	(	const std::string &	name,
		TrackCalc	func,
		const std::vector< std::string > &	track_vars )

Definition at line 89 of file TauJetRNNUtils.cxx.

                                                                                                  {
    if (std::find(track_vars.begin(), track_vars.end(), name) == track_vars.end()) {
      return;
    }
    if (!func) {
        throw std::invalid_argument("Nullptr passed to VarCalc::insert");
    }
    m_track_map[name] = func;
}

◆ 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
   }

◆ 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_cluster_map

std::unordered_map<std::string, ClusterCalc> TauJetRNNUtils::VarCalc::m_cluster_map

private

Definition at line 68 of file TauJetRNNUtils.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ 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.

◆ m_scalar_map

std::unordered_map<std::string, ScalarCalc> TauJetRNNUtils::VarCalc::m_scalar_map

private

Definition at line 66 of file TauJetRNNUtils.h.

◆ m_track_map

std::unordered_map<std::string, TrackCalc> TauJetRNNUtils::VarCalc::m_track_map

private

Definition at line 67 of file TauJetRNNUtils.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterCalc

◆ ScalarCalc

◆ TrackCalc

Constructor & Destructor Documentation

◆ VarCalc()

◆ ~VarCalc()

Member Function Documentation

◆ compute() [1/3]

◆ compute() [2/3]

◆ compute() [3/3]

◆ initMessaging()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ setLevel()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_cluster_map

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_scalar_map

◆ m_track_map