xAOD::TrackIsolationTool Class Reference

#include <TrackIsolationTool.h>

Inheritance diagram for xAOD::TrackIsolationTool:

Collaboration diagram for xAOD::TrackIsolationTool:

Classes
struct	TrackIsolationInput

Public Types
typedef std::vector< const TrackParticle * >	TPVec
	Create a constructor for Athena. More...

Public Member Functions
	TrackIsolationTool (const std::string &name)
	constructor More...
virtual	~TrackIsolationTool (void)
	destructor More...
virtual StatusCode	initialize () override
	initialize More...
virtual bool	trackIsolation (TrackIsolation &result, const IParticle &tp, const std::vector< Iso::IsolationType > &cones, TrackCorrection corrections, const Vertex *vertex=0, const std::set< const TrackParticle * > *exclusionSet=0, const TrackParticleContainer *indetTrackParticles=0) const override
	ITrackIsolationTool interface: More...
virtual void	print () const
	Print the state of the tool. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
float	phiInRange (float phi) const
	hepler function to ensure phi is within +-Pi More...
bool	simpleIsolation (TrackIsolationInput &input, TrackIsolation &result, const TrackParticleContainer *indetTrackParticles=0) const
	simple isolation (loop) More...
bool	binnedIsolation (TrackIsolationInput &input, TrackIsolation &result) const
	using TracksInConeTool More...
void	add (TrackIsolationInput &input, const TrackParticle &tp2, TrackIsolation &result) const
	add track particle to isolation calculation More...
const IParticle *	getReferenceParticle (const IParticle &particle) const
	get reference particle More...
const Vertex *	retrieveIDBestPrimaryVertex (const VertexContainer *vtxC) const
	retrieve pvx if not given More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Static Private Member Functions
static void	initresult (TrackIsolation &result, TrackCorrection corrlist, unsigned int typesize)
	init result struct More...

Private Attributes
SG::ReadHandleKey< TrackParticleContainer >	m_indetTrackParticleLocation
	track particle location More...
Gaudi::Property< bool >	m_simpleIsolation {this, "SimpleIsolation", false}
	flag to select calculation type More...
Gaudi::Property< float >	m_overlapCone {this, "OverlapCone", 0.1}
float	m_overlapCone2 = 0.0F
Gaudi::Property< float >	m_coreTrackEtaRange
	overlap cone size squared More...
bool	m_useLooseTrackCore {false}
	Whether the loose core track eta range is used. More...
ToolHandle< ITrackParticlesInConeTool >	m_tracksInConeTool
	tracks in cone tool More...
ToolHandle< InDet::IInDetTrackSelectionTool >	m_trkselTool
	selection of tracks More...
ToolHandle< CP::ITrackVertexAssociationTool >	m_ttvaTool
	Select tracks associated to the vertex. More...
bool	m_useTTVATool {false}
	Use the ttva tool. Set to true if one was provided. More...
SG::ReadHandleKey< VertexContainer >	m_vertexLocation
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Static Private Attributes
static constexpr float	m_2PI = 2*M_PI
	define 2*Pi More...

Detailed Description

Definition at line 38 of file TrackIsolationTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

TPVec

typedef std::vector< const TrackParticle* > xAOD::TrackIsolationTool::TPVec

Create a constructor for Athena.

Definition at line 43 of file TrackIsolationTool.h.

Constructor & Destructor Documentation

TrackIsolationTool()

xAOD::TrackIsolationTool::TrackIsolationTool

(

const std::string &

name

)

constructor

Definition at line 27 of file TrackIsolationTool.cxx.

                                                              :
    asg::AsgTool(name)
  {
#ifndef XAOD_ANALYSIS
    declareInterface<ITrackIsolationTool>(this);
#endif // XAOD_ANALYSIS
  }

~TrackIsolationTool()

xAOD::TrackIsolationTool::~TrackIsolationTool ( void  )

virtualdefault

destructor

Member Function Documentation

add()

void xAOD::TrackIsolationTool::add ( TrackIsolationInput &  input, const TrackParticle &  tp2, TrackIsolation &  result  ) const

private

add track particle to isolation calculation

sum up particle to the different cones

Definition at line 235 of file TrackIsolationTool.cxx.

  {
    // check if track pointer matches the one of input or one of the exclusion set
    // Jon Burr: I'm not completely convinced by the use of CoreTrackEtaRange.
    // With this setup, if you're running in simple isolation mode any track
    // within the same eta slice (even on the other side of the detector) will
    // be included in the eta code. If you manually provide a track particle
    // container then the tool automatically runs in this simple mode...
    // This is fine in IsolationBuilder (the main client) but could produce
    // unexpected results with other users
    if(input.corrections.trackbitset.test(static_cast<unsigned int>(Iso::coreTrackPtr))){
      if(input.particle == &tp2 || 
         (input.exclusionSet && input.exclusionSet->count(&tp2)) ||
         (m_useLooseTrackCore && std::abs(input.particle->eta() - tp2.eta()) < m_coreTrackEtaRange)){
        ATH_MSG_DEBUG("track pointer " << &tp2 << ", track pt = " << tp2.pt() << ", input pt = " << input.particle->pt()) ;
        result.coreCorrections[Iso::coreTrackPtr] += tp2.pt();
        return;
      }
    }
 
    // check eta
    float deta = input.particle->eta()-tp2.eta();
    if( fabs(deta) > input.maxRadius ) return;
 
    // check phi
    float dphi = phiInRange(input.particle->phi()-tp2.phi());
    if( fabs(dphi) > input.maxRadius ) return;
 
    // check dr2
    float dr2 = deta*deta + dphi*dphi;
 
    // check cone if using cone based overlap removal
    if(input.corrections.trackbitset.test(static_cast<unsigned int>(Iso::coreTrackCone))
       && dr2 < m_overlapCone2 ) {
      result.coreCorrections[Iso::coreTrackCone] += tp2.pt();
      return;
    }
 
    for( unsigned int k=0;k<input.coneSizesSquared.size();++k ){
      if( dr2 >= input.coneSizesSquared[k] ) return;
      result.ptcones[k] += tp2.pt();
      if( dr2 <= input.ptvarconeRadiusSquared ){
        result.ptvarcones_10GeVDivPt[k] += tp2.pt();
      }
    }
  }

binnedIsolation()

bool xAOD::TrackIsolationTool::binnedIsolation ( TrackIsolationInput &  input, TrackIsolation &  result  ) const

private

using TracksInConeTool

prepare look-up structure

Definition at line 176 of file TrackIsolationTool.cxx.

  {
    std::vector<const TrackParticle*> tps;
#ifndef XAOD_ANALYSIS
     if( !m_tracksInConeTool->particlesInCone(input.particle->eta(),input.particle->phi(),input.maxRadius,tps) ) return false;
#else
     if( !getparticlesInCone(input.particle->eta(),input.particle->phi(),input.maxRadius,tps) ) return false;
#endif
 
    for( const auto& tp : tps ) {
      if( (!m_trkselTool->accept( *tp , input.vertex)) ||
        (m_useTTVATool && (!input.vertex || !m_ttvaTool->isCompatible(*tp, *input.vertex)))){
          if (m_useTTVATool && !input.vertex){
            ATH_MSG_DEBUG("Encountered a track isolation input with invalid vertex while requiring TTVA. Rejecting, please check your inputs!"); 
          } 
          ATH_MSG_DEBUG("reject track pt = " << tp->pt());
          continue;
      } else{
    ATH_MSG_DEBUG("Accept track " << tp << " pt = " << tp->pt() << " z+vz = " << tp->z0()+tp->vz() << " eta = " << tp->eta() << " phi = " << tp->phi());
      }
      add( input,*tp, result );
 
    }
    return true;
  }

declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  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() [1/2]

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

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 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

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void *  ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void *  ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string &  name ) const

inherited

Get one of the tool's properties.

getReferenceParticle()

const IParticle * xAOD::TrackIsolationTool::getReferenceParticle ( const IParticle &  particle ) const

private

get reference particle

Print a warning for the case that no primary track was found. Given that eta/phi/pt are the same for the primary track and the muon track... Do not return a nullptr

Definition at line 88 of file TrackIsolationTool.cxx.

                                                                                           {
    if( particle.type() == xAOD::Type::ObjectType::Muon) {
      const Muon* muon = static_cast<const Muon*>(&particle);
      const xAOD::TrackParticle* tp = muon->trackParticle(xAOD::Muon::InnerDetectorTrackParticle);
      if( !tp ) tp = muon->primaryTrackParticle();
      if( !tp ) {
        ATH_MSG_WARNING(" No TrackParticle found for muon  with pT: " <<muon->pt() * 1.e-3 <<"[GeV], eta: "<<muon->eta()<<" phi: "<<
                        muon->phi()<<" q: "<<muon->charge()<<" primaryAuthor: "<<muon->author()<< " allAuthors: "<<muon->allAuthors());
      } else return tp;
    }
    return &particle;
  }

initialize()

StatusCode xAOD::TrackIsolationTool::initialize ( )

overridevirtual

initialize

square cone

Reimplemented from asg::AsgTool.

Definition at line 40 of file TrackIsolationTool.cxx.

  {
#ifndef XAOD_ANALYSIS
    ATH_CHECK(m_tracksInConeTool.retrieve( DisableTool{m_simpleIsolation} ));
#endif // XAOD_ANALYSIS
 
      if(m_trkselTool.retrieve().isFailure()){
    ATH_MSG_FATAL("Could not retrieve InDetTrackSelectionTool");
    return StatusCode::FAILURE;
      }
      if (!m_ttvaTool.empty()) {
        ATH_MSG_DEBUG("Use TTVA tool " << m_ttvaTool);
        m_useTTVATool = true;
        ATH_CHECK( m_ttvaTool.retrieve() );
      }
      else
        ATH_MSG_DEBUG("Will not use TTVA tool");
 
    m_overlapCone2 = m_overlapCone*m_overlapCone;
 
    // the read handles
    ATH_CHECK(m_indetTrackParticleLocation.initialize());
    if (!m_vertexLocation.key().empty())
      ATH_CHECK(m_vertexLocation.initialize());
 
    if (m_coreTrackEtaRange.value() > 0)
      m_useLooseTrackCore = true;
 
    return StatusCode::SUCCESS;
  }

initresult()

void xAOD::TrackIsolationTool::initresult ( TrackIsolation &  result, TrackCorrection  corrlist, unsigned int  typesize  )

staticprivate

init result struct

Definition at line 283 of file TrackIsolationTool.cxx.

                                             {
 
    result.corrlist = corrlist;
    result.coreCorrections.clear();
    result.ptcones.resize(typesize,0.);
    result.ptvarcones_10GeVDivPt.resize(typesize,0.);
 
    std::vector<float> vec;
    vec.resize(typesize,0.);
 
    for(unsigned int i=0;i<static_cast<unsigned int>(Iso::numIsolationTrackCorrections);i++){
      result.coreCorrections[static_cast<Iso::IsolationTrackCorrection>(i)] = 0.;
    }
  }

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.

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

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.

phiInRange()

float xAOD::TrackIsolationTool::phiInRange ( float  phi ) const

inlineprivate

hepler function to ensure phi is within +-Pi

Definition at line 92 of file TrackIsolationTool.h.

                                             { 
      while (phi >= M_PI) phi -= m_2PI;
      while (phi < -M_PI) phi += m_2PI;
      return phi;
    }

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

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

retrieveIDBestPrimaryVertex()

const Vertex * xAOD::TrackIsolationTool::retrieveIDBestPrimaryVertex ( const VertexContainer *  vtxC ) const

private

retrieve pvx if not given

Definition at line 72 of file TrackIsolationTool.cxx.

  {
    if (vtxC) {
      if (vtxC->empty()) {
    ATH_MSG_INFO("No vertex in container.");
    return nullptr;
      }
      // In fact, should rather do like that, in case front is not PriVtx
      for (const auto* const vtx : *vtxC ) {
    if (vtx->vertexType() == xAOD::VxType::PriVtx)
      return vtx;
      }
    }
    return nullptr;
  }

simpleIsolation()

bool xAOD::TrackIsolationTool::simpleIsolation ( TrackIsolationInput &  input, TrackIsolation &  result, const TrackParticleContainer *  indetTrackParticles = 0  ) const

private

simple isolation (loop)

retrieve track particles if not passed into the interface

Definition at line 203 of file TrackIsolationTool.cxx.

  {
 
    SG::ReadHandle<TrackParticleContainer> tpH;
    if( !indetTrackParticles ) {
      tpH = SG::makeHandle(m_indetTrackParticleLocation);
      if (!tpH.isValid()) {
    ATH_MSG_ERROR("Could not open a TrackParticle container with key "
              << m_indetTrackParticleLocation.key());
    return false;
      }
      indetTrackParticles = tpH.ptr();
    }
 
    // exit if not track particles found
    if( !indetTrackParticles ) return false;
 
    // loop over all track particles
    for( const auto *const tp : *indetTrackParticles ) {
      if( (!m_trkselTool->accept(*tp, input.vertex)) ||
        (m_useTTVATool && !m_ttvaTool->isCompatible(*tp, *input.vertex))){
    ATH_MSG_DEBUG("[2] reject track pt = " << tp->pt());
    continue;
      }
 
      add( input, *tp, result );
    }
 
    return true;
  }

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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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.

trackIsolation()

bool xAOD::TrackIsolationTool::trackIsolation ( TrackIsolation &  result, const IParticle &  tp, const std::vector< Iso::IsolationType > &  cones, TrackCorrection  corrections, const Vertex *  vertex = 0, const std::set< const TrackParticle * > *  exclusionSet = 0, const TrackParticleContainer *  indetTrackParticles = 0  ) const

overridevirtual

ITrackIsolationTool interface:

prepare input

get track particle

Implements xAOD::ITrackIsolationTool.

Definition at line 104 of file TrackIsolationTool.cxx.

  {
    // If not vertex is given, use the ID best one. If one does not want to cut on z0sinT, use the TrackSelectionTool config
    SG::ReadHandle<VertexContainer> vtxH;
    if (vertex == nullptr && !m_vertexLocation.key().empty()) {
      vtxH = SG::makeHandle(m_vertexLocation);
      if (!vtxH.isValid()) {
    ATH_MSG_ERROR("Did not find a vertex container with key " << m_vertexLocation.key());
    return false;
      }
      vertex = retrieveIDBestPrimaryVertex(vtxH.ptr());
      if (vertex)
    ATH_MSG_DEBUG("No vertex provided, is required. Use the ID-chosen pvx, z = " << vertex->z());
    }
 
    const IParticle* tp = getReferenceParticle(particle);
    if( !tp ){
      ATH_MSG_WARNING("Failed to obtain reference particle");
      return false;
    }
    if (tp->pt() <= 0.)
      ATH_MSG_WARNING("A particle of type " << particle.type() << " with strange pT : " << tp->pt()*1e-3 << " GeV");
    TrackIsolationInput input( tp, corrbitset, vertex, exclusionSet );
 
    for( auto isoType : isoTypes ){
      Iso::IsolationFlavour flavour = Iso::isolationFlavour(isoType);
      if( flavour != Iso::ptcone ) {
        ATH_MSG_WARNING("Unsupported isolation type passed, cannot calculate isolation " << Iso::toCString(isoType));
        return false;
      }
      float conesize = Iso::coneSize(isoType);
      input.coneSizesSquared.push_back(conesize*conesize);
    }
 
    for(size_t i=1; i<input.coneSizesSquared.size(); i++){
      if(input.coneSizesSquared[i]>input.coneSizesSquared[i-1]) ATH_MSG_ERROR("Isolation Cone should be in decreasing order. "<< i << "th variable is " << Iso::toCString(isoTypes[i]) << " is larger than the one before it: " << Iso::toCString(isoTypes[i-1]));
    }
 
    std::sort(input.coneSizesSquared.begin(),input.coneSizesSquared.end(),[](float i, float j) { return i>j; });
 
    initresult(result, corrbitset, input.coneSizesSquared.size());
 
    input.maxRadius = sqrt(input.coneSizesSquared[0]);
 
    bool success = false;
    // run isolation code
    if( indetTrackParticles )    success = simpleIsolation(input,result,indetTrackParticles);
    else if( m_simpleIsolation ) success = simpleIsolation(input,result);
    else                         success = binnedIsolation(input,result);
 
    if( msgLvl(MSG::DEBUG) ){
      if( !success ){
        ATH_MSG_DEBUG(" Track isolation calculation failed");
      }else{
        msg(MSG::DEBUG) << "Calculated track isolation: ";
        for( unsigned int i = 0; i< result.ptcones.size();++i ){
          msg(MSG::DEBUG) << " coneSizeSquared " << std::setw(3) << input.coneSizesSquared[i] << " value " << result.ptcones[i];
        }
        msg(MSG::DEBUG) << endmsg;
      }
    }
    return success;
  }

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_2PI

constexpr float xAOD::TrackIsolationTool::m_2PI = 2*M_PI

staticconstexprprivate

define 2*Pi

Definition at line 89 of file TrackIsolationTool.h.

m_coreTrackEtaRange

Gaudi::Property<float> xAOD::TrackIsolationTool::m_coreTrackEtaRange

private

Initial value:

{this,
     "CoreTrackEtaRange", 0.0, "The maximum eta range to consider something a core track"}

overlap cone size squared

The maximum eta range to consider something a core track

Definition at line 129 of file TrackIsolationTool.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_indetTrackParticleLocation

SG::ReadHandleKey<TrackParticleContainer> xAOD::TrackIsolationTool::m_indetTrackParticleLocation

private

Initial value:

{this,
    "TrackParticleLocation", "InDetTrackParticles"}

track particle location

Definition at line 118 of file TrackIsolationTool.h.

m_overlapCone

Gaudi::Property<float> xAOD::TrackIsolationTool::m_overlapCone {this, "OverlapCone", 0.1}

private

Definition at line 124 of file TrackIsolationTool.h.

m_overlapCone2

float xAOD::TrackIsolationTool::m_overlapCone2 = 0.0F

private

Definition at line 126 of file TrackIsolationTool.h.

m_simpleIsolation

Gaudi::Property<bool> xAOD::TrackIsolationTool::m_simpleIsolation {this, "SimpleIsolation", false}

private

flag to select calculation type

Definition at line 122 of file TrackIsolationTool.h.

m_tracksInConeTool

ToolHandle<ITrackParticlesInConeTool> xAOD::TrackIsolationTool::m_tracksInConeTool

private

Initial value:

{this, 
    "TracksInConeTool", "xAOD::TrackParticlesInConeTool/TrackParticlesInConeTool"}

tracks in cone tool

Definition at line 135 of file TrackIsolationTool.h.

m_trkselTool

ToolHandle<InDet::IInDetTrackSelectionTool> xAOD::TrackIsolationTool::m_trkselTool

private

Initial value:

{this,
    "TrackSelectionTool", "InDet::InDetTrackSelectionTool/TrackSelectionTool"}

selection of tracks

Definition at line 139 of file TrackIsolationTool.h.

m_ttvaTool

ToolHandle<CP::ITrackVertexAssociationTool> xAOD::TrackIsolationTool::m_ttvaTool

private

Initial value:

{this,
      "TTVATool", "", "Optional track to vertex association tool to filter tracks"}

Select tracks associated to the vertex.

Definition at line 143 of file TrackIsolationTool.h.

m_useLooseTrackCore

bool xAOD::TrackIsolationTool::m_useLooseTrackCore {false}

private

Whether the loose core track eta range is used.

Definition at line 132 of file TrackIsolationTool.h.

m_useTTVATool

bool xAOD::TrackIsolationTool::m_useTTVATool {false}

private

Use the ttva tool. Set to true if one was provided.

Definition at line 146 of file TrackIsolationTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vertexLocation

SG::ReadHandleKey<VertexContainer> xAOD::TrackIsolationTool::m_vertexLocation

private

Initial value:

{this,
    "VertexLocation", "PrimaryVertices"}

Definition at line 148 of file TrackIsolationTool.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:

• TrackIsolationTool.h
• TrackIsolationTool.cxx