PFSubtractionEnergyRatioCalculator Class Reference

Class to calculate the ratio of new to old energies of CaloClusters after the particle flow charged shower subtraction has been run. More...

#include <PFSubtractionEnergyRatioCalculator.h>

Inheritance diagram for PFSubtractionEnergyRatioCalculator:

Collaboration diagram for PFSubtractionEnergyRatioCalculator:

Public Member Functions
	PFSubtractionEnergyRatioCalculator ()
void	calculateSubtractedEnergyRatios (const std::vector< std::pair< xAOD::CaloCluster *, bool >> &clusterSubtractionList, std::map< xAOD::CaloCluster *, double > &clusterEnergyMap, std::vector< std::pair< float, float >> &clusterSubtractedEnergyRatios) const
	For each xAOD::CaloCluster in clusterSubtractionList we calculate the ratio of new to old energy after the charged shower subtraction, which is added in clusterSubtractedEnergyRatios. More...
void	calculateSubtractedEnergyRatiosForAnnih (const std::vector< std::pair< xAOD::CaloCluster *, bool >> &clusterSubtractionList, std::map< xAOD::CaloCluster *, double > &clusterEnergyMap, std::vector< std::pair< float, float >> &clusterSubtractedEnergyRatios) const
	If we have decided to annihiliate all clusters in clusterSubtractionList we use this function to set all ratios to zero in clusterEnergySubtractionRatios. More...
void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
std::string	m_nm
	Message source name. More...
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Class to calculate the ratio of new to old energies of CaloClusters after the particle flow charged shower subtraction has been run.

Definition at line 19 of file PFSubtractionEnergyRatioCalculator.h.

Constructor & Destructor Documentation

PFSubtractionEnergyRatioCalculator()

PFSubtractionEnergyRatioCalculator::PFSubtractionEnergyRatioCalculator

(

)

Definition at line 8 of file PFSubtractionEnergyRatioCalculator.cxx.

  : AsgMessaging("PFSubtractionEnergyRatioCalculator")
{}

Member Function Documentation

calculateSubtractedEnergyRatios()

void PFSubtractionEnergyRatioCalculator::calculateSubtractedEnergyRatios	(	const std::vector< std::pair< xAOD::CaloCluster *, bool >> &	clusterSubtractionList,
		std::map< xAOD::CaloCluster *, double > &	clusterEnergyMap,
		std::vector< std::pair< float, float >> &	clusterSubtractedEnergyRatios
	)		const

For each xAOD::CaloCluster in clusterSubtractionList we calculate the ratio of new to old energy after the charged shower subtraction, which is added in clusterSubtractedEnergyRatios.

clusterEnergyMap contains the cluster energy prior to the charged shower energy subtraction

Definition at line 13 of file PFSubtractionEnergyRatioCalculator.cxx.

{
 
  ATH_MSG_DEBUG("Setting subtracted energy ratios here");
  
  for (auto thisCluster: clusterSubtractionList) {
    ATH_MSG_DEBUG("Cluster energies are " << thisCluster.first->e() << " and " << clusterEnergyMap[thisCluster.first]);
 
    //clusterEnergyMap[thisCluster.first can be zero, but this is only a problem if thisCluster.first.e() < 0 - this can happen if a cluster starts with E =0 
    //from a previous shower subtraction step and then we subtract more such that the new E is < 0. Then the ratio would cause an FPE due to the zero.
    //If both thisCluster.first->e() and clusterEnergyMap[thisCluster.first] are zero we never enter this step.          
 
    if (std::abs(thisCluster.first->e() - clusterEnergyMap[thisCluster.first]) > 0.0001) {
       if ( clusterEnergyMap[thisCluster.first] > 0) {
        ATH_MSG_DEBUG("Subtracted energy ratio is " << thisCluster.first->e()/clusterEnergyMap[thisCluster.first]);
        clusterSubtractedEnergyRatios.emplace_back(std::pair(thisCluster.first->e()/clusterEnergyMap[thisCluster.first],clusterEnergyMap[thisCluster.first]-thisCluster.first->e()));
       }
       //approximate zero with 0.0001 to avoid FPE and still give a meaningful ratio (e.g -100/0.0001)
       else {
         ATH_MSG_DEBUG("Subtracted energy ratio is " << thisCluster.first->e()/0.0001);
         clusterSubtractedEnergyRatios.emplace_back(std::pair(thisCluster.first->e()/0.0001,clusterEnergyMap[thisCluster.first]-thisCluster.first->e()));
       }
    }
    //else if the cluster enegry did not change then we use NAN to denote that no charged shower subtraction occurred.
    else {
      clusterSubtractedEnergyRatios.emplace_back(NAN,NAN);
      ATH_MSG_DEBUG("Subtracted energy ratio is NAN ");
    }
  }//Loop over clusterSubtractionList
}

calculateSubtractedEnergyRatiosForAnnih()

void PFSubtractionEnergyRatioCalculator::calculateSubtractedEnergyRatiosForAnnih	(	const std::vector< std::pair< xAOD::CaloCluster *, bool >> &	clusterSubtractionList,
		std::map< xAOD::CaloCluster *, double > &	clusterEnergyMap,
		std::vector< std::pair< float, float >> &	clusterSubtractedEnergyRatios
	)		const

If we have decided to annihiliate all clusters in clusterSubtractionList we use this function to set all ratios to zero in clusterEnergySubtractionRatios.

If the old energy, in clusterEnergyMap, was zero we instead set the ratio to NAN to denote that no energy was removed from that xAOD::CaloCluster

Definition at line 49 of file PFSubtractionEnergyRatioCalculator.cxx.

{
 
  ATH_MSG_DEBUG("Setting subtracted energy ratios for annih here");
 
  for (auto thisCluster: clusterSubtractionList) {
    ATH_MSG_DEBUG("Cluster energies are " << thisCluster.first->e() << " and " << clusterEnergyMap[thisCluster.first]);
 
    //The energy can be zero if we previously "annihiliated" this cluster because we will have already set the energy to zero.
    //We don't want to set the energy ratio to zero if we just change the energy from "0" to "0" - in effect in this case
    //we don't subtract anything and we will set the value of the ratio to NAN which denotes that no subtraction was performed.
    //So we build a list of indices of clusters which don't need to have the energy set to zero - we compare a floating point
    //directly to zero, because in a previous annihilation we explicity set the energy to be exactly zero.
    if (0 != clusterEnergyMap[thisCluster.first]) {
      ATH_MSG_DEBUG("Setting cluster energy ratio to zero");
      //We are removing the full energy, so set the subtracted energy to the cluster energy.
      clusterSubtractedEnergyRatios.emplace_back(std::pair(0,clusterEnergyMap[thisCluster.first]));
    }
    else {
      ATH_MSG_DEBUG("Setting cluster energy ratio to NAN");
      clusterSubtractedEnergyRatios.emplace_back(NAN,NAN);
    }
 
  }
}

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();
  m_lvl = m_imsg ?
    static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
    MSG::INFO;
}

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_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

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:

• PFSubtractionEnergyRatioCalculator.h
• PFSubtractionEnergyRatioCalculator.cxx