#include <CollectionDataPreparationAlg.h>

Inheritance diagram for ActsTrk::PixelClusterDataPreparationAlg:

Collaboration diagram for ActsTrk::PixelClusterDataPreparationAlg:

Public Types
using	object_t
using	input_collection_t
using	output_collection_t
using	cache_read_handle_key_t
using	cache_read_handle_t

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) const override
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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	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

Protected Member Functions
virtual StatusCode	fetchIdHashes (const EventContext &ctx, std::set< IdentifierHash > &hashes) const
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
enum	EStat
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual xAOD::DetectorIDHashType	retrieveDetectorIDHash (const xAOD::PixelCluster &obj) const override
StatusCode	fill (const EventContext &ctx, output_collection_t &outputCollection) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::array< std::atomic< unsigned int >, kNStat > m_stat	ATLAS_THREAD_SAFE
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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 28 of file CollectionDataPreparationAlg.h.

Member Typedef Documentation

◆ cache_read_handle_key_t

using ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::cache_read_handle_key_t

inherited

Definition at line 38 of file DataPreparationAlg.h.

◆ cache_read_handle_t

using ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::cache_read_handle_t

inherited

Definition at line 39 of file DataPreparationAlg.h.

◆ input_collection_t

using ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::input_collection_t

inherited

Definition at line 35 of file DataPreparationAlg.h.

◆ object_t

using ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::object_t

inherited

Definition at line 34 of file DataPreparationAlg.h.

◆ output_collection_t

using ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::output_collection_t

inherited

Definition at line 36 of file DataPreparationAlg.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ EStat

enum ActsTrk::DataPreparationAlg::EStat

privateinherited

Definition at line 90 of file DataPreparationAlg.h.

               {
      kNInputs,
      kNOutputs,
      kNStat
    };

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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; }

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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; }

◆ execute()

virtual StatusCode ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::execute ( const EventContext & ctx ) const

overridevirtualinherited

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

◆ fetchIdHashes()

virtual StatusCode ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::fetchIdHashes	(	const EventContext &	ctx,
		std::set< IdentifierHash > &	hashes ) const

protectedvirtualinherited

◆ fill()

StatusCode ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::fill	(	const EventContext &	ctx,
		output_collection_t &	outputCollection ) const

privateinherited

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

◆ finalize()

virtual StatusCode ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::finalize ( )

overridevirtualinherited

◆ initialize()

virtual StatusCode ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::initialize ( )

overridevirtualinherited

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

◆ isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

◆ msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ retrieveDetectorIDHash()

virtual xAOD::DetectorIDHashType ActsTrk::PixelClusterDataPreparationAlg::retrieveDetectorIDHash ( const xAOD::PixelCluster & obj ) const

overrideprivatevirtual

Reimplemented from ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, false >.

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                               {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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

◆ ATLAS_THREAD_SAFE

std::array<std::atomic<unsigned int>, kNStat> m_stat ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::ATLAS_THREAD_SAFE

mutableprivateinherited

Definition at line 96 of file DataPreparationAlg.h.

96{};

◆ m_detEleCollKey

SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollection > ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::m_detEleCollKey

protectedinherited

Definition at line 71 of file DataPreparationAlg.h.

71 {this, "DetectorElements", "",

72 "Key of input DetectorElementCollection"};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_inputCollectionKey

SG::ReadHandleKey< input_collection_t > ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::m_inputCollectionKey

protectedinherited

Definition at line 74 of file DataPreparationAlg.h.

74 {this, "InputCollection", "",

75 "Input Collection that will go throug selection process"};

◆ m_inputIdentifiableContainer

cache_read_handle_key_t ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::m_inputIdentifiableContainer

protectedinherited

Definition at line 86 of file DataPreparationAlg.h.

86 {this, "InputIDC", "",

87 "The input IDC container"};

◆ m_inputPrdMap

SG::ReadHandleKey< ActsTrk::PrepRawDataAssociation > ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::m_inputPrdMap

protectedinherited

Definition at line 80 of file DataPreparationAlg.h.

80 {this, "InputPrdMap", "",

81 "Map of used measurements from previous tracking pass"};

◆ m_monTool

ToolHandle< GenericMonitoringTool > ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::m_monTool

protectedinherited

Definition at line 65 of file DataPreparationAlg.h.

65 {this, "MonTool", "",

66 "Monitoring tool"};

◆ m_outputCollectionKey

SG::WriteHandleKey< output_collection_t > ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::m_outputCollectionKey

protectedinherited

Definition at line 83 of file DataPreparationAlg.h.

83 {this, "OutputCollection", "",

84 "Output Collection - result of the selection process"};

◆ m_regionSelector

ToolHandle<IRegSelTool> ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::m_regionSelector

protectedinherited

Definition at line 68 of file DataPreparationAlg.h.

68 {this, "RegSelTool", "",

69 "Region selector tool"};

◆ m_roiCollectionKey

SG::ReadHandleKey< TrigRoiDescriptorCollection > ActsTrk::DataPreparationAlg< xAOD::PixelClusterContainer, InDetDD::SiDetectorElementCollection, useCache >::m_roiCollectionKey

protectedinherited

Definition at line 77 of file DataPreparationAlg.h.

77 {this, "RoIs", "",

78 "RoIs to read in"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

CollectionDataPreparationAlg.h

Protected Attributes
ToolHandle< GenericMonitoringTool >	m_monTool
ToolHandle< IRegSelTool >	m_regionSelector
SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollection >	m_detEleCollKey
SG::ReadHandleKey< input_collection_t >	m_inputCollectionKey
SG::ReadHandleKey< TrigRoiDescriptorCollection >	m_roiCollectionKey
SG::ReadHandleKey< ActsTrk::PrepRawDataAssociation >	m_inputPrdMap
SG::WriteHandleKey< output_collection_t >	m_outputCollectionKey
cache_read_handle_key_t	m_inputIdentifiableContainer

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ cache_read_handle_key_t

◆ cache_read_handle_t

◆ input_collection_t

◆ object_t

◆ output_collection_t

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ EStat

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fetchIdHashes()

◆ fill()

◆ filterPassed()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ retrieveDetectorIDHash()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_detEleCollKey

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputCollectionKey

◆ m_inputIdentifiableContainer

◆ m_inputPrdMap

◆ m_monTool

◆ m_outputCollectionKey

◆ m_regionSelector

◆ m_roiCollectionKey

◆ m_varHandleArraysDeclared

◆ m_vhka