ATLAS Offline Software
|
This is the class for the data preparation pipeline. More...
#include <DataPreparationPipeline.h>
Public Member Functions | |
StatusCode | initialize () override final |
Detect the OpenCL devices and prepare OpenCL context. More... | |
StatusCode | execute (const EventContext &ctx) const override final |
Should be overriden by derived classes to perform meaningful work. More... | |
StatusCode | setupBuffers () |
StatusCode | setupKernelArgs () |
StatusCode | loadProgram (const std::string &xclbin) |
Find the xclbin file and load it into the OpenCL program object. More... | |
StatusCode | precheck (std::vector< Gaudi::Property< std::string >> inputs) const |
Check if the the desired Gaudi properties are set. More... | |
AthReentrantAlgorithm (const std::string &name, ISvcLocator *pSvcLocator) | |
Constructor with parameters: More... | |
virtual StatusCode | sysInitialize () override |
Override sysInitialize. More... | |
virtual bool | isClonable () const override |
Specify if the algorithm is clonable. More... | |
virtual unsigned int | cardinality () const override |
Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More... | |
virtual StatusCode | sysExecute (const EventContext &ctx) override |
Execute an algorithm. More... | |
virtual const DataObjIDColl & | extraOutputDeps () const override |
Return the list of extra output dependencies. More... | |
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 . 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 | 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 |
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... | |
Protected Attributes | |
cl::Device | m_accelerator |
Device object for the accelerator card. More... | |
cl::Context | m_context |
Context object for the application. More... | |
cl::Program | m_program |
Program object containing the kernel. 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 | |
cl::Kernel | m_pixelClusteringKernel |
Kernel for pixel clustering. More... | |
cl::Kernel | m_spacepointKernel |
Kernel for spacepoint. More... | |
cl::Buffer | m_pxlClusteringInBuff |
Buffer for pixel clustering input. More... | |
cl::Buffer | m_pxlClusteringOutBuff |
Buffer for pixel clustering output. More... | |
cl::Buffer | m_spacepointInBuff |
Buffer for spacepoint input. More... | |
cl::Buffer | m_spacepointOutBuff |
Buffer for spacepoint output. More... | |
Gaudi::Property< std::string > | m_xclbin |
Path and name of the xclbin file. More... | |
Gaudi::Property< std::string > | m_passThroughKernelName |
Pass through kernel name. More... | |
Gaudi::Property< std::string > | m_pixelClusteringKernelName |
Pixle clustering kernel name. More... | |
Gaudi::Property< std::string > | m_spacepointKernelName |
Spacepoint kernel name. More... | |
Gaudi::Property< std::string > | m_pixelClusterTVPath |
Pixel cluster test vector. More... | |
Gaudi::Property< std::string > | m_pixelClusterRefTVPath |
Pixel cluster reference test vector. More... | |
Gaudi::Property< std::string > | m_spacepointTVPath |
Spacepoint test vector. More... | |
Gaudi::Property< std::string > | m_spacepointRefTVPath |
Spacepoint reference test vector. More... | |
Gaudi::Property< bool > | m_usePassThrough |
Use the pass through tool instead of data prep pipeline. More... | |
Gaudi::Property< bool > | m_useTV {this, "UseTV", false, "Use test vector"} |
Use test vector. More... | |
ToolHandle< xAODContainerMaker > | m_xAODContainerMaker |
Tool handle for xAODContainerMaker. More... | |
ToolHandle< PassThroughTool > | m_passThroughTool |
Tool handle for PassThroughTool. More... | |
ToolHandle< TestVectorTool > | m_testVectorTool |
Tool handle for TestVectorTool. More... | |
DataObjIDColl | m_extendedExtraObjects |
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More... | |
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 |
This is the class for the data preparation pipeline.
The output of this pipeline are the xAOD::StripCluster(Container) and xAOD::PixelCluster(Container). These containers are to be used in other CPU-based algorithms.
Definition at line 36 of file DataPreparationPipeline.h.
|
privateinherited |
Definition at line 388 of file AthCommonDataStore.h.
|
inherited |
|
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.
Override this to return 0 for reentrant algorithms.
Definition at line 55 of file AthReentrantAlgorithm.cxx.
|
inlineprivateinherited |
specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
Definition at line 170 of file AthCommonDataStore.h.
|
inlineprivateinherited |
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
|
inlineprivateinherited |
specialization for handling Gaudi::Property<SG::VarHandleBase>
Definition at line 184 of file AthCommonDataStore.h.
|
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.
|
inlineinherited |
Declare a new Gaudi property.
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.
|
inlineinherited |
Declare a new Gaudi property.
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.
|
inlineinherited |
Definition at line 259 of file AthCommonDataStore.h.
|
inlineinherited |
Declare a new Gaudi property.
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.
|
inlineinherited |
Declare a new Gaudi property.
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.
|
inlineinherited |
Definition at line 145 of file AthCommonDataStore.h.
|
inlineinherited |
The standard StoreGateSvc/DetectorStore
Returns (kind of) a pointer to the StoreGateSvc
.
Definition at line 95 of file AthCommonDataStore.h.
|
inlineinherited |
The standard StoreGateSvc
(event store) Returns (kind of) a pointer to the StoreGateSvc
.
Definition at line 85 of file AthCommonDataStore.h.
|
inlineinherited |
The standard StoreGateSvc
(event store) Returns (kind of) a pointer to the StoreGateSvc
.
Definition at line 90 of file AthCommonDataStore.h.
|
finaloverridevirtual |
Should be overriden by derived classes to perform meaningful work.
Reimplemented from IntegrationBase.
Definition at line 66 of file DataPreparationPipeline.cxx.
|
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
|
overridevirtualinherited |
Return the list of extra output dependencies.
This list is extended to include symlinks implied by inheritance relations.
Definition at line 79 of file AthReentrantAlgorithm.cxx.
|
inlinevirtualinherited |
Definition at line 135 of file AthReentrantAlgorithm.h.
|
finaloverridevirtual |
Detect the OpenCL devices and prepare OpenCL context.
This should always be called by derived classes when running on the FPGA accelerator.
Reimplemented from IntegrationBase.
Definition at line 17 of file DataPreparationPipeline.cxx.
|
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.
|
overridevirtualinherited |
Specify if the algorithm is clonable.
Reentrant algorithms are clonable.
Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, InDet::SiSPGNNTrackMaker, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, ITkStripCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.
Definition at line 44 of file AthReentrantAlgorithm.cxx.
|
inherited |
Find the xclbin file and load it into the OpenCL program object.
Definition at line 82 of file IntegrationBase.cxx.
|
inlineinherited |
Definition at line 24 of file AthCommonMsg.h.
|
inlineinherited |
Definition at line 27 of file AthCommonMsg.h.
|
inlineinherited |
Definition at line 30 of file AthCommonMsg.h.
|
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.
|
inherited |
Check if the the desired Gaudi properties are set.
Definition at line 121 of file IntegrationBase.cxx.
|
inlineprotectedinherited |
Definition at line 380 of file AthCommonDataStore.h.
|
inlineprotectedinherited |
remove all handles from I/O resolution
Definition at line 364 of file AthCommonDataStore.h.
|
inlinevirtualinherited |
Definition at line 139 of file AthReentrantAlgorithm.h.
StatusCode DataPreparationPipeline::setupBuffers | ( | ) |
Definition at line 142 of file DataPreparationPipeline.cxx.
StatusCode DataPreparationPipeline::setupKernelArgs | ( | ) |
Definition at line 180 of file DataPreparationPipeline.cxx.
|
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 67 of file AthReentrantAlgorithm.cxx.
|
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
Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.
Reimplemented in InputMakerBase, and HypoBase.
Definition at line 96 of file AthReentrantAlgorithm.cxx.
|
overridevirtualinherited |
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
|
inlineinherited |
Definition at line 308 of file AthCommonDataStore.h.
|
protectedinherited |
Device object for the accelerator card.
Definition at line 66 of file IntegrationBase.h.
|
protectedinherited |
Context object for the application.
Definition at line 67 of file IntegrationBase.h.
|
privateinherited |
Pointer to StoreGate (detector store by default)
Definition at line 393 of file AthCommonDataStore.h.
|
privateinherited |
Pointer to StoreGate (event store by default)
Definition at line 390 of file AthCommonDataStore.h.
|
privateinherited |
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
Empty if no symlinks were found.
Definition at line 153 of file AthReentrantAlgorithm.h.
|
private |
Pass through kernel name.
Definition at line 61 of file DataPreparationPipeline.h.
|
private |
Tool handle for PassThroughTool.
Definition at line 93 of file DataPreparationPipeline.h.
|
private |
Kernel for pixel clustering.
Definition at line 48 of file DataPreparationPipeline.h.
|
private |
Pixle clustering kernel name.
Definition at line 64 of file DataPreparationPipeline.h.
|
private |
Pixel cluster reference test vector.
Definition at line 74 of file DataPreparationPipeline.h.
|
private |
Pixel cluster test vector.
Definition at line 72 of file DataPreparationPipeline.h.
|
protectedinherited |
Program object containing the kernel.
Definition at line 68 of file IntegrationBase.h.
|
private |
Buffer for pixel clustering input.
Definition at line 51 of file DataPreparationPipeline.h.
|
private |
Buffer for pixel clustering output.
Definition at line 52 of file DataPreparationPipeline.h.
|
private |
Buffer for spacepoint input.
Definition at line 54 of file DataPreparationPipeline.h.
|
private |
Kernel for spacepoint.
Definition at line 49 of file DataPreparationPipeline.h.
|
private |
Spacepoint kernel name.
Definition at line 67 of file DataPreparationPipeline.h.
|
private |
Buffer for spacepoint output.
Definition at line 55 of file DataPreparationPipeline.h.
|
private |
Spacepoint reference test vector.
Definition at line 79 of file DataPreparationPipeline.h.
|
private |
Spacepoint test vector.
Definition at line 77 of file DataPreparationPipeline.h.
|
private |
Tool handle for TestVectorTool.
Definition at line 97 of file DataPreparationPipeline.h.
|
private |
Use the pass through tool instead of data prep pipeline.
It can be either sw or hw, setting in the tool
Definition at line 83 of file DataPreparationPipeline.h.
|
private |
Use test vector.
Definition at line 86 of file DataPreparationPipeline.h.
|
privateinherited |
Definition at line 399 of file AthCommonDataStore.h.
|
privateinherited |
Definition at line 398 of file AthCommonDataStore.h.
|
private |
Tool handle for xAODContainerMaker.
Definition at line 89 of file DataPreparationPipeline.h.
|
private |
Path and name of the xclbin file.
Definition at line 58 of file DataPreparationPipeline.h.