InDet::InDetUsedInFitTrackDecoratorTool Class Reference

Implementation of the hardscatter selection tool. More...

#include <InDetUsedInFitTrackDecoratorTool.h>

Inheritance diagram for InDet::InDetUsedInFitTrackDecoratorTool:

Collaboration diagram for InDet::InDetUsedInFitTrackDecoratorTool:

Public Member Functions
virtual void	print () const
	Print the state of the tool.
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
Constructor(s)/destructor(s)
	InDetUsedInFitTrackDecoratorTool (const std::string &name)
	Constructor.
	~InDetUsedInFitTrackDecoratorTool ()
	Destructor.
Function(s) implementing the asg::IAsgTool interface
virtual StatusCode	initialize () override
	Function initialising the tool.
virtual StatusCode	finalize () override
	Function finalizing the tool.
Function(s) implementing the IInDetUsedInFitTrackDecoratorTool interface
virtual void	decorate (const xAOD::TrackParticleContainer *trkCont, const xAOD::VertexContainer *vtxCont, const EventContext &ctx) const override
	Function for decorating tracks with their used-in-fit AMVF vertices and weights.
virtual void	decorate (const EventContext &ctx) const override
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
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
The properties that can be defined via the python job options
StringProperty	m_vtxDecoName
	Name of the per-track decoration for the AMVF fit vertices.
StringProperty	m_wgtDecoName
	Name of the per-track decoration for the AMVF fit weights.
SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_trkContKey
	Name of the track particle container (needed for container-less function calls)
SG::ReadHandleKey< xAOD::VertexContainer >	m_vtxContKey
	Name of the primary vertex container (needed for container-less function calls)
Truly private internal data members
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_vtxDecoKey
	Per-track decorator for the AMVF fit vertices.
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_wgtDecoKey
	Per-track decorator for the AMVF fit weights.

Detailed Description

Implementation of the hardscatter selection tool.

Definition at line 31 of file InDetUsedInFitTrackDecoratorTool.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

InDetUsedInFitTrackDecoratorTool()

InDet::InDetUsedInFitTrackDecoratorTool::InDetUsedInFitTrackDecoratorTool

(

const std::string &

name

)

Constructor.

Definition at line 21 of file InDetUsedInFitTrackDecoratorTool.cxx.

                                                                                             :
  asg::AsgTool(name)
{ }

~InDetUsedInFitTrackDecoratorTool()

InDet::InDetUsedInFitTrackDecoratorTool::~InDetUsedInFitTrackDecoratorTool ( )

default

Destructor.

Member Function Documentation

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

decorate() [1/2]

void InDet::InDetUsedInFitTrackDecoratorTool::decorate ( const EventContext & ctx ) const

overridevirtual

Implements InDet::IInDetUsedInFitTrackDecoratorTool.

Definition at line 126 of file InDetUsedInFitTrackDecoratorTool.cxx.

{
  // Open our track container
  SG::ReadHandle<xAOD::TrackParticleContainer> trkCont(m_trkContKey, ctx);
  if (!trkCont.isValid()) {
    ATH_MSG_WARNING("Unable to retrieve xAOD::TrackParticleContainer, \"" << m_trkContKey.key() << "\", returning without applying decorations!");
    return;
  }
 
  // Open our vertex container
  SG::ReadHandle<xAOD::VertexContainer> vtxCont(m_vtxContKey, ctx);
  if (!vtxCont.isValid()) {
    ATH_MSG_WARNING("Unable to retrieve xAOD::VertexContainer, \"" << m_vtxContKey.key() << "\", returning without applying decorations!");
    return;
  }
 
  // Perform the decoration
  decorate(trkCont.get(), vtxCont.get(), ctx);
 
}

decorate() [2/2]

void InDet::InDetUsedInFitTrackDecoratorTool::decorate ( const xAOD::TrackParticleContainer * trkCont, const xAOD::VertexContainer * vtxCont, const EventContext & ctx ) const

overridevirtual

Function for decorating tracks with their used-in-fit AMVF vertices and weights.

Implements InDet::IInDetUsedInFitTrackDecoratorTool.

Definition at line 68 of file InDetUsedInFitTrackDecoratorTool.cxx.

{
  ATH_MSG_DEBUG("In decorate(...) for " << name() <<  "...");
 
  // Decor handles for the AMVF vertices and weights
  SG::WriteDecorHandle<xAOD::TrackParticleContainer, std::vector<ElementLink<xAOD::VertexContainer>>> vtxDeco(m_vtxDecoKey, ctx);
  SG::WriteDecorHandle<xAOD::TrackParticleContainer, std::vector<float>> wgtDeco(m_wgtDecoKey, ctx);
  bool isVtxDeco_available = vtxDeco.isAvailable();
  if(isVtxDeco_available) return;
 
  //vector to collect results
  std::vector<std::pair<const xAOD::Vertex*,float> > vxWithWeight;
 
  // Iterate over our tracks:
  for (const xAOD::TrackParticle*  trk : *trkCont) {
    if (!trk) continue;
 
    vxWithWeight.clear();
 
    // Iterate over our vertices
    for (const auto *const vtx : *vtxCont) {
      if (!vtx) continue;
 
      //Search for vertex linked to this track
      const auto& trkLinks=vtx->trackParticleLinks();
      const size_t nTrackLinks=trkLinks.size();
      for (unsigned i=0;i<nTrackLinks;++i) {
        if (trkLinks[i].isValid() && *(trkLinks[i]) == trk) {//ptr comparison
          vxWithWeight.emplace_back(vtx,vtx->trackWeights()[i]);
          break; //Found pointer, quit loop
        }
      }
    }//end loop over vertices
 
    //sort by weight
    std::sort(vxWithWeight.begin(),vxWithWeight.end(),
        [](std::pair<const xAOD::Vertex*,float>& a, std::pair<const xAOD::Vertex*,float>& b){ return a.second > b.second; } );
 
    //split vector of pairs into two vectors in sync:
 
    std::vector<ElementLink<xAOD::VertexContainer>> AMVFVertices;
    std::vector<float> AMVFWeights;
    AMVFVertices.reserve(vxWithWeight.size());
    AMVFWeights.reserve(vxWithWeight.size());
 
    for (const auto& p : vxWithWeight) {
      AMVFVertices.emplace_back(p.first,*vtxCont,ctx);
      AMVFWeights.emplace_back(p.second);
    }
 
    // Actually perform the decoration
    vtxDeco(*trk) = std::move(AMVFVertices);
    wgtDeco(*trk) = std::move(AMVFWeights);
 
  } // end, loop over tracks
 
}

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

finalize()

StatusCode InDet::InDetUsedInFitTrackDecoratorTool::finalize ( )

overridevirtual

Function finalizing the tool.

Definition at line 61 of file InDetUsedInFitTrackDecoratorTool.cxx.

{
  ATH_MSG_DEBUG("Finalizing " << name() << "...");
 
  return StatusCode::SUCCESS;
}

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.

initialize()

StatusCode InDet::InDetUsedInFitTrackDecoratorTool::initialize ( void )

overridevirtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

Definition at line 30 of file InDetUsedInFitTrackDecoratorTool.cxx.

{
  // Print configuration
  ATH_MSG_DEBUG("Initializing " << name() << "...");
  ATH_MSG_DEBUG("Using AMVFVerticesDecoName: " << m_vtxDecoName);
  ATH_MSG_DEBUG("Using AMVFWeightsDecoName: "  << m_wgtDecoName);
  ATH_MSG_DEBUG("Using TrackContainer: "       << m_trkContKey);
  ATH_MSG_DEBUG("Using VertexContainer: "      << m_vtxContKey);
 
  // Instantiate and initialize our container reads
  // For tracks:
  ATH_CHECK(m_trkContKey.initialize());
  // For vertices:
  ATH_CHECK(m_vtxContKey.initialize());
 
  // Instantiate and initialize our decorator writes
  // For vertices:
  m_vtxDecoKey = SG::WriteDecorHandleKey<xAOD::TrackParticleContainer>(m_trkContKey.key() + "." + m_vtxDecoName); // FIXME Do not assign properties during initialize()
  this->declare(m_vtxDecoKey);
  m_vtxDecoKey.setOwner(&(*this));
  ATH_CHECK(m_vtxDecoKey.initialize());
  // For weights:
  m_wgtDecoKey = SG::WriteDecorHandleKey<xAOD::TrackParticleContainer>(m_trkContKey.key() + "." + m_wgtDecoName); // FIXME Do not assign properties during initialize()
  this->declare(m_wgtDecoKey);
  m_wgtDecoKey.setOwner(&(*this));
  ATH_CHECK(m_wgtDecoKey.initialize());
 
  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.

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

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

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_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_trkContKey

SG::ReadHandleKey<xAOD::TrackParticleContainer> InDet::InDetUsedInFitTrackDecoratorTool::m_trkContKey

private

Initial value:

{this, "TrackContainer", "InDetTrackParticles",
       "Name of the track particle container"}

Name of the track particle container (needed for container-less function calls)

Definition at line 93 of file InDetUsedInFitTrackDecoratorTool.h.

      {this, "TrackContainer", "InDetTrackParticles",
       "Name of the track particle container"};

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.

m_vtxContKey

SG::ReadHandleKey<xAOD::VertexContainer> InDet::InDetUsedInFitTrackDecoratorTool::m_vtxContKey

private

Initial value:

{this, "VertexContainer", "PrimaryVertices",
       "Name of the primary vertex container"}

Name of the primary vertex container (needed for container-less function calls)

Definition at line 98 of file InDetUsedInFitTrackDecoratorTool.h.

      {this, "VertexContainer", "PrimaryVertices",
       "Name of the primary vertex container"};

m_vtxDecoKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> InDet::InDetUsedInFitTrackDecoratorTool::m_vtxDecoKey

private

Per-track decorator for the AMVF fit vertices.

Definition at line 110 of file InDetUsedInFitTrackDecoratorTool.h.

m_vtxDecoName

StringProperty InDet::InDetUsedInFitTrackDecoratorTool::m_vtxDecoName

private

Initial value:

{this, "AMVFVerticesDecoName", "TTVA_AMVFVertices",
        "Name of the per-track AMVF vertices decoration"}

Name of the per-track decoration for the AMVF fit vertices.

Definition at line 83 of file InDetUsedInFitTrackDecoratorTool.h.

    {this, "AMVFVerticesDecoName", "TTVA_AMVFVertices",
        "Name of the per-track AMVF vertices decoration"};

m_wgtDecoKey

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> InDet::InDetUsedInFitTrackDecoratorTool::m_wgtDecoKey

private

Per-track decorator for the AMVF fit weights.

Definition at line 113 of file InDetUsedInFitTrackDecoratorTool.h.

m_wgtDecoName

StringProperty InDet::InDetUsedInFitTrackDecoratorTool::m_wgtDecoName

private

Initial value:

{this, "AMVFWeightsDecoName", "TTVA_AMVFWeights",
       "Name of the per-track AMVF weights decoration"}

Name of the per-track decoration for the AMVF fit weights.

Definition at line 88 of file InDetUsedInFitTrackDecoratorTool.h.

      {this, "AMVFWeightsDecoName", "TTVA_AMVFWeights",
       "Name of the per-track AMVF weights decoration"};

---

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

• InDetUsedInFitTrackDecoratorTool.h
• InDetUsedInFitTrackDecoratorTool.cxx