Herd::ScdClusteringAlgo Class Reference

Algorithm that clusters the Monte Carlo Silicon detector hits. More...

#include <ScdClusteringAlgo.h>

Inheritance diagram for Herd::ScdClusteringAlgo:

Public Member Functions
	ScdClusteringAlgo (const std::string &name)
	Constructor. More...
bool	Initialize () override
	Initialization of the algorithm. More...
bool	Process () override
	Process a single event. More...
std::vector< std::string >	FreeObjects (const std::vector< std::string > &objs, EA::Memory::Status memStatus) override
	Free the memory of unneeded objects. More...

Private Member Functions
void	_Clusterize (ScdHits &hits, const std::vector< ScdGeoParams > &geoParams, ScdClusters &clusters)

Private Attributes
ScdClustersColl	m_silicondetectorClustersColl
EA::observer_ptr< ScdGeoParamsColl >	m_silicondetectorGeoParamsColl
EA::observer_ptr< ScdChannelGeoInfoColl >	m_silicondetectorChannelGeoInfoColl
EA::StorePtr	m_evStore
EA::StorePtr	m_globStore

Detailed Description

Algorithm that clusters the Monte Carlo Silicon detector hits.

algorithms/clustering/ScdClusteringAlgo.h

This algorithm creates clusters starting from the strip hits in the Silicon detector. A cluster is defined as a group of contiguous strips above a given S/N level, including at least one strip (the seed strip) above a given, higher S/N level.

• Needed event objects:

name	type	store	optional	description
scdHitsCollMC	ScdHitsColl	evStore	no	Hits in the Silicon detector.

Needed global objects:

name	type	store	optional	description
scdGeoParams	ScdGeoParamsColl	globStore	no	Geometric parameters of the SCD.
scdChannelGeoInfoColl	ScdChannelGeoInfoColl	globStore	yes	Readout channels geometric info of the SCD.

Produced event objects:

name	type	store	description
scdClustersCollMC	ScdClustersColl	evStore	The clusters of the Silicon detector.

Constructor & Destructor Documentation

ScdClusteringAlgo()

Herd::ScdClusteringAlgo::ScdClusteringAlgo

(

const std::string &

name

)

Constructor.

Parameters

name	The name of the algorithm.

Member Function Documentation

_Clusterize()

void Herd::ScdClusteringAlgo::_Clusterize ( ScdHits &  hits, const std::vector< ScdGeoParams > &  geoParams, ScdClusters &  clusters  )

private

FreeObjects()

std::vector< std::string > Herd::ScdClusteringAlgo::FreeObjects ( const std::vector< std::string > &  objs, EA::Memory::Status  memStatus  )

override

Free the memory of unneeded objects.

Currently this method frees the memory of the clusters if memStatus is EXHAUSTED.

Parameters

objs	The list of objects to be freed.
memStatus	The current memory occupation status.

Returns

a list of freed objects.

Initialize()

bool Herd::ScdClusteringAlgo::Initialize ( )

override

Initialization of the algorithm.

Returns

true if the initialization procedure is successful.

Process()

bool Herd::ScdClusteringAlgo::Process ( )

override

Process a single event.

Returns

If event processing is successful.

Member Data Documentation

m_evStore

EA::StorePtr Herd::ScdClusteringAlgo::m_evStore

private

m_globStore

EA::StorePtr Herd::ScdClusteringAlgo::m_globStore

private

m_silicondetectorChannelGeoInfoColl

EA::observer_ptr<ScdChannelGeoInfoColl> Herd::ScdClusteringAlgo::m_silicondetectorChannelGeoInfoColl

private

m_silicondetectorClustersColl

ScdClustersColl Herd::ScdClusteringAlgo::m_silicondetectorClustersColl

private

m_silicondetectorGeoParamsColl

EA::observer_ptr<ScdGeoParamsColl> Herd::ScdClusteringAlgo::m_silicondetectorGeoParamsColl

private

---

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

• /builds/herd/HerdSoftware/include/herd/analysis/algorithms/clustering/ScdClusteringAlgo.h
• /builds/herd/HerdSoftware/src/analysis/algorithms/clustering/ScdClusteringAlgo.cpp