#include <InDetPRD_Provider.h>

Inheritance diagram for InDet::InDetPRD_Provider:

Public Member Functions
	InDetPRD_Provider (const std::string &t, const std::string &n, const IInterface *p)
StatusCode	initialize ()
	Athena algtool's Hooks.
StatusCode	finalize ()
	finalize
const Trk::PrepRawData *	prdFromIdentifier (const Identifier &ide, size_t &ndof) const
	return the Prd given the Identifier - make a HashId out of the Id and return the associated PRD
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 ()
	AlgTool interface methods.

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
template<class PrdT>
const Trk::PrepRawData *	prdFromIdentifierContainer (const Trk::PrepRawDataContainer< Trk::PrepRawDataCollection< PrdT > > &cont, const Identifier &ideh, const IdentifierHash &ideHash) const
	templated method since used for Pixel/SCT/TRT
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const AtlasDetectorID *	m_idHelper
const PixelID *	m_pixIdHelper
	Helper to detect type of sub-detector from PRD->identify().
SG::ReadHandleKey< PixelClusterContainer >	m_pixClusterContainerKey {this, "PixelClusterContainer", ""}
SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollection >	m_pixelDetEleCollKey {this, "PixelDetEleCollKey", "PixelDetectorElementCollection", "Key of SiDetectorElementCollection for Pixel"}
const SCT_ID *	m_sctIdHelper
SG::ReadHandleKey< SCT_ClusterContainer >	m_sctClusterContainerKey {this, "SCT_ClusterContainer", ""}
SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollection >	m_SCTDetEleCollKey {this, "SCTDetEleCollKey", "SCT_DetectorElementCollection", "Key of SiDetectorElementCollection for SCT"}
const TRT_ID *	m_trtIdHelper
SG::ReadHandleKey< TRT_DriftCircleContainer >	m_trtDriftCircleContainerKey {this, "TRT_DriftCircleContainer", ""}
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

Definition at line 45 of file InDetPRD_Provider.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

◆ InDetPRD_Provider()

InDet::InDetPRD_Provider::InDetPRD_Provider	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 26 of file InDetPRD_Provider.cxx.

                                                                                                    :
  AthAlgTool(t,n,p),
  m_idHelper(nullptr),
  m_pixIdHelper(nullptr),
  m_sctIdHelper(nullptr),
  m_trtIdHelper(nullptr)
{
    declareInterface<Trk::IPRD_Provider>(this);
}

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

◆ 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

◆ finalize()

StatusCode InDet::InDetPRD_Provider::finalize ( )

finalize

Definition at line 62 of file InDetPRD_Provider.cxx.

{
     ATH_MSG_VERBOSE("Finalizing ...");
     return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode InDet::InDetPRD_Provider::initialize ( )

Athena algtool's Hooks.

Definition at line 37 of file InDetPRD_Provider.cxx.

{
     ATH_MSG_VERBOSE("Initializing ...");           
     // Set up ATLAS ID helper to be able to identify the PRD's det-subsystem
     ATH_CHECK(detStore()->retrieve(m_idHelper, "AtlasID"));
     // Get Pixel helpers                                                                                                                         
     ATH_CHECK(detStore()->retrieve(m_pixIdHelper, "PixelID"));
     // Get SCT helpers                                                                                                                         
     ATH_CHECK(detStore()->retrieve(m_sctIdHelper, "SCT_ID"));
     // Get TRT helpers
     ATH_CHECK(detStore()->retrieve(m_trtIdHelper, "TRT_ID"));
 
     ATH_CHECK(m_pixClusterContainerKey.initialize
           (!m_pixClusterContainerKey.key().empty()));
     ATH_CHECK(m_sctClusterContainerKey.initialize
           (!m_sctClusterContainerKey.key().empty()));
     ATH_CHECK(m_trtDriftCircleContainerKey.initialize
           (!m_trtDriftCircleContainerKey.key().empty()));
 
     ATH_CHECK(m_pixelDetEleCollKey.initialize());
     ATH_CHECK(m_SCTDetEleCollKey.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 & Trk::IPRD_Provider::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 40 of file IPRD_Provider.h.

40{ return IID_IPRD_Provider; }

Trk::IID_IPRD_Provider

static const InterfaceID IID_IPRD_Provider("IPRD_Provider", 1, 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.

◆ prdFromIdentifier()

const Trk::PrepRawData * InDet::InDetPRD_Provider::prdFromIdentifier	(	const Identifier &	ide,
		size_t &	ndof ) const

virtual

return the Prd given the Identifier - make a HashId out of the Id and return the associated PRD

Implements Trk::IPRD_Provider.

Definition at line 69 of file InDetPRD_Provider.cxx.

                                                                                                          {
 
    // check validity of the Identifier
    if (!ide.is_valid()){
        ATH_MSG_VERBOSE("The identifier is not valid ! Return 0.");
        return nullptr;
    }
 
    // is pixel case 
    if ( m_idHelper->is_pixel(ide) && !m_pixClusterContainerKey.key().empty() ){
 
        SG::ReadHandle<PixelClusterContainer> pixClusterContainer(m_pixClusterContainerKey);
        if(!pixClusterContainer.isValid())
          ATH_MSG_ERROR("Invalid PixelClusterContainer");
 
        ndof = 2;
        // get the Identifier Hash
        Identifier idewafer =  m_pixIdHelper->wafer_id(ide);
        IdentifierHash ideHash = m_pixIdHelper->wafer_hash(idewafer);
        ATH_MSG_VERBOSE("Pixel Identifier found as transformed to hash identifier " << (unsigned int)ideHash );
        if (!ideHash.is_valid()){
          ATH_MSG_VERBOSE("The hash identifier is not valid ! Return 0.");
          return nullptr;
        }
        return prdFromIdentifierContainer<InDet::PixelCluster>(*pixClusterContainer,ide,ideHash);
    }
 
    if ( m_idHelper->is_sct(ide) && !m_sctClusterContainerKey.key().empty() ){
        SG::ReadHandle<SCT_ClusterContainer> sctClusterContainer(m_sctClusterContainerKey);
        if(!sctClusterContainer.isValid())
          ATH_MSG_ERROR("Invalid SCT_ClusterContainer");
 
        // get the Identifier Hash
        ndof = 1;
        Identifier idewafer =  m_sctIdHelper->wafer_id(ide);
        IdentifierHash ideHash = m_sctIdHelper->wafer_hash(idewafer);
        ATH_MSG_VERBOSE("SCT Identifier found as transformed to hash identifier " << (unsigned int)ideHash );
        if (!ideHash.is_valid()){
          ATH_MSG_VERBOSE("The hash identifier is not valid ! Return 0.");
          return nullptr;
        }
        return prdFromIdentifierContainer<InDet::SCT_Cluster>(*sctClusterContainer,ide,ideHash);
    }
 
    if ( m_idHelper->is_trt(ide) && !m_trtDriftCircleContainerKey.key().empty() ){
        SG::ReadHandle<TRT_DriftCircleContainer> trtDriftCircleContainer(m_trtDriftCircleContainerKey);
        if(!trtDriftCircleContainer.isValid())
          ATH_MSG_ERROR("Invalid TRT_DriftCircleContainer");
 
        // get the Identifier Hash
        ndof = 1;
        Identifier idestrawlayer  = m_trtIdHelper->layer_id(m_trtIdHelper->barrel_ec(ide),
                                                            m_trtIdHelper->phi_module(ide),
                                                            m_trtIdHelper->layer_or_wheel(ide),
                                                            m_trtIdHelper->straw_layer(ide));
        IdentifierHash ideHash = m_trtIdHelper->straw_layer_hash(idestrawlayer); 
        ATH_MSG_VERBOSE("TRT Identifier found as transformed to hash identifier " << (unsigned int)ideHash );
        if (!ideHash.is_valid()){
          ATH_MSG_VERBOSE("The hash identifier is not valid ! Return 0.");
          return nullptr;
        }
        return prdFromIdentifierContainer<InDet::TRT_DriftCircle>(*trtDriftCircleContainer,ide,ideHash);
    }
    return nullptr;
}

◆ prdFromIdentifierContainer()

template<class PrdT>

const Trk::PrepRawData * InDet::InDetPRD_Provider::prdFromIdentifierContainer	(	const Trk::PrepRawDataContainer< Trk::PrepRawDataCollection< PrdT > > &	cont,
		const Identifier &	ideh,
		const IdentifierHash &	ideHash ) const

inlineprivate

templated method since used for Pixel/SCT/TRT

Definition at line 62 of file InDetPRD_Provider.h.

        {
          // find the collection
          const Trk::PrepRawDataCollection< PrdT >* prdCollection = cont.indexFindPtr(ideHash);
          if ( prdCollection == nullptr ){
              ATH_MSG_VERBOSE("PRD Collection to IdentifierHash could not be found. Return 0.");
              return 0;
          }
          // search for the PRD in the collection --- do a loop, can be done better with std::find probably
          const PrdT* prd = 0;
          // iterate through the collections
          typename Trk::PrepRawDataCollection< PrdT >::const_iterator prdIter  = prdCollection->begin();
          typename Trk::PrepRawDataCollection< PrdT >::const_iterator prdIterE = prdCollection->end();
          for ( ; prdIter != prdIterE; ++prdIter ){
              if ( (*prdIter)->identify() == ideh ){
                  prd = (*prdIter);
                  break;
              }
          }
          // return what you have
          return prd;
        }

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

const AtlasDetectorID* InDet::InDetPRD_Provider::m_idHelper

private

Definition at line 87 of file InDetPRD_Provider.h.

◆ m_pixClusterContainerKey

SG::ReadHandleKey<PixelClusterContainer> InDet::InDetPRD_Provider::m_pixClusterContainerKey {this, "PixelClusterContainer", ""}

private

Definition at line 90 of file InDetPRD_Provider.h.

91{this, "PixelClusterContainer", ""};

◆ m_pixelDetEleCollKey

SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> InDet::InDetPRD_Provider::m_pixelDetEleCollKey {this, "PixelDetEleCollKey", "PixelDetectorElementCollection", "Key of SiDetectorElementCollection for Pixel"}

private

Definition at line 93 of file InDetPRD_Provider.h.

93{this, "PixelDetEleCollKey", "PixelDetectorElementCollection", "Key of SiDetectorElementCollection for Pixel"};

◆ m_pixIdHelper

const PixelID* InDet::InDetPRD_Provider::m_pixIdHelper

private

Helper to detect type of sub-detector from PRD->identify().

Definition at line 89 of file InDetPRD_Provider.h.

◆ m_sctClusterContainerKey

SG::ReadHandleKey<SCT_ClusterContainer> InDet::InDetPRD_Provider::m_sctClusterContainerKey {this, "SCT_ClusterContainer", ""}

private

Definition at line 96 of file InDetPRD_Provider.h.

97{this, "SCT_ClusterContainer", ""};

◆ m_SCTDetEleCollKey

SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> InDet::InDetPRD_Provider::m_SCTDetEleCollKey {this, "SCTDetEleCollKey", "SCT_DetectorElementCollection", "Key of SiDetectorElementCollection for SCT"}

private

Definition at line 99 of file InDetPRD_Provider.h.

99{this, "SCTDetEleCollKey", "SCT_DetectorElementCollection", "Key of SiDetectorElementCollection for SCT"};

◆ m_sctIdHelper

const SCT_ID* InDet::InDetPRD_Provider::m_sctIdHelper

private

Definition at line 95 of file InDetPRD_Provider.h.

◆ m_trtDriftCircleContainerKey

SG::ReadHandleKey<TRT_DriftCircleContainer> InDet::InDetPRD_Provider::m_trtDriftCircleContainerKey {this, "TRT_DriftCircleContainer", ""}

private

Definition at line 102 of file InDetPRD_Provider.h.

103{this, "TRT_DriftCircleContainer", ""};

◆ m_trtIdHelper

const TRT_ID* InDet::InDetPRD_Provider::m_trtIdHelper

private

Definition at line 101 of file InDetPRD_Provider.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

◆ InDetPRD_Provider()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ prdFromIdentifier()

◆ prdFromIdentifierContainer()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_idHelper

◆ m_pixClusterContainerKey

◆ m_pixelDetEleCollKey

◆ m_pixIdHelper

◆ m_sctClusterContainerKey

◆ m_SCTDetEleCollKey

◆ m_sctIdHelper

◆ m_trtDriftCircleContainerKey

◆ m_trtIdHelper

◆ m_varHandleArraysDeclared

◆ m_vhka