#include <HitfinderChain.h>

Inheritance diagram for cbm::algo::sts::HitfinderChain:

Collaboration diagram for cbm::algo::sts::HitfinderChain:

Classes
struct	DigiMap

struct	Result

Public Member Functions
void	SetParameters (const HitfinderChainPars &parameters)

const HitfinderChainPars &	GetParameters () const

void	Finalize ()

Result	operator() (gsl::span< const CbmStsDigi >, bool storeClusters=false)

const ChainContext *	GetContext ()

void	SetContext (const ChainContext *ctx)

const Options &	Opts () const

const RecoParams &	Params () const

bool	HasMonitor () const

Monitor &	GetMonitor () const

Private Member Functions
void	EnsureParameters ()

void	AllocateStatic ()

void	AllocateDynamic (size_t, size_t)

DigiMap	CountDigisPerModules (gsl::span< const CbmStsDigi > digis)

void	FlattenDigis (gsl::span< const CbmStsDigi > digis, DigiMap &digiMap)

PartitionedSpan< sts::Hit >	FlattenHits (xpu::queue)

PartitionedVector< sts::Cluster >	FlattenClusters (xpu::queue)

size_t	GetNHits (xpu::h_view< PaddedToCacheLine< int > > nHitsPerModule, int module)
	Returns the number of hits of a module.

PartitionedSpan< sts::Hit >	SplitHitsIntoStreams (PartitionedSpan< sts::Hit > hits, int nstreamsMax)

void	SortHitsWithinPartition (PartitionedSpan< sts::Hit > hits)

void	EnsureDigiOffsets (DigiMap &)

void	EnsureDigisSorted ()

void	EnsureChannelOffsets (gsl::span< u32 >)

void	EnsureClustersSane (gsl::span< ClusterIdx >, gsl::span< PaddedToCacheLine< int > >)

void	EnsureClustersSorted ()

void	EnsureHitsSorted (PartitionedSpan< sts::Hit >)

Private Attributes
std::optional< sts::HitfinderChainPars >	fPars

Hitfinder	fHitfinder

std::vector< u32 >	fAddresses

std::vector< size_t >	fHitOffsets

std::vector< u32 >	fStreamAddresses

std::vector< size_t >	fHitStreamOffsets

const ChainContext *	fContext = nullptr

Static Private Attributes
static constexpr u16	InvalidModule = 0xFFFF

Detailed Description

Sts Hitfinder Chain. This class is responsible for all memory allocations on the GPU required by the hitfinder. It executes the hitfinder kernels and handles memory transfer for input / output data and conversion to the regular CBM STS types.

Definition at line 46 of file HitfinderChain.h.

Member Function Documentation

◆ AllocateDynamic()

void sts::HitfinderChain::AllocateDynamic	(	size_t	maxNDigisPerModule,
		size_t	nDigisTotal )

private

Allocate memory that depends on input Data stays on GPU until next timeslice is processed

Definition at line 346 of file HitfinderChain.cxx.

References EnsureParameters(), fHitfinder, fPars, and L_.

Referenced by operator()(), and SetParameters().

◆ AllocateStatic()

void sts::HitfinderChain::AllocateStatic ( )

private

Allocate memory that doesn't depend on input Data stays on GPU for the entire duration the hitfinder is alive

Definition at line 283 of file HitfinderChain.cxx.

References EnsureParameters(), fHitfinder, and fPars.

Referenced by SetParameters().

◆ CountDigisPerModules()

sts::HitfinderChain::DigiMap sts::HitfinderChain::CountDigisPerModules ( gsl::span< const CbmStsDigi > digis )

private

Count Digis per module.

Definition at line 399 of file HitfinderChain.cxx.

References cbm::algo::sts::HitfinderChain::DigiMap::addrToIndex, CBM_OMP, CBM_PARALLEL, fPars, cbm::algo::openmp::GetMaxThreads(), cbm::algo::openmp::GetThreadNum(), InvalidModule, L_, cbm::algo::sts::HitfinderChain::DigiMap::maxNDigisPerModule, cbm::algo::sts::HitfinderChain::DigiMap::ModuleIndex(), cbm::algo::sts::HitfinderChain::DigiMap::nDigisPerModule, cbm::algo::sts::HitfinderChain::DigiMap::nDigisPerThread, CbmStsAddress::PackDigiAddress(), and v.

Referenced by operator()().

◆ EnsureChannelOffsets()

void sts::HitfinderChain::EnsureChannelOffsets ( gsl::span< u32 > channelOffsetsByModule )

private

Definition at line 780 of file HitfinderChain.cxx.

References fHitfinder, and fPars.

Referenced by operator()().

◆ EnsureClustersSane()

void sts::HitfinderChain::EnsureClustersSane	(	gsl::span< ClusterIdx >	hClusterIdx,
		gsl::span< PaddedToCacheLine< int > >	hNClusters )

private

Definition at line 823 of file HitfinderChain.cxx.

References fHitfinder, fPars, and L_.

Referenced by operator()().

◆ EnsureClustersSorted()

void cbm::algo::sts::HitfinderChain::EnsureClustersSorted ( )

private

◆ EnsureDigiOffsets()

void sts::HitfinderChain::EnsureDigiOffsets ( DigiMap & digi )

private

Definition at line 725 of file HitfinderChain.cxx.

References fHitfinder, fPars, and cbm::algo::sts::HitfinderChain::DigiMap::nDigisPerModule.

Referenced by operator()().

◆ EnsureDigisSorted()

void sts::HitfinderChain::EnsureDigisSorted ( )

private

Definition at line 745 of file HitfinderChain.cxx.

References fHitfinder, fPars, and L_.

Referenced by operator()().

◆ EnsureHitsSorted()

void sts::HitfinderChain::EnsureHitsSorted ( PartitionedSpan< sts::Hit > hits )

private

Definition at line 859 of file HitfinderChain.cxx.

References hits, and L_.

Referenced by operator()().

◆ EnsureParameters()

void sts::HitfinderChain::EnsureParameters ( )

private

Ensure parameters were set. Raises log(fatal) otherwise.

Definition at line 278 of file HitfinderChain.cxx.

References fPars.

Referenced by AllocateDynamic(), AllocateStatic(), and operator()().

◆ Finalize()

void sts::HitfinderChain::Finalize ( )

Teardown chain.

Definition at line 43 of file HitfinderChain.cxx.

References fHitfinder.

◆ FlattenClusters()

PartitionedVector< sts::Cluster > sts::HitfinderChain::FlattenClusters ( xpu::queue queue )

private

Copy Clusters back to host into a flat array.

Definition at line 615 of file HitfinderChain.cxx.

References fHitfinder, fPars, and L_.

Referenced by operator()().

◆ FlattenDigis()

void sts::HitfinderChain::FlattenDigis	(	gsl::span< const CbmStsDigi >	digis,
		DigiMap &	digiMap )

private

Copy Digis into flat array that can be copied to the GPU.

Definition at line 477 of file HitfinderChain.cxx.

References CBM_OMP, CBM_PARALLEL, CBM_PARALLEL_FOR, fHitfinder, fPars, cbm::algo::openmp::GetMaxThreads(), cbm::algo::openmp::GetThreadNum(), InvalidModule, L_, cbm::algo::sts::HitfinderChain::DigiMap::ModuleIndex(), cbm::algo::sts::HitfinderChain::DigiMap::nDigisPerModule, cbm::algo::sts::HitfinderChain::DigiMap::nDigisPerThread, and v.

Referenced by operator()().

◆ FlattenHits()

PartitionedSpan< sts::Hit > sts::HitfinderChain::FlattenHits ( xpu::queue queue )

private

Copy Hits back to host into a flat array.

Definition at line 541 of file HitfinderChain.cxx.

References CBM_PARALLEL_FOR, fAddresses, fHitfinder, fHitOffsets, fPars, GetNHits(), hits, and L_.

Referenced by operator()().

◆ GetContext()

const ChainContext * cbm::algo::SubChain::GetContext ( )

inlineinherited

Definition at line 16 of file SubChain.h.

References fContext.

◆ GetMonitor()

Monitor & cbm::algo::SubChain::GetMonitor ( ) const

inlineinherited

Definition at line 25 of file SubChain.h.

References fContext, and HasMonitor().

Referenced by cbm::algo::Reco::QueueEvbuildMetrics(), cbm::algo::Reco::QueueProcessingExtraMetrics(), cbm::algo::Reco::QueueProcessingMetrics(), cbm::algo::Reco::QueueStsRecoMetrics(), cbm::algo::Reco::QueueTofCalibMetrics(), cbm::algo::Reco::QueueTofRecoMetrics(), cbm::algo::Reco::QueueTrackingMetrics(), cbm::algo::Reco::QueueTrdRecoMetrics(), and cbm::algo::Reco::QueueUnpackerMetricsDet().

◆ GetNHits()

size_t sts::HitfinderChain::GetNHits	(	xpu::h_view< PaddedToCacheLine< int > >	nHitsPerModule,
		int	module )

private

Returns the number of hits of a module.

Note: : Wrapper method required as buckets might overflow. This corrects for that.

Definition at line 652 of file HitfinderChain.cxx.

References fHitfinder.

Referenced by FlattenHits().

◆ GetParameters()

const HitfinderChainPars & cbm::algo::sts::HitfinderChain::GetParameters ( ) const

inline

Definition at line 56 of file HitfinderChain.h.

References fPars.

◆ HasMonitor()

bool cbm::algo::SubChain::HasMonitor ( ) const

inlineinherited

Definition at line 23 of file SubChain.h.

References fContext.

Referenced by GetMonitor(), cbm::algo::Reco::QueueEvbuildMetrics(), cbm::algo::Reco::QueueProcessingExtraMetrics(), cbm::algo::Reco::QueueProcessingMetrics(), cbm::algo::Reco::QueueStsRecoMetrics(), cbm::algo::Reco::QueueTofCalibMetrics(), cbm::algo::Reco::QueueTofRecoMetrics(), cbm::algo::Reco::QueueTrackingMetrics(), cbm::algo::Reco::QueueTrdRecoMetrics(), and cbm::algo::Reco::QueueUnpackerMetricsDet().

◆ operator()()

sts::HitfinderChain::Result sts::HitfinderChain::operator()	(	gsl::span< const CbmStsDigi >	digis,
		bool	storeClusters = false )

◆ Opts()

const Options & cbm::algo::SubChain::Opts ( ) const

inlineinherited

Definition at line 20 of file SubChain.h.

References fContext.

◆ Params()

const RecoParams & cbm::algo::SubChain::Params ( ) const

inlineinherited

Definition at line 21 of file SubChain.h.

References fContext.

Referenced by cbm::algo::Reco::Init(), cbm::algo::sts::HitfinderChain::operator()(), and cbm::algo::Reco::Run().

◆ SetContext()

void cbm::algo::SubChain::SetContext ( const ChainContext * ctx )

inlineinherited

Definition at line 18 of file SubChain.h.

References fContext.

Referenced by cbm::algo::Reco::Init().

◆ SetParameters()

void sts::HitfinderChain::SetParameters ( const HitfinderChainPars & parameters )

Definition at line 18 of file HitfinderChain.cxx.

References AllocateDynamic(), AllocateStatic(), cbm::algo::RecoParams::Dynamic, fPars, cbm::algo::RecoParams::Static, and cbm::util::ToString().

◆ SortHitsWithinPartition()

void sts::HitfinderChain::SortHitsWithinPartition ( PartitionedSpan< sts::Hit > hits )

private

Sort Hits by time in each partition.

Definition at line 716 of file HitfinderChain.cxx.

References CBM_PARALLEL_FOR, and hits.

Referenced by operator()().

◆ SplitHitsIntoStreams()

PartitionedSpan< sts::Hit > sts::HitfinderChain::SplitHitsIntoStreams	(	PartitionedSpan< sts::Hit >	hits,
		int	nstreamsMax )

private

Divide Hits into streams.

Parameters

hits	Hits to sort. Expects one partition per sensor.
nstreamsMax	max number of streams to create.

Note: : Creates 'nstreamsMax / nSensors' streams per sensor. Rounds down if nstreamsMax isn't divisble by nSensors. So fewer streams in total could be created.

Definition at line 657 of file HitfinderChain.cxx.

References fHitStreamOffsets, fStreamAddresses, hits, and x.

Referenced by operator()().

Member Data Documentation

◆ fAddresses

std::vector<u32> cbm::algo::sts::HitfinderChain::fAddresses

private

Definition at line 157 of file HitfinderChain.h.

Referenced by FlattenHits().

◆ fContext

const ChainContext* cbm::algo::SubChain::fContext = nullptr

privateinherited

Definition at line 34 of file SubChain.h.

Referenced by GetContext(), GetMonitor(), HasMonitor(), Opts(), Params(), and SetContext().

◆ fHitfinder

Hitfinder cbm::algo::sts::HitfinderChain::fHitfinder

private

Definition at line 154 of file HitfinderChain.h.

Referenced by AllocateDynamic(), AllocateStatic(), EnsureChannelOffsets(), EnsureClustersSane(), EnsureDigiOffsets(), EnsureDigisSorted(), Finalize(), FlattenClusters(), FlattenDigis(), FlattenHits(), GetNHits(), and operator()().

◆ fHitOffsets

std::vector<size_t> cbm::algo::sts::HitfinderChain::fHitOffsets

private

Definition at line 158 of file HitfinderChain.h.

Referenced by FlattenHits().

◆ fHitStreamOffsets

std::vector<size_t> cbm::algo::sts::HitfinderChain::fHitStreamOffsets

private

Definition at line 160 of file HitfinderChain.h.

Referenced by SplitHitsIntoStreams().

◆ fPars

std::optional<sts::HitfinderChainPars> cbm::algo::sts::HitfinderChain::fPars

private

Definition at line 152 of file HitfinderChain.h.

Referenced by AllocateDynamic(), AllocateStatic(), CountDigisPerModules(), EnsureChannelOffsets(), EnsureClustersSane(), EnsureDigiOffsets(), EnsureDigisSorted(), EnsureParameters(), FlattenClusters(), FlattenDigis(), FlattenHits(), GetParameters(), operator()(), and SetParameters().

◆ fStreamAddresses

std::vector<u32> cbm::algo::sts::HitfinderChain::fStreamAddresses

private

Definition at line 159 of file HitfinderChain.h.

Referenced by SplitHitsIntoStreams().

◆ InvalidModule

u16 cbm::algo::sts::HitfinderChain::InvalidModule = 0xFFFF

staticconstexprprivate

Definition at line 66 of file HitfinderChain.h.

Referenced by CountDigisPerModules(), and FlattenDigis().

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ AllocateDynamic()

◆ AllocateStatic()

◆ CountDigisPerModules()

◆ EnsureChannelOffsets()

◆ EnsureClustersSane()

◆ EnsureClustersSorted()

◆ EnsureDigiOffsets()

◆ EnsureDigisSorted()

◆ EnsureHitsSorted()

◆ EnsureParameters()

◆ Finalize()

◆ FlattenClusters()

◆ FlattenDigis()

◆ FlattenHits()

◆ GetContext()

◆ GetMonitor()

◆ GetNHits()

◆ GetParameters()

◆ HasMonitor()

◆ operator()()

◆ Opts()

◆ Params()

◆ SetContext()

◆ SetParameters()

◆ SortHitsWithinPartition()

◆ SplitHitsIntoStreams()

Member Data Documentation

◆ fAddresses

◆ fContext

◆ fHitfinder

◆ fHitOffsets

◆ fHitStreamOffsets

◆ fPars

◆ fStreamAddresses

◆ InvalidModule