JiveXML::xAODVertexRetriever Class Reference

Retrieves all Vertex objects (VertexAODCollection etc.) More...

#include <xAODVertexRetriever.h>

Inheritance diagram for JiveXML::xAODVertexRetriever:

Collaboration diagram for JiveXML::xAODVertexRetriever:

Public Member Functions
	xAODVertexRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	For each Vertex collections retrieve basic parameters. More...
const DataMap	getData (const xAOD::VertexContainer *, const std::string &key)
	Puts the variables into a DataMap. More...
const std::vector< std::string >	getKeys ()
	Gets the StoreGate keys for the desired containers. More...
virtual std::string	dataTypeName () const
	Return the name of the data type that is generated by this retriever. 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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Return the interface identifier. More...

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
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...

Private Attributes
const std::string	m_typeName = "RVx"
	The data type that is generated by this retriever. More...
Gaudi::Property< bool >	m_doWriteHLT {this, "DoWriteHLT", false, "Write out other collections that have HLT in the name"}
Gaudi::Property< bool >	m_doWriteAllCollections {this, "DoWriteAllCollections", false, "Write out all Cluster collections"}
Gaudi::Property< bool >	m_doWriteV0 {this, "DoWriteV0", false, "Write out other vertex collections that have V0 in the name"}
Gaudi::Property< std::string >	m_primaryVertexKey {this,"PrimaryVertexCollection","PrimaryVertices", "Name of the Primary Vertex container"}
Gaudi::Property< std::string >	m_secondaryVertexKey {this,"SecondaryVertexCollection","BTagging_AntiKt4EMPFlowSecVtx", "Name of the Secondary Vertex container"}
Gaudi::Property< std::vector< std::string > >	m_otherKeys {this, "OtherVertexCollections", {"BTagging_AntiKt4EMTopoSecVtx"}, "Other collections to be retrieved. If DoWriteAllCollections is set to true all available Vertex collections will be retrieved"}
Gaudi::Property< std::string >	m_tracksName {this, "TracksName", "InDetTrackParticles_xAOD", "Name of track container"}
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

Detailed Description

Retrieves all Vertex objects (VertexAODCollection etc.)

• Properties
• DoWriteAllCollections
• DoWriteHLT
• DoWriteV0
• PrimaryVertexCollection: First collection to be retrieved, displayed in Atlantis without switching. All other collections are also retrieved
• SecondaryVertexCollection: First collection to be retrieved, displayed in Atlantis without switching. All other collections are also retrieved.
• OtherVertexCollections
• TracksName
• Retrieved Data
  • Usual four-vectors: phi, eta, et etc.
  • Associations for clusters and tracks via ElementLink: key/index scheme

Definition at line 39 of file xAODVertexRetriever.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

xAODVertexRetriever()

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

Standard Constructor.

This is the standard AthAlgTool constructor.

Parameters

type	AlgTool type name
name	AlgTool instance name
parent	AlgTools parent owning this tool

Definition at line 24 of file xAODVertexRetriever.cxx.

                                                                                                              :
    AthAlgTool(type,name,parent){}

Member Function Documentation

dataTypeName()

virtual std::string JiveXML::xAODVertexRetriever::dataTypeName ( ) const

inlinevirtual

Return the name of the data type that is generated by this retriever.

Implements JiveXML::IDataRetriever.

Definition at line 53 of file xAODVertexRetriever.h.

{ return m_typeName; };

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

getData()

const DataMap JiveXML::xAODVertexRetriever::getData	(	const xAOD::VertexContainer *	cont,
		const std::string &	key
	)

Puts the variables into a DataMap.

Retrieve basic parameters, mainly four-vectors, for each collection.

Also association with clusters and tracks (ElementLink).

Definition at line 63 of file xAODVertexRetriever.cxx.

                                                                                                  {
 
    ATH_MSG_DEBUG("in getData()");
 
    float chi2val = 0.;
 
    DataMap DataMap;
 
    DataVect x;
    DataVect y;
    DataVect z;
    DataVect chi2;
    DataVect vertexType;
    DataVect primVxCand;
    DataVect covMatrix;
    DataVect numTracks;
    DataVect tracks;
    DataVect sgkey;
 
    //Get size of current container
    xAOD::VertexContainer::size_type NVtx = cont->size();
 
    ATH_MSG_DEBUG("Reading vertex container " << key
          << " with " << NVtx << " entries");
 
    x.reserve(x.size()+NVtx);
    y.reserve(y.size()+NVtx);
    z.reserve(z.size()+NVtx);
    chi2.reserve(chi2.size()+NVtx);
    vertexType.reserve(vertexType.size()+NVtx);
    primVxCand.reserve(primVxCand.size()+NVtx);
    covMatrix.reserve(covMatrix.size()+NVtx);
    numTracks.reserve(numTracks.size()+NVtx);
    tracks.reserve(tracks.size()+NVtx);
    sgkey.reserve(sgkey.size()+NVtx);
 
    int counter = 0;
 
    //Loop over vertices
    xAOD::VertexContainer::const_iterator VertexItr = cont->begin();
    for ( ; VertexItr != cont->end(); ++VertexItr) {
 
      ATH_MSG_DEBUG("  Vertex #" << counter++ << " : x = "  << (*VertexItr)->x()/cm << ", y = "
            << (*VertexItr)->y()/cm << ", z[GeV] = "  << (*VertexItr)->z()/cm
            << ", vertexType = "  << (*VertexItr)->vertexType()
            << ", chiSquared = "  << (*VertexItr)->chiSquared()
            << ", numberDoF = "  << (*VertexItr)->numberDoF());
 
      x.emplace_back(DataType((*VertexItr)->x()/cm));
      y.emplace_back(DataType((*VertexItr)->y()/cm));
      z.emplace_back(DataType((*VertexItr)->z()/cm));
 
      if ( key == m_secondaryVertexKey){
    vertexType.emplace_back( 2 );
      }else{
    vertexType.emplace_back( DataType((*VertexItr)->vertexType()));
      }
 
      if ((*VertexItr)->vertexType() == 1 ){
    primVxCand.emplace_back( 1 );
      }else{
    primVxCand.emplace_back( 0 );
      }
      sgkey.emplace_back (m_tracksName.value());
 
      covMatrix.emplace_back(DataType("2 -.1 .5 -.01 0.002 .01"));
 
      //degrees of freedom might be zero - beware
      if ( (*VertexItr)->numberDoF()  != 0 ){
    chi2val = (*VertexItr)->chiSquared()/(*VertexItr)->numberDoF() ;
      }else{
    chi2val = -1.;
      }
      chi2.emplace_back(DataType( chi2val ));
 
      // track-vertex association code in xAOD from Nick Styles, Apr14:
      // InnerDetector/InDetRecAlgs/InDetPriVxFinder/InDetVxLinksToTrackParticles
 
      int trkCnt = 0;
      const std::vector< ElementLink< xAOD::TrackParticleContainer > > tpLinks =  (*VertexItr)->trackParticleLinks();
 
      //iterating over the links
      unsigned int tp_size = tpLinks.size();
      numTracks.emplace_back(DataType( tp_size ));
      if(tp_size){ // links exist
    for(unsigned int tp = 0; tp<tp_size; ++tp)
      {
        ElementLink< xAOD::TrackParticleContainer >  tpl = tpLinks.at(tp);
 
        ATH_MSG_DEBUG("  Vertex #" << counter << " track association index: " << tpl.index()
              << ", collection : "  << tpl.key()
              << ", Tracks : " << tp  << " out of " << tp_size << ", own count: " << trkCnt++);
 
        if ( tpl.index() < 1000 ){ // sanity check, this can be huge number
          tracks.emplace_back(DataType( tpl.index() ));
        }else{
          tracks.emplace_back(DataType( 0 ));
        }
      } //links exist
      }//end of track particle collection size check
 
    } // end VertexIterator
 
      // four-vectors
    DataMap["x"] = x;
    DataMap["y"] = y;
    DataMap["z"] = z;
    DataMap["chi2"] = chi2;
    DataMap["vertexType"] = vertexType;
    DataMap["primVxCand"] = primVxCand;
    DataMap["covMatrix multiple=\"6\""] = covMatrix;
    DataMap["numTracks"] = numTracks;
    DataMap["sgkey"] = sgkey;
 
    //This is needed once we know numTracks and associations:
    //If there had been any tracks, add a tag
    if ((numTracks.size()) != 0){
      //Calculate average number of tracks per vertex
      double NTracksPerVertex = tracks.size()*1./numTracks.size();
      std::string tag = "tracks multiple=\"" +DataType(NTracksPerVertex).toString()+"\"";
      DataMap[tag] = tracks;
    }
 
    ATH_MSG_DEBUG(dataTypeName() << " retrieved with " << x.size() << " entries");
 
    return DataMap;
 
  }

getKeys()

const std::vector< std::string > JiveXML::xAODVertexRetriever::getKeys

(

)

Gets the StoreGate keys for the desired containers.

Definition at line 194 of file xAODVertexRetriever.cxx.

                                                          {
    ATH_MSG_DEBUG("in getKeys()");
    
    std::vector<std::string> keys = {};
    
    // Remove m_primaryVertexKey and m_secondaryVertexKey from m_otherKeys if they  exist, we don't want to write them twice
    auto it = std::find(m_otherKeys.begin(), m_otherKeys.end(), m_primaryVertexKey);
    if(it != m_otherKeys.end()){
      m_otherKeys.erase(it);
    }
    auto it2 = std::find(m_otherKeys.begin(), m_otherKeys.end(), m_secondaryVertexKey);
    if(it2 != m_otherKeys.end()){
      m_otherKeys.erase(it2);
    }
 
    // Add m_primaryVertexKey as the first element and m_secondaryVertexKey as the second if they are not ""
    if(m_primaryVertexKey!=""){
      keys.push_back(m_primaryVertexKey);
    }
    if(m_secondaryVertexKey!=""){
      keys.push_back(m_secondaryVertexKey);
    }
 
    if(!m_otherKeys.empty()){
      keys.insert(keys.end(), m_otherKeys.begin(), m_otherKeys.end());
    }
 
    // If all collections are requested, obtain all available keys from StoreGate
    std::vector<std::string> allKeys;
 
    if(m_doWriteAllCollections){
      evtStore()->keys<xAOD::VertexContainer>(allKeys);
 
      // Add keys that are not the priority key and do not add containers with "HLT" in their name if requested, , and do not contain V0 in their name, if requested
      for(const std::string& key : allKeys){
    // Don't include key if it's already in keys
    auto it2 = std::find(keys.begin(), keys.end(), key);
    if(it2 != keys.end())continue;
    if((key.find("HLT") == std::string::npos || m_doWriteHLT) && (m_doWriteV0 || key.find("V0") == std::string::npos)){
      keys.emplace_back(key);
    }
      }
    }
    return keys;
  }

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 & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

{ return IID_IDataRetriever; }

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

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

retrieve()

StatusCode JiveXML::xAODVertexRetriever::retrieve ( ToolHandle< IFormatTool > &  FormatTool )

virtual

For each Vertex collections retrieve basic parameters.

Parameters

FormatTool

the tool that will create formated output from the DataMap

Implements JiveXML::IDataRetriever.

Definition at line 31 of file xAODVertexRetriever.cxx.

                                                                              {
 
    ATH_MSG_DEBUG("In retrieve()");
 
    std::vector<std::string> keys = getKeys();
 
    if(keys.empty()){
      ATH_MSG_WARNING("No StoreGate keys found");
      return StatusCode::SUCCESS;
    }
 
    // Loop through the keys and retrieve the corresponding data
    for (const std::string& key : keys) {
      SG::ReadHandle<xAOD::VertexContainer> cont(key);
      if (cont.isValid()) {
    DataMap data = getData(&(*cont),key);
    if (FormatTool->AddToEvent(dataTypeName(), key + "_xAOD", &data).isFailure()) {
      ATH_MSG_WARNING("Failed to retrieve Collection " << key);
    } else {
      ATH_MSG_DEBUG(" (" << key << ") retrieved");
    }
      } else {
    ATH_MSG_WARNING("Collection " << key << " not found in SG");
      }
    }
    return StatusCode::SUCCESS;
  }

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.

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_doWriteAllCollections

Gaudi::Property<bool> JiveXML::xAODVertexRetriever::m_doWriteAllCollections {this, "DoWriteAllCollections", false, "Write out all Cluster collections"}

private

Definition at line 61 of file xAODVertexRetriever.h.

m_doWriteHLT

Gaudi::Property<bool> JiveXML::xAODVertexRetriever::m_doWriteHLT {this, "DoWriteHLT", false, "Write out other collections that have HLT in the name"}

private

Definition at line 60 of file xAODVertexRetriever.h.

m_doWriteV0

Gaudi::Property<bool> JiveXML::xAODVertexRetriever::m_doWriteV0 {this, "DoWriteV0", false, "Write out other vertex collections that have V0 in the name"}

private

Definition at line 62 of file xAODVertexRetriever.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_otherKeys

Gaudi::Property<std::vector<std::string> > JiveXML::xAODVertexRetriever::m_otherKeys {this, "OtherVertexCollections", {"BTagging_AntiKt4EMTopoSecVtx"}, "Other collections to be retrieved. If DoWriteAllCollections is set to true all available Vertex collections will be retrieved"}

private

Definition at line 65 of file xAODVertexRetriever.h.

m_primaryVertexKey

Gaudi::Property<std::string> JiveXML::xAODVertexRetriever::m_primaryVertexKey {this,"PrimaryVertexCollection","PrimaryVertices", "Name of the Primary Vertex container"}

private

Definition at line 63 of file xAODVertexRetriever.h.

m_secondaryVertexKey

Gaudi::Property<std::string> JiveXML::xAODVertexRetriever::m_secondaryVertexKey {this,"SecondaryVertexCollection","BTagging_AntiKt4EMPFlowSecVtx", "Name of the Secondary Vertex container"}

private

Definition at line 64 of file xAODVertexRetriever.h.

m_tracksName

Gaudi::Property<std::string> JiveXML::xAODVertexRetriever::m_tracksName {this, "TracksName", "InDetTrackParticles_xAOD", "Name of track container"}

private

Definition at line 66 of file xAODVertexRetriever.h.

m_typeName

const std::string JiveXML::xAODVertexRetriever::m_typeName = "RVx"

private

The data type that is generated by this retriever.

Definition at line 58 of file xAODVertexRetriever.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:

• xAODVertexRetriever.h
• xAODVertexRetriever.cxx