D3PD::TrackParticleVertexAssociationTool Class Reference

Associate from a TrackParticle to its reconstructed vertex. More...

#include <TrackParticleVertexAssociationTool.h>

Inheritance diagram for D3PD::TrackParticleVertexAssociationTool:

Collaboration diagram for D3PD::TrackParticleVertexAssociationTool:

Public Types
typedef SingleAssociationTool< Types< Rec::TrackParticle, xAOD::TrackParticle >, Types< Trk::VxCandidate, xAOD::Vertex > >	Base

Public Member Functions
	TrackParticleVertexAssociationTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	initialize () override
	Standard Gaudi initialize method.
virtual StatusCode	book () final
	book ntuple variables
virtual const Trk::VxCandidate *	get (const Rec::TrackParticle &p) override
	Return the target object.
virtual const xAOD::Vertex *	get (const xAOD::TrackParticle &p) override
	Return the target object.
virtual const void *	getUntyped (const void *p)
	Return the target object.
virtual const std::type_info &	fromTypeinfo () const
	Return the std::type_info for the source of the association.
virtual const Types< Trk::VxCandidate, xAOD::Vertex > *	get (const Types< Rec::TrackParticle, xAOD::TrackParticle > &p)=0
	Return the target object.
virtual const std::type_info &	typeinfo () const
	Return the type of object retrieved by this tool.
virtual void	releaseObject (const typename SelectType< Types< Rec::TrackParticle, xAOD::TrackParticle >, 0 >::type *p)
	Release an object retrieved from the association.
virtual void	releaseObject (const typename SelectType< TO_T, 0 >::type *p)
	Release an object retrieved from the association.
virtual void	releaseObjectUntyped (const void *p)
	Release an object retrieved from the association.
virtual StatusCode	configureD3PD (D3PD::IAddVariable *tree, const std::type_info &ti)
	Configure during initialization: type-check.
StatusCode	configureD3PD (IAddVariable *tree)
	Configure the parent tree.
virtual StatusCode	addVariable (const std::string &name, const std::type_info &ti, void *&ptr, const std::string &docstring="", const void *defval=0)
	Add a variable to the tuple.
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring="")
	Make the template implementation from IAddVariable visible.
StatusCode	addVariable (const std::string &name, T *&ptr, const std::string &docstring, const U &defval)
	Make the template implementation from IAddVariable visible.
virtual StatusCode	addDimensionedVariable (const std::string &name, const std::type_info &ti, void *&ptr, const std::string &dim, const std::string &docstring="", const void *defval=0)
	Add a variable to the tuple.
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring="")
	Add a variable to the tuple.
StatusCode	addDimensionedVariable (const std::string &name, T *&ptr, const std::string &dim, const std::string &docstring, const U &defval)
	Add a variable to the tuple.

Protected Member Functions
const void *	doConversion (const void *p)
	Helper to convert pointers to source objects.
StatusCode	configureMulti (D3PD::IAddVariable *tree, const std::type_info &ti, const std::vector< const std::type_info * > &tis, size_t &which)
	Configure during initialization: type-check.

Protected Attributes
ObjectMetadata	m_metadata
	Metadata about the variables created by this object.

Private Attributes
std::string	m_targetSGKey
	SG key for target collection.
bool	m_fast
	flag to just return whatever is returned by TrackParticle::reconstructedVertex()
float *	m_weight
	weight of the track at the associated vertex
SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexKey { this, "VertexContainer", "PrimaryVertices", "primary vertex container" }
	xAOD vertex container handle key
std::string	m_prefix
	Parameter: source object prefix.
std::string	m_blockName
	Property: the name of this block.
TypeConverter	m_inputConverter
	Helper to convert source object pointers.
const std::string &	m_suffix
	Reference to the variable suffix.
IAddVariable *	m_tree
	Reference to the block name.

Static Private Attributes
static const std::string	s_emptyString
	Used to provide a default value for blockName.

Detailed Description

Associate from a TrackParticle to its reconstructed vertex.

Definition at line 34 of file TrackParticleVertexAssociationTool.h.

Member Typedef Documentation

Base

typedef SingleAssociationTool<Types<Rec::TrackParticle, xAOD::TrackParticle>, Types<Trk::VxCandidate, xAOD::Vertex> > D3PD::TrackParticleVertexAssociationTool::Base

Definition at line 40 of file TrackParticleVertexAssociationTool.h.

Constructor & Destructor Documentation

TrackParticleVertexAssociationTool()

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

Standard Gaudi tool constructor.

Parameters

type	The name of the tool type.
name	The tool name.
parent	The tool's Gaudi parent.

Definition at line 31 of file TrackParticleVertexAssociationTool.cxx.

    : Base (type, name, parent)
{
  declareProperty ("VxSGKey", m_targetSGKey="VxPrimaryCandidate");
  declareProperty ("Fast", m_fast = false);
 
  book().ignore(); // Avoid coverity warnings.
}

Member Function Documentation

addDimensionedVariable() [1/3]

StatusCode D3PD::AddVariable::addDimensionedVariable ( const std::string & name, const std::type_info & ti, void *& ptr, const std::string & dim, const std::string & docstring = "", const void * defval = 0 )

virtualinherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by ti. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

Definition at line 119 of file AddVariable.cxx.

{
  if (!m_tree) {
    // Called from constructor --- just initialize pointer.
    ptr = 0;
    return StatusCode::SUCCESS;
  }
 
  CHECK( m_metadata.addDimensionedVariable( m_prefix + name + m_suffix,
                                            ti, ptr, dim,
                                            docstring, defval ) );
  return m_tree->addDimensionedVariable (m_prefix + name + m_suffix,
                                         ti, ptr, dim,
                                         docstring, defval);
}

addDimensionedVariable() [2/3]

StatusCode D3PD::IAddVariable::addDimensionedVariable ( const std::string & name, T *& ptr, const std::string & dim, const std::string & docstring, const U & defval )

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

addDimensionedVariable() [3/3]

StatusCode D3PD::IAddVariable::addDimensionedVariable ( const std::string & name, T *& ptr, const std::string & dim, const std::string & docstring = "" )

inherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
dim	Dimension for the variable. (Presently unimplemented!)
docstring	Documentation string for this variable.

If called from the constructor, the only effect is to clear ptr.

addVariable() [1/3]

StatusCode D3PD::AddVariable::addVariable ( const std::string & name, const std::type_info & ti, void *& ptr, const std::string & docstring = "", const void * defval = 0 )

virtualinherited

Add a variable to the tuple.

Parameters

name	The name of the variable.
type	The type of the variable.
ptr	Pointer to the type of the variable. The pointer need not be initialized; the D3PD software will set the pointer prior to calling fill().
docstring	Documentation string for this variable.
defval	Pointer to the default value to use for this variable. Null for no default (generally means to fill with zeros). Of the type given by ti. Only works for basic types.

If called from the constructor, the only effect is to clear ptr.

Definition at line 93 of file AddVariable.cxx.

{
  if (!m_tree) {
    // Called from constructor --- just initialize pointer.
    ptr = 0;
    return StatusCode::SUCCESS;
  }
 
  CHECK( m_metadata.addVariable( m_prefix + name + m_suffix,
                                 ti, ptr, docstring, defval ) );
  return m_tree->addVariable (m_prefix + name + m_suffix,
                              ti, ptr, docstring, defval);
}

addVariable() [2/3]

StatusCode D3PD::IAddVariable::addVariable ( const std::string & name, T *& ptr, const std::string & docstring, const U & defval )

inherited

Make the template implementation from IAddVariable visible.

addVariable() [3/3]

StatusCode D3PD::IAddVariable::addVariable ( const std::string & name, T *& ptr, const std::string & docstring = "" )

inherited

Make the template implementation from IAddVariable visible.

book()

StatusCode D3PD::TrackParticleVertexAssociationTool::book ( )

finalvirtual

book ntuple variables

Reimplemented from D3PD::SingleAssociationToolImpl.

Definition at line 55 of file TrackParticleVertexAssociationTool.cxx.

                                                   {
 
  if(!m_fast) CHECK( addVariable("weight", m_weight) );
 
  return Base::book();
}

configureD3PD() [1/2]

StatusCode D3PD::SingleAssociationToolImpl::configureD3PD ( D3PD::IAddVariable * tree, const std::type_info & ti )

virtualinherited

Configure during initialization: type-check.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to getUntyped.

configureD3PD should check that the type of the object coming as input (to getUntyped) is compatible with what it expects, and raise an error otherwise.

Parameters

tree	Our parent for tuple making.
ti	Gives the type of the object being passed to resetUntyped.

configureD3PD should check that the type of the object coming as input (to getUntyped) is compatible with what it expects, and raise an error otherwise.

Definition at line 69 of file SingleAssociationToolImpl.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_inputConverter.init (ti, fromTypeinfo()) );
  return StatusCode::SUCCESS;
}

configureD3PD() [2/2]

StatusCode D3PD::AddVariable::configureD3PD ( IAddVariable * tree )

inherited

Configure the parent tree.

Parameters

tree	The parent IAddVariable instance.

Definition at line 69 of file AddVariable.cxx.

{
  m_tree = tree;
  m_metadata.clear();
  return StatusCode::SUCCESS;
}

configureMulti()

StatusCode D3PD::SingleAssociationToolImpl::configureMulti ( D3PD::IAddVariable * tree, const std::type_info & ti, const std::vector< const std::type_info * > & tis, size_t & which )

protectedinherited

Configure during initialization: type-check.

Alternate implementation for the case where we have to choose among multiple possible input types.

Parameters

	tree	Our parent for tuple making.
	ti	Gives the type of the object being passed to getUntyped.
	tis	List of possible input types that we can accept.
[out]	which	Index of the accepted type.

configureMulti should check that the type of the object coming as input (to getUntyped) is compatible with what it expects, and raise an error otherwise.

Definition at line 110 of file SingleAssociationToolImpl.cxx.

{
  CHECK( AddVariable::configureD3PD (tree) );
  CHECK( m_inputConverter.init (ti, tis, which) );
  return StatusCode::SUCCESS;
}

doConversion()

const void * D3PD::SingleAssociationToolImpl::doConversion ( const void * p )

protectedinherited

Helper to convert pointers to source objects.

Parameters

p	Source object, as a pointer to the type passed to configureD3PD. return Source object, as a pointer to the type given by fromTypeinfo.
p	Source object, as a pointer to the type passed to configureD3PD. return Source object, as a pointer to the type given by typeinfoFrom.

Definition at line 94 of file SingleAssociationToolImpl.cxx.

{
  if (!p) return 0;
  const void* pp = m_inputConverter.convertUntyped (p);
  if (!pp) {
    REPORT_MESSAGE (MSG::WARNING)
      << "Pointer conversion from " << m_inputConverter.srcName() << " to "
      << m_inputConverter.dstName() << " failed.";
    return 0;
  }
  return pp;
}

fromTypeinfo()

virtual const std::type_info & D3PD::SingleAssociationTool< Types< Rec::TrackParticle, xAOD::TrackParticle >, Types< Trk::VxCandidate, xAOD::Vertex > >::fromTypeinfo ( ) const

virtualinherited

Return the std::type_info for the source of the association.

Implements D3PD::SingleAssociationToolImpl.

get() [1/3]

virtual const Types< Trk::VxCandidate, xAOD::Vertex > * D3PD::SingleAssociationTool< Types< Rec::TrackParticle, xAOD::TrackParticle >, Types< Trk::VxCandidate, xAOD::Vertex > >::get ( const Types< Rec::TrackParticle, xAOD::TrackParticle > & p )

pure virtualinherited

Return the target object.

Parameters

p	The source object for the association.

Return the target of the association, or 0.

get() [2/3]

const Trk::VxCandidate * D3PD::TrackParticleVertexAssociationTool::get ( const Rec::TrackParticle & p )

overridevirtual

Return the target object.

Parameters

p	The source object for the association.

Return the target of the association, or 0.

Definition at line 68 of file TrackParticleVertexAssociationTool.cxx.

                                                                                        {
 
  if(m_fast){
    return p.reconstructedVertex();
  }
 
  *m_weight = 0;
 
  const VxContainer* vxContainer = 0;
  StatusCode sc = evtStore()->retrieve(vxContainer, m_targetSGKey);
  if (sc.isFailure() || !vxContainer) {
    REPORT_MESSAGE (MSG::WARNING) << "Could not retrieve primary vertex container: " << m_targetSGKey;
    return 0;
  }
 
  int nVx = vxContainer->size();
  if(nVx < 1){
    return 0;
  }
 
  for(int v=0; v<nVx-1; v++){
    const Trk::VxCandidate* vx = vxContainer->at(v);
    const std::vector<Trk::VxTrackAtVertex*>* tracks = vx->vxTrackAtVertex();
    int nTracks = 0;
    if(tracks) nTracks = tracks->size();
    for(int t=0; t<nTracks; t++) {
      Trk::VxTrackAtVertex* track = tracks->at(t);
      if(track){
    Trk::ITrackLink* link = track->trackOrParticleLink();
    if (link) {
      Trk::LinkToTrackParticleBase* linkToTrackParticle = dynamic_cast<Trk::LinkToTrackParticleBase*>(link);
      if(linkToTrackParticle){
        const Trk::TrackParticleBase *particle_base = **linkToTrackParticle;
        if(particle_base == &p){
          *m_weight = track->weight();
          return vx;
        }
      }
    }
      }
    }
  }
 
  return vxContainer->at(nVx-1);
}

get() [3/3]

const xAOD::Vertex * D3PD::TrackParticleVertexAssociationTool::get ( const xAOD::TrackParticle & p )

overridevirtual

Return the target object.

Parameters

p	The source object for the association.

Return the target of the association, or 0.

Definition at line 122 of file TrackParticleVertexAssociationTool.cxx.

{
  const xAOD::Vertex* foundVertex { nullptr };
  SG::ReadHandle<xAOD::VertexContainer> vertices { m_vertexKey };
  if (!vertices.isValid())
  {
    ATH_MSG_WARNING("No VertexContainer with key = " << m_vertexKey.key() );
    return foundVertex;
  }
  for ( const auto vx : *vertices ) 
  {
    for ( const auto& tpLink : vx->trackParticleLinks() )
    {
      if ( *tpLink == &p )
      {
    foundVertex = vx;
    break;
      }
    }
    if (foundVertex) break;
  }
  return foundVertex;
}

getUntyped()

virtual const void * D3PD::SingleAssociationTool< Types< Rec::TrackParticle, xAOD::TrackParticle >, Types< Trk::VxCandidate, xAOD::Vertex > >::getUntyped ( const void * p )

virtualinherited

Return the target object.

Parameters

p	The source object for the association.

Return the target of the association, or 0. Should be of the type given by typeinfo.

initialize()

StatusCode D3PD::TrackParticleVertexAssociationTool::initialize ( )

overridevirtual

Standard Gaudi initialize method.

Definition at line 46 of file TrackParticleVertexAssociationTool.cxx.

{
  ATH_CHECK( m_vertexKey.initialize() );
  return Base::initialize();
}

releaseObject() [1/2]

virtual void D3PD::SingleAssociationToolTo< Types< Rec::TrackParticle, xAOD::TrackParticle > >::releaseObject ( const typename SelectType< Types< Rec::TrackParticle, xAOD::TrackParticle >, 0 >::type * p )

virtualinherited

Release an object retrieved from the association.

Parameters

p	The object to release.

Call this when you are done with the object returned by get(). The default implementation is a no-op, but if the association dynamically allocated the object which it returned, this gives it a chance to free it.

releaseObject() [2/2]

template<typename TO_T>

virtual void D3PD::SingleAssociationToolTo< TO_T >::releaseObject ( const typename SelectType< TO_T, 0 >::type * p )

virtualinherited

Release an object retrieved from the association.

Parameters

p	The object to release.

Call this when you are done with the object returned by get(). The default implementation is a no-op, but if the association dynamically allocated the object which it returned, this gives it a chance to free it.

Reimplemented in D3PD::SingleAssociationTool< Types< T0 >, TO_T >.

releaseObjectUntyped()

virtual void D3PD::SingleAssociationToolTo< Types< Rec::TrackParticle, xAOD::TrackParticle > >::releaseObjectUntyped ( const void * p )

virtualinherited

Release an object retrieved from the association.

Parameters

p	The object to release.

Call this when you are done with the object returned by getUntyped(). The default implementation is a no-op, but if the association dynamically allocated the object which it returned, this gives it a chance to free it.

typeinfo()

virtual const std::type_info & D3PD::SingleAssociationToolTo< Types< Rec::TrackParticle, xAOD::TrackParticle > >::typeinfo ( ) const

virtualinherited

Return the type of object retrieved by this tool.

Member Data Documentation

m_blockName

std::string D3PD::SingleAssociationToolImpl::m_blockName

privateinherited

Property: the name of this block.

Definition at line 121 of file SingleAssociationToolImpl.h.

m_fast

bool D3PD::TrackParticleVertexAssociationTool::m_fast

private

flag to just return whatever is returned by TrackParticle::reconstructedVertex()

Definition at line 81 of file TrackParticleVertexAssociationTool.h.

m_inputConverter

TypeConverter D3PD::SingleAssociationToolImpl::m_inputConverter

privateinherited

Helper to convert source object pointers.

Definition at line 124 of file SingleAssociationToolImpl.h.

m_metadata

ObjectMetadata D3PD::AddVariable::m_metadata

protectedinherited

Metadata about the variables created by this object.

Definition at line 129 of file AddVariable.h.

m_prefix

std::string D3PD::SingleAssociationToolImpl::m_prefix

privateinherited

Parameter: source object prefix.

Definition at line 118 of file SingleAssociationToolImpl.h.

m_suffix

const std::string& D3PD::AddVariable::m_suffix

privateinherited

Reference to the variable suffix.

Definition at line 137 of file AddVariable.h.

m_targetSGKey

std::string D3PD::TrackParticleVertexAssociationTool::m_targetSGKey

private

SG key for target collection.

Definition at line 78 of file TrackParticleVertexAssociationTool.h.

m_tree

IAddVariable* D3PD::AddVariable::m_tree

privateinherited

Reference to the block name.

The parent IAddVariable instance.

Definition at line 143 of file AddVariable.h.

m_vertexKey

SG::ReadHandleKey<xAOD::VertexContainer> D3PD::TrackParticleVertexAssociationTool::m_vertexKey { this, "VertexContainer", "PrimaryVertices", "primary vertex container" }

private

xAOD vertex container handle key

Definition at line 87 of file TrackParticleVertexAssociationTool.h.

{ this, "VertexContainer", "PrimaryVertices", "primary vertex container" };

m_weight

float* D3PD::TrackParticleVertexAssociationTool::m_weight

private

weight of the track at the associated vertex

Definition at line 84 of file TrackParticleVertexAssociationTool.h.

s_emptyString

const std::string D3PD::AddVariable::s_emptyString

staticprivateinherited

Used to provide a default value for blockName.

Definition at line 41 of file AddVariable.h.

---

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

• TrackParticleVertexAssociationTool.h
• TrackParticleVertexAssociationTool.cxx