PFSubtractionStatusSetter Class Reference

This class contains a few functions to set the amount of energy removed from a xAOD::CaloCluster by a xAOD::Track in eflowRec. More...

#include <PFSubtractionStatusSetter.h>

Inheritance diagram for PFSubtractionStatusSetter:

Collaboration diagram for PFSubtractionStatusSetter:

Public Member Functions
	PFSubtractionStatusSetter ()
void	markSubtractionStatus (const std::vector< std::pair< xAOD::CaloCluster *, bool > > &clusterList, std::vector< std::pair< float, float > > &clusterSubtractedEnergyRatios, eflowCaloObject &thisEflowCaloObject, unsigned int trackIndex) const
	Set the ratio of new to old cluster energy for each cluster matched to a track with trackIndex.
void	markAllTracksAnnihStatus (eflowCaloObject &thisEflowCaloObject) const
	Set the ratio of new to old cluster energy, to zero, for all cluster matched to all tracks attached to the eflowCaloObject.
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::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

This class contains a few functions to set the amount of energy removed from a xAOD::CaloCluster by a xAOD::Track in eflowRec.

It can either set this for a specific track attached to an eflowCaloObject or set it for all tracks in an eflowCaloObject

Definition at line 19 of file PFSubtractionStatusSetter.h.

Constructor & Destructor Documentation

PFSubtractionStatusSetter()

PFSubtractionStatusSetter::PFSubtractionStatusSetter

(

)

Definition at line 14 of file PFSubtractionStatusSetter.cxx.

: AsgMessaging("PFSubtractionStatusSetter"){}

Member Function Documentation

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

markAllTracksAnnihStatus()

void PFSubtractionStatusSetter::markAllTracksAnnihStatus

(

eflowCaloObject &

thisEflowCaloObject

)

const

Set the ratio of new to old cluster energy, to zero, for all cluster matched to all tracks attached to the eflowCaloObject.

Definition at line 71 of file PFSubtractionStatusSetter.cxx.

{
 
  ATH_MSG_DEBUG("Executing markAllTracksAnnihStatus");
 
  const std::vector<std::pair<eflowTrackClusterLink*, std::pair<float,float> > >& matchedTrackList = thisEflowCaloObject.efRecLink();
  
  auto accumulateTrackEnergy = [](float sum, std::pair<eflowTrackClusterLink*, std::pair<float,float> > thisPair){ return sum + thisPair.first->getTrack()->getTrack()->e();};
  float totalTrackE = std::accumulate(matchedTrackList.begin(),matchedTrackList.end(),0.0,accumulateTrackEnergy);
 
  unsigned int counter = 0;
  for (const auto & thisTrackClusterLinkPair : matchedTrackList){
    ATH_MSG_DEBUG("Track with e and eta " << thisTrackClusterLinkPair.first->getTrack()->getTrack()->e() << " and " << thisTrackClusterLinkPair.first->getTrack()->getTrack()->eta());
    ATH_MSG_DEBUG("will annihilate cluster with e and eta " << thisTrackClusterLinkPair.first->getCluster()->getCluster()->e() << " and " << thisTrackClusterLinkPair.first->getCluster()->getCluster()->eta());
    float trackEFraction = thisTrackClusterLinkPair.first->getTrack()->getTrack()->e()/totalTrackE;
    //We set the subtracted energy to the cluster energy multiplied by the fraction of total matched track energy belonging to this track
    //whilst the ratio of new to old enegry is set to 0.0
    thisEflowCaloObject.setTrackClusterLinkSubtractionStatus(counter, std::pair(0.0,trackEFraction*thisTrackClusterLinkPair.first->getCluster()->getCluster()->e()));  
    counter++;
  }
}

markSubtractionStatus()

void PFSubtractionStatusSetter::markSubtractionStatus	(	const std::vector< std::pair< xAOD::CaloCluster *, bool > > &	clusterList,
		std::vector< std::pair< float, float > > &	clusterSubtractedEnergyRatios,
		eflowCaloObject &	thisEflowCaloObject,
		unsigned int	trackIndex ) const

Set the ratio of new to old cluster energy for each cluster matched to a track with trackIndex.

Definition at line 17 of file PFSubtractionStatusSetter.cxx.

{
  // An eflowCaloObject may have one cluster and N tracks, and then one would
  // have N eflowTrackClusterLink* for each track-cluster pair Hence there can
  // be more entries in the track cluster link list due to duplication
 
  ATH_MSG_DEBUG("Executing markSubtractionStatus and have clusterList of size " << clusterList.size() << ", clusterSubtractedEnergyRatios of size " << clusterSubtractedEnergyRatios.size() << " and trackIndex of " << trackIndex);  
 
  const std::vector<std::pair<eflowTrackClusterLink*, std::pair<float,float> > >& matchedTrackList = thisEflowCaloObject.efRecLink();
 
  unsigned int clusCounter = 0;
  for (auto thisClusterPair : clusterList){
    xAOD::CaloCluster* thisCluster = thisClusterPair.first;
    ATH_MSG_DEBUG("Cluster with e and eta " << thisCluster->e() << " and " << thisCluster->eta());
    unsigned int counter = 0;
    for (const auto & thisTrackClusterLinkPair : matchedTrackList){
 
      if (trackIndex != thisTrackClusterLinkPair.first->getTrack()->getTrack()->index()){
        counter++;
        continue;
      }
 
      ATH_MSG_DEBUG("Track with e and eta " << thisTrackClusterLinkPair.first->getTrack()->getTrack()->e() << " and " << thisTrackClusterLinkPair.first->getTrack()->getTrack()->eta());
 
      //if the subtraction status is already true, then no need to update it
      if (!std::isnan(thisTrackClusterLinkPair.second.first)) {
          counter++;
          continue;
      }
 
      ATH_MSG_DEBUG("Not already subtracted");
 
      //eflowTrackCluster link returns an eflowRecCluster pointer, which in turn returns an xAOD:;CaloCluster* pointer
      xAOD::CaloCluster* thisMatchedTrackCluster = (thisTrackClusterLinkPair.first)->getCluster()->getCluster();
      //Now we can do a pointer comparison of the two clusters to see if we have a match
      ATH_MSG_DEBUG("Comparing clusters with energies " << thisCluster->e() << " and " << thisMatchedTrackCluster->e());
      if (thisCluster == thisMatchedTrackCluster){      
        ATH_MSG_DEBUG("Passed cluster energy check");
          if (thisClusterPair.second && !std::isnan(clusterSubtractedEnergyRatios[clusCounter].first)) {
          ATH_MSG_DEBUG("Will set ratio to be " << clusterSubtractedEnergyRatios[clusCounter].first);
          thisEflowCaloObject.setTrackClusterLinkSubtractionStatus(counter, clusterSubtractedEnergyRatios[clusCounter]);        
        }
      }//if have a match of the cluster
      counter++;
    }//loop on track cluster link pairs
    clusCounter++;
  }//loop on cluster pair list
}

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.

{ nullptr };

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:

• PFSubtractionStatusSetter.h
• PFSubtractionStatusSetter.cxx