TrigMuonEFTrackIsolationTool Class Reference

EF Track Isolation tool. More...

#include <TrigMuonEFTrackIsolationTool.h>

Inheritance diagram for TrigMuonEFTrackIsolationTool:

Collaboration diagram for TrigMuonEFTrackIsolationTool:

Public Member Functions
	TrigMuonEFTrackIsolationTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor.
virtual StatusCode	initialize () override
	initialize the tool
virtual StatusCode	calcTrackIsolation (const xAOD::Muon *efmuon, const xAOD::TrackParticleContainer *idtrks, const std::vector< double > &conesizes, std::vector< double > &results, std::vector< double > *dzvals, std::vector< double > *drvals, std::vector< double > *selfremoval) const override
	Sum the track pT in cones around the muon.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	checkIsolation (const xAOD::IParticle *muon, double selfpt, const xAOD::TrackParticle *muon_idtrk, const Trk::Perigee *muidtrk_perigee, const xAOD::TrackParticleContainer *trks, std::vector< double > conesizes, std::vector< double > &results, std::vector< double > *dzvals, std::vector< double > *drvals, std::vector< double > *selfremoval) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
bool	m_debug
double	m_deltaz_cut
	cut between z of muon id trk and z of id trks - < 0 means no cut
bool	m_removeSelf
	flag to determine whether to remove pT of muon track from the calculation
bool	m_useAnnulus
	flag to determine if we should use an inner annulus
double	m_annulusSize
	size of the annulus within which we ignore tracks
bool	m_useVarIso
	flag to determine if we want to use offline isolation variables
ToolHandle< InDet::IInDetTrackSelectionTool >	m_trkSelTool
	Track selection tool.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

EF Track Isolation tool.

Calculates track isolation around EF muon in varying cone sizes. Has possibility to cut on dz(muon id trk, id trk) to suppress pileup.

Definition at line 22 of file TrigMuonEFTrackIsolationTool.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TrigMuonEFTrackIsolationTool()

TrigMuonEFTrackIsolationTool::TrigMuonEFTrackIsolationTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructor.

Standard constructor.

Definition at line 16 of file TrigMuonEFTrackIsolationTool.cxx.

                                                                                                                                 : 
  AthAlgTool( type, name, parent ),
  m_debug(false),
  m_deltaz_cut(0.0),
  m_removeSelf(true),
  m_useAnnulus(false),
  m_annulusSize(-1.0),
  m_useVarIso(false),
  m_trkSelTool( "InDet::InDetTrackSelectionTool/TrackSelectionTool", this )
{  
  
  declareInterface<IMuonEFTrackIsolationTool>(this);
 
  declareProperty("deltaZCut", m_deltaz_cut);
  declareProperty("removeSelf", m_removeSelf);
  declareProperty("useAnnulus", m_useAnnulus);
  declareProperty("annulusSize", m_annulusSize);
  declareProperty("useVarIso", m_useVarIso);
  declareProperty("TrackSelectionTool",m_trkSelTool);
}

Member Function Documentation

calcTrackIsolation()

StatusCode TrigMuonEFTrackIsolationTool::calcTrackIsolation ( const xAOD::Muon * efmuon, const xAOD::TrackParticleContainer * idtrks, const std::vector< double > & conesizes, std::vector< double > & results, std::vector< double > * dzvals, std::vector< double > * drvals, std::vector< double > * selfremoval ) const

overridevirtual

Sum the track pT in cones around the muon.

Parameters

efmuon	- EF muon
idtrks	- Container of id trks
conesizes	- Vector of conesizes (in dR)
results	- Vector where the results for each cone will be stored
dzvals	- Vector where dz vals of good tracks will be stored
drvals	- Vector where dr vals of good tracks will be stored
selfremoval	- Vector storing the selfpt and removed pt

Implements IMuonEFTrackIsolationTool.

Definition at line 49 of file TrigMuonEFTrackIsolationTool.cxx.

                                                                                                                                                                                                                                                                         {
 
 
  if (m_debug)
    msg() << MSG::DEBUG << "Running isolation over EF Muon!" << endmsg;
  
  // clear vectors
  results.clear();
  dzvals->clear();
  drvals->clear();
  selfremoval->clear();
 
  // this will point to the muon (combined or extrapolated)
  const xAOD::TrackParticle* muon=0;
 
 // variable to store pt of the muon (this is different for different muon types so we pass it separately) 
  double selfpt=0.0;
 
  //for combined muons use the associated ID track for the self removal
  const xAOD::TrackParticle* muon_idtrk = 0;
  const Trk::Perigee* muidtrk_perigee = 0;
  if( (muon =efmuon->trackParticle(xAOD::Muon::TrackParticleType::CombinedTrackParticle)) != nullptr ) {
    if(m_debug) {
      msg() << MSG::DEBUG << "EF muon has combined muon" << endmsg;
    }
    if( efmuon->trackParticle(xAOD::Muon::TrackParticleType::InnerDetectorTrackParticle) ) {
      muon_idtrk = efmuon->trackParticle(xAOD::Muon::TrackParticleType::InnerDetectorTrackParticle);
      muidtrk_perigee = &(muon_idtrk->perigeeParameters());
      selfpt = muon_idtrk->pt();
      if(m_debug) {
    msg() << MSG::DEBUG << "Found ID track attached to combined muon, " << muon_idtrk << ",pt = " << selfpt << endmsg;
      }
    }
    else {
      msg() << MSG::WARNING << "Found EF combined muon without a link to ID track, will use combined pt for self removal" << endmsg;
      selfpt = muon->pt();
    }
  }//combinedmuon
  else {
    // for extrapolated muons use the extrapolated muon for self removal
    if( !efmuon->trackParticle(xAOD::Muon::TrackParticleType::MuonSpectrometerTrackParticle) ) {
      if(m_removeSelf) {
    msg() << MSG::WARNING << "This EF muon has neither a combined or extrapolated muon and removeSelf is requested, do not process further" << endmsg;
    return StatusCode::FAILURE;
      }//m_removeSelf
      msg() << MSG::WARNING << "This EF muon has neither a combined, extrapolated or MS muon, do not process further" << endmsg;
      return StatusCode::FAILURE; 
    }
    else {
      muon = efmuon->trackParticle(xAOD::Muon::TrackParticleType::MuonSpectrometerTrackParticle);
      selfpt = muon->pt();
    }//extrapmuon
  }//not combined
 
 StatusCode isoResult = checkIsolation(muon, selfpt, muon_idtrk, muidtrk_perigee, idtrks, conesizes, results, dzvals, drvals, selfremoval);
 
  return isoResult;
}

checkIsolation()

StatusCode TrigMuonEFTrackIsolationTool::checkIsolation ( const xAOD::IParticle * muon, double selfpt, const xAOD::TrackParticle * muon_idtrk, const Trk::Perigee * muidtrk_perigee, const xAOD::TrackParticleContainer * trks, std::vector< double > conesizes, std::vector< double > & results, std::vector< double > * dzvals, std::vector< double > * drvals, std::vector< double > * selfremoval ) const

private

consistency checks

Definition at line 110 of file TrigMuonEFTrackIsolationTool.cxx.

                                                                                                                                                                                                                                                                                                                                                      {
  
  if(m_removeSelf && selfpt==0.0) {
    msg() << MSG::WARNING << "Inconsistency, removeSelf requested, but selfpt = 0" << endmsg;
  }
  if(!muon) {
    msg() << MSG::WARNING << "Could not find a muon to update with the isolation, skipping this muon" << endmsg;
    return StatusCode::FAILURE;
  }
 
  // fill results vector with 0
  results.insert(results.end(), conesizes.size(), 0.0);
  
  // loop over other tracks in the container
  // these are arrays, so that if using leadTrk or dRMatched selfremoval it can be different between the two cone sizes
  int ntrks_tmp[2];
  ntrks_tmp[0]=0; ntrks_tmp[1]=0;
  
    
  for(xAOD::TrackParticleContainer::const_iterator trkit=trks->begin();
      trkit!=trks->end(); ++trkit) {
 
    if (m_debug)
 
      msg() << MSG::DEBUG << "INFO: Track pT = " << (*trkit)->pt() << " eta = " << (*trkit)->eta() << endmsg;
 
    // check track passes the selection tool
    const auto& trkSelResult = m_trkSelTool->accept(*trkit);
    if(trkSelResult) {
      ATH_MSG_DEBUG("Track passes selection tool");
    } else {
      if(m_debug) {
    ATH_MSG_DEBUG("Track failed selection tool");
    for(unsigned int i=0; i<trkSelResult.getNCuts (); ++i) {
      ATH_MSG_DEBUG("   Cut " << i << trkSelResult.getCutName(i).data() << " pass = " << trkSelResult.getCutResult(i));
    }
      }
      continue; // skip this track
    }
    
    // check dZ if necessary   
    double dz=0;
    if(m_deltaz_cut > 0.0 && muidtrk_perigee) {
      const Trk::Perigee& idtrk_perigee = (*trkit)->perigeeParameters();
      dz = idtrk_perigee.parameters()[Trk::z0] - muidtrk_perigee->parameters()[Trk::z0];
      if( fabs(dz) > m_deltaz_cut ) {
    if(m_debug) {
      msg() << MSG::DEBUG << "Track failed dz cut, ignoring it. dz = " << dz << endmsg;
    }
    continue;
      }//failed delta(z)
      // store dz (after cut)
      // if(dzvals) dzvals->push_back(dz); // moved to after the pT cut for plotting purposes
      if(m_debug) {
    msg() << MSG::DEBUG << "ID track passes dz cut. dz = " << dz << endmsg;
      }
      
    }//deltaz_cut
    if(dzvals) dzvals->push_back(dz);
  
    // check if trk within cone
    double dr = 0;
    if(muon_idtrk) { //use ID track for dR if available
      dr = (*trkit)->p4().DeltaR( muon_idtrk->p4() );
    } else { //use the muon
      dr = (*trkit)->p4().DeltaR( muon->p4() );
    }
    
    if(drvals) drvals->push_back(dr);
    
    // if needed check the inner annululs
    if(m_useAnnulus) {
      if( dr < m_annulusSize ) {
    if(m_debug) {
      msg() << MSG::DEBUG << "ID track within annulus, ignoring it, dR = " << dr << ", annulus = " << m_annulusSize << endmsg;
     
    }
    continue; // skip tracks in the annulus
      }//annulus cut
      if(m_debug) {
    msg() << MSG::DEBUG << "ID track outside annulus, keep it, dR = " << dr << ", annulus = " << m_annulusSize << endmsg;
      }
    }//use Annulus
 
    // Define new conesizes that depend on useVarIso flag
    double ptvarcone20 = std::min(0.2,10000/selfpt); 
    double ptvarcone30 = std::min(0.3,10000/selfpt); 
    if (m_useVarIso){
      conesizes.clear();
      conesizes.push_back(ptvarcone20);
      conesizes.push_back(ptvarcone30);
    }
 
    // add trk pT to relevant results vector
    for(unsigned int conepos=0; conepos<conesizes.size(); ++conepos) {
      if(dr < conesizes.at(conepos) ) {
    if(m_debug) {
      msg() << MSG::DEBUG << "Adding trk pt = " << (*trkit)->pt() << ", with dr = " << dr << ", into cone = " << conesizes.at(conepos) << endmsg; 
    }
    results.at(conepos) += (*trkit)->pt();
    ++ntrks_tmp[conepos];
 
      }
    }
    
  }// track loop
 
  // Muon pT plots
  selfremoval->push_back(selfpt);
  selfremoval->push_back(muon->pt());
 
  if(m_debug) {
    for(unsigned int conepos=0; conepos<conesizes.size(); ++conepos) {
      msg() << MSG::DEBUG << "Scalar pT sum of tracks around this muon cone " << conesizes.at(conepos) << " = " << results.at(conepos) << endmsg;
    }
  }
  if(m_removeSelf && !m_useAnnulus) { // remove muon pt from the sums
    for(unsigned int conepos=0; conepos<conesizes.size(); ++conepos) {
      results.at(conepos) -= selfpt;
    }
    if(m_debug) {
      for(unsigned int conepos=0; conepos<conesizes.size(); ++conepos) {
    msg() << MSG::DEBUG << "Scalar pT sum of tracks around this muon cone " << conesizes.at(conepos) << " after self removal = " << results.at(conepos) << endmsg;
      }
    }
    
  }//m_removeSelf    
  
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

initialize()

StatusCode TrigMuonEFTrackIsolationTool::initialize ( )

overridevirtual

initialize the tool

Definition at line 243 of file TrigMuonEFTrackIsolationTool.cxx.

                                                    {
 
  m_debug = msgLvl(MSG::DEBUG);
 
  if(m_trkSelTool.retrieve().isFailure()){
    ATH_MSG_FATAL("Could not retrieve InDetTrackSelectionTool");    
    return StatusCode::FAILURE;
  }
 
  if(m_debug) {
    msg() << MSG::DEBUG << "Initializing TrigMuonEFTrackIsolationTool[" << name() << "]" << endmsg;
    msg() << MSG::DEBUG
      << "Properties set as follows: " << endmsg;
    msg() << MSG::DEBUG
      << "removeSelf                     " << m_removeSelf << endmsg;
    msg() << MSG::DEBUG
      << "deltaZCut                      " << m_deltaz_cut << endmsg;
    msg() << MSG::DEBUG
      << "useAnnulus                     " << m_useAnnulus << endmsg;
    msg() << MSG::DEBUG
      << "annulusSize                    " << m_annulusSize << endmsg;
    msg() << MSG::DEBUG
      << "useVarIso                      " << m_useVarIso << endmsg;
    msg() << MSG::DEBUG
          << "TrackSelectionTool             " << m_trkSelTool << endmsg;
 
  }//debug
 
  // check the annulus size is valid
  if(m_useAnnulus) {
    if(m_annulusSize < 0.0 || m_annulusSize > 0.2) {
      msg() << MSG::ERROR << "Bad configuration of annulusSize = " << m_annulusSize << ", fix your config!" << endmsg;
      return StatusCode::FAILURE;
    }
  }//useAnnulus
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & IMuonEFTrackIsolationTool::interfaceID ( )

inlinestaticinherited

Retrieve interface ID.

Definition at line 37 of file IMuonEFTrackIsolationTool.h.

{ return IID_IMuonEFTrackIsolationTool;}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_annulusSize

double TrigMuonEFTrackIsolationTool::m_annulusSize

private

size of the annulus within which we ignore tracks

Definition at line 50 of file TrigMuonEFTrackIsolationTool.h.

m_debug

bool TrigMuonEFTrackIsolationTool::m_debug

private

Definition at line 38 of file TrigMuonEFTrackIsolationTool.h.

m_deltaz_cut

double TrigMuonEFTrackIsolationTool::m_deltaz_cut

private

cut between z of muon id trk and z of id trks - < 0 means no cut

Definition at line 41 of file TrigMuonEFTrackIsolationTool.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_removeSelf

bool TrigMuonEFTrackIsolationTool::m_removeSelf

private

flag to determine whether to remove pT of muon track from the calculation

Definition at line 44 of file TrigMuonEFTrackIsolationTool.h.

m_trkSelTool

ToolHandle<InDet::IInDetTrackSelectionTool> TrigMuonEFTrackIsolationTool::m_trkSelTool

private

Track selection tool.

Definition at line 56 of file TrigMuonEFTrackIsolationTool.h.

m_useAnnulus

bool TrigMuonEFTrackIsolationTool::m_useAnnulus

private

flag to determine if we should use an inner annulus

Definition at line 47 of file TrigMuonEFTrackIsolationTool.h.

m_useVarIso

bool TrigMuonEFTrackIsolationTool::m_useVarIso

private

flag to determine if we want to use offline isolation variables

Definition at line 53 of file TrigMuonEFTrackIsolationTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• TrigMuonEFTrackIsolationTool.h
• TrigMuonEFTrackIsolationTool.cxx