Retrieves all Trk::SegmentCollection objects. More...

#include <SegmentRetriever.h>

Inheritance diagram for JiveXML::SegmentRetriever:

Collaboration diagram for JiveXML::SegmentRetriever:

Public Member Functions
	SegmentRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
virtual StatusCode	initialize ()
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	Retrieve all the data.
virtual std::string	dataTypeName () const
	Return the name of the data type.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

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

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
const std::string	m_typeName = "Segment"
	The data type that is generated by this retriever.
SG::ReadHandleKeyArray< Trk::SegmentCollection >	m_keys {this,"SegmentCollections",{"NCB_TrackMuonSegments","TrackMuonNSWSegments","UnAssocMuonTrkSegments","TrkMuonSegments"}, "Name of the Segment containers that will be written out to the JiveXML file"}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Retrieves all Trk::SegmentCollection objects.

Properties
- none
Retrieved Data
- x,y,z: coordinates of segment starting point
- eta,phi: segment direction
- NHits: number of hits associated with this segment
- hits: ID of hits associated with this segment

Definition at line 28 of file SegmentRetriever.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

◆ SegmentRetriever()

JiveXML::SegmentRetriever::SegmentRetriever	(	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 21 of file SegmentRetriever.cxx.

21 :

22 AthAlgTool(type,name,parent){}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

Member Function Documentation

◆ dataTypeName()

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

inlinevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 42 of file SegmentRetriever.h.

42{ return m_typeName; };

JiveXML::SegmentRetriever::m_typeName

const std::string m_typeName

The data type that is generated by this retriever.

Definition SegmentRetriever.h:46

◆ declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

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

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

◆ initialize()

StatusCode JiveXML::SegmentRetriever::initialize ( )

virtual

Definition at line 25 of file SegmentRetriever.cxx.

                                         {
    ATH_CHECK(m_keys.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.

◆ interfaceID()

const InterfaceID & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

40{ return IID_IDataRetriever; }

JiveXML::IID_IDataRetriever

static const InterfaceID IID_IDataRetriever("JiveXML::IDataRetriever", 3, 0)

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

◆ renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ retrieve()

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

virtual

Retrieve all the data.

For each segement collections retrieve all data.

loop over segments in all collections
for each segment get basic coordinates
for each segment try to obtain hits and add as multiple collection
Parameters

FormatTool the tool that will create formated output from the DataMap

Implements JiveXML::IDataRetriever.

Definition at line 38 of file SegmentRetriever.cxx.

                                                                           {
    
    ATH_MSG_DEBUG("Retrieving " << dataTypeName()); 
 
    for( const auto& key : m_keys ) {
      SG::ReadHandle<Trk::SegmentCollection > cont(key);
      if (cont.isValid()) {
 
    //Get number of segments in this collection
    Trk::SegmentCollection::size_type NSegs=cont.cptr()->size();
 
    //Define the data vectors we want to fill and create space
    DataVect x; x.reserve(NSegs);
    DataVect y; y.reserve(NSegs);
    DataVect z; z.reserve(NSegs);
    DataVect phi; phi.reserve(NSegs);
    DataVect theta; theta.reserve(NSegs);
    DataVect numHits; numHits.reserve(NSegs);
    DataVect hits;
      
    //Loop over the segments
    Trk::SegmentCollection::const_iterator SegmentItr;
    for (SegmentItr=cont.cptr()->begin(); SegmentItr!=cont.cptr()->end(); ++SegmentItr) {
        
      //Retrieve primitive variables
      x.emplace_back((*SegmentItr)->globalPosition().x()/10.);
      y.emplace_back((*SegmentItr)->globalPosition().y()/10.);
      z.emplace_back((*SegmentItr)->globalPosition().z()/10.);
      phi.emplace_back((*SegmentItr)->localParameters()[Trk::phi]);
      theta.emplace_back((*SegmentItr)->localParameters()[Trk::theta]);
 
      //Count number of valid (non-null) RIO_OnTracks
      int NRoTs = 0;
      //Reserve space for expected number
      hits.reserve(hits.size()+(*SegmentItr)->containedMeasurements().size());
 
      //Loop over segment measurments
      std::vector< const Trk::MeasurementBase * >::const_iterator measItr, measEnd;
      measItr=(*SegmentItr)->containedMeasurements().begin();
      measEnd=(*SegmentItr)->containedMeasurements().end();
 
      //Now loop over measurements
      for (; measItr!=measEnd; ++measItr) {
          
        //dynamic_cast to RIO_OnTrack - will return NULL if not a RIO_OnTrack object
        const Trk::RIO_OnTrack *RoT = dynamic_cast<const Trk::RIO_OnTrack*>(*measItr);  
 
        //Ignore failed dynamic_casts
        if (!RoT) continue ;
 
        //Add the hit
        hits.emplace_back(RoT->identify().get_compact() );
        //count as valid
        NRoTs++;
      }
 
      //Store number of hits for this segement
      numHits.emplace_back(NRoTs);
    }
 
    //Add data to our map
    DataMap DataMap;
    DataMap["x"] = x;
    DataMap["y"] = y;
    DataMap["z"] = z;
    DataMap["phi"] = phi;
    DataMap["theta"] = theta;
    DataMap["numHits"] = numHits;
 
    //Hits are stored as multiple with average size given in XML header
    if (NSegs > 0) {
      std::string multiple = "hits multiple=\"" + DataType( hits.size()*1./numHits.size()).toString() + "\"";
      DataMap[multiple] = hits;
    }
    
    //forward data to formating tool
    if ( FormatTool->AddToEvent(dataTypeName(), key.key(), &DataMap).isFailure())
      return StatusCode::RECOVERABLE;
      
    ATH_MSG_DEBUG(dataTypeName() << " collection " << key << " retrieved with " << NSegs << " entries");
    
      }
      else{
    ATH_MSG_WARNING("Collection " << key << " not found in SG ");
      }
    }
  
    //All collections retrieved - done
    return StatusCode::SUCCESS;
 
  } // retrieve

◆ 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_keys

SG::ReadHandleKeyArray<Trk::SegmentCollection> JiveXML::SegmentRetriever::m_keys {this,"SegmentCollections",{"NCB_TrackMuonSegments","TrackMuonNSWSegments","UnAssocMuonTrkSegments","TrkMuonSegments"}, "Name of the Segment containers that will be written out to the JiveXML file"}

private

Definition at line 48 of file SegmentRetriever.h.

48{this,"SegmentCollections",{"NCB_TrackMuonSegments","TrackMuonNSWSegments","UnAssocMuonTrkSegments","TrkMuonSegments"}, "Name of the Segment containers that will be written out to the JiveXML file"};

◆ m_typeName

const std::string JiveXML::SegmentRetriever::m_typeName = "Segment"

private

The data type that is generated by this retriever.

Definition at line 46 of file SegmentRetriever.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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ SegmentRetriever()

Member Function Documentation

◆ dataTypeName()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ retrieve()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_keys

◆ m_typeName

◆ m_varHandleArraysDeclared

◆ m_vhka