Data class for STS clusters. More...

#include <CbmStsCluster.h>

Inheritance diagram for CbmStsCluster:

Collaboration diagram for CbmStsCluster:

Public Member Functions
	CbmStsCluster ()
	Default constructor.

	CbmStsCluster (const CbmStsCluster &)=default
	Copy constructor.

virtual	~CbmStsCluster ()
	Destructor.

double	GetCharge () const
	Get cluster charge @value Total cluster charge [e].

int32_t	GetIndex () const
	Get cluster index.

double	GetPosition () const
	Cluster position @value Cluster position in channel number units.

double	GetPositionError () const
	Cluster position error @value Error (r.m.s.) of cluster position in channel number units.

int32_t	GetSize () const
	Set size of the cluster (number of channels) @value size Number of channels from first to last.

double	GetTime () const
	Get cluster time.

double	GetTimeError () const
	Get error of cluster time.

void	SetIndex (int32_t index)
	Set cluster index To keep track of the input during hit finding.

void	SetPositionError (double error)
	Set the position error.

void	SetProperties (double charge, double position, double positionError, double time=0., double timeError=0.)

void	SetSize (int32_t size)
	Set size of the cluster (number of channels)

virtual std::string	ToString () const

void	AddDigi (int32_t index)
	Add digi to cluster.

void	AddDigis (const std::vector< int32_t > &indices)
	Add array of digi to cluster.

void	SetDigis (const std::vector< int32_t > &indices)
	Set array of digi to cluster. Overwrites existing array.

int32_t	GetNofDigis () const
	Number of digis in cluster.

int32_t	GetDigi (int32_t index) const
	Get digi at position index.

const std::vector< int32_t > &	GetDigis () const
	Get array of digi indices.

void	ClearDigis ()
	Remove all digis.

int32_t	GetAddress () const

CbmMatch *	GetMatch () const

void	SetAddress (int32_t address)

void	SetMatch (CbmMatch *match)

Private Member Functions
	ClassDef (CbmStsCluster, 7)

Private Attributes
double	fCharge
	Total charge.

int32_t	fSize
	Difference between first and last channel.

double	fPosition
	Cluster centre in channel number units.

double	fPositionError
	Cluster centre error (r.m.s.) in channel number units.

double	fTime
	Cluster time (average of digi times) [ns].

double	fTimeError
	Error of cluster time [ns].

int32_t	fIndex
	Index of cluster in input array.

std::vector< int32_t >	fDigis
	Array of digi indices.

int32_t	fAddress
	Unique detector ID.

CbmMatch *	fMatch
	link to Monte-Carlo information

Detailed Description

Data class for STS clusters.

The CbmStsCluster is a collection of CbmStsDigis in neighbouring module channels. Apart from the indices of the contributing digis, it provides address, time, total charge, mean position in channel units and the error of the latter.

Definition at line 35 of file CbmStsCluster.h.

Constructor & Destructor Documentation

◆ CbmStsCluster() [1/2]

CbmStsCluster::CbmStsCluster ( )

Default constructor.

Definition at line 22 of file CbmStsCluster.cxx.

◆ CbmStsCluster() [2/2]

CbmStsCluster::CbmStsCluster ( const CbmStsCluster & )

default

Copy constructor.

◆ ~CbmStsCluster()

CbmStsCluster::~CbmStsCluster ( )

virtual

Destructor.

Definition at line 36 of file CbmStsCluster.cxx.

Member Function Documentation

◆ AddDigi()

void CbmCluster::AddDigi ( int32_t index )

inlineinherited

Add digi to cluster.

Parameters

[in] index Digi index in TClonesArray.

Definition at line 51 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmTrdCluster::AddDigi(), CbmMvdSensorClusterfinderTask::ExecFrame(), CbmRecoStsPixel::ProcessData(), and TEST().

◆ AddDigis()

void CbmCluster::AddDigis ( const std::vector< int32_t > & indices )

inlineinherited

Add array of digi to cluster.

Parameters

[in] indices Array of digi indices in TClonesArray.

Definition at line 57 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmTrdCluster::AddDigi(), CbmMuchClustering::ClusteringA1(), CbmMuchClustering::ClusteringSL(), CbmMuchClustering::ClusteringWard(), CbmMuchFindHitsGem::ExecClusteringPeaks(), CbmMuchFindHitsGem::ExecClusteringSimple(), CbmMuchFindHitsGem::FindClusters(), CbmTrdCluster::Merge(), and TEST().

◆ ClassDef()

CbmStsCluster::ClassDef	(	CbmStsCluster	,
		7	)

private

◆ ClearDigis()

void CbmCluster::ClearDigis ( )

inlineinherited

Remove all digis.

Definition at line 87 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmTrdCluster::AddDigi(), CbmTrdCluster::Clear(), CbmTrdCluster::Merge(), and TEST().

◆ GetAddress()

int32_t CbmCluster::GetAddress ( ) const

inlineinherited

Accessors

Definition at line 90 of file CbmCluster.h.

References CbmCluster::fAddress.

Referenced by compareClusterDataMembers(), CbmMvdCluster::GetSensorNr(), CbmMvdCluster::GetStationNr(), CbmLitClusteringQa::ProcessClusters(), CbmTrdCalibTracker::ResolutionQa(), CbmMuchHitFinderQa::StatisticsQa(), ToString(), and CbmTrdCluster::ToString().

◆ GetCharge()

double CbmStsCluster::GetCharge ( ) const

inline

Get cluster charge @value Total cluster charge [e].

This is the sum of the charges of the contributing digis.

Definition at line 59 of file CbmStsCluster.h.

References fCharge.

Referenced by CbmStsTrackFinder::CalculateEloss(), CbmStsWkn::GetStsWkn(), CbmStsWkn::GetStsWkn(), and CbmKFParticleFinderPID::SetRecoPID().

◆ GetDigi()

int32_t CbmCluster::GetDigi ( int32_t index ) const

inlineinherited

Get digi at position index.

Parameters

[in] index Position of digi in array.

Returns: Digi index in TClonesArray.

Definition at line 76 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmStsAlgoAnaCluster::AnaSize1(), CbmStsAlgoAnaCluster::AnaSize2(), CbmStsAlgoAnaCluster::AnaSizeN(), CbmStsTrackFinder::CalculateEloss(), CbmMuchHitFinderQa::ClusterDeconvQa(), compareClusterDataMembers(), CbmMuchFindHitsGem::CreateHits(), CbmMuchTrackFinderIdeal::DoFind(), CbmTrdHitDensityQa::Exec(), CbmTrdOccupancyQa::Exec(), CbmTrdQa::Exec(), CbmTrdRecoQa::Exec(), CbmMuchFindHitsGem::ExecClusteringPeaks(), CbmMuchFindHitsGem::ExecClusteringSimple(), CbmHadronAnalysis::ExecEvent(), CbmMuchMatchTracks::ExecPixel(), CbmTrdModuleRecR::IsClusterComplete(), CbmMatchRecoToMC::MatchClusters(), CbmMatchRecoToMC::MatchClusters(), CbmMuchHitFinderQa::PullsQa(), CbmTrdCalibTracker::ResolutionQa(), CbmKFParticleFinderPID::SetRecoPID(), CbmMuchHitFinderQa::StatisticsQa(), and CbmStsAlgoAnaCluster::WeightedMean().

◆ GetDigis()

const std::vector< int32_t > & CbmCluster::GetDigis ( ) const

inlineinherited

Get array of digi indices.

Returns: Array of digi indices in TClonesArray.

Definition at line 82 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmTrdCluster::AddDigi(), compareClusterDataMembers(), and CbmTrdCluster::Merge().

◆ GetIndex()

int32_t CbmStsCluster::GetIndex ( ) const

inline

Get cluster index.

Returns: Index of cluster in cluster array

Definition at line 65 of file CbmStsCluster.h.

References fIndex.

◆ GetMatch()

CbmMatch * CbmCluster::GetMatch ( ) const

inlineinherited

Definition at line 91 of file CbmCluster.h.

References CbmCluster::fMatch.

Referenced by compareClusterDataMembers(), and CbmKFTrackFitQa::StsHitMatch().

◆ GetNofDigis()

int32_t CbmCluster::GetNofDigis ( ) const

inlineinherited

Number of digis in cluster.

Returns: Number of digis in cluster.

Definition at line 69 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmStsAlgoAnaCluster::AnaSizeN(), CbmStsTrackFinder::CalculateEloss(), CbmMuchHitFinderQa::ClusterDeconvQa(), compareClusterDataMembers(), CbmMvdSensorHitfinderTask::ComputeCenterOfGravity(), CbmMuchFindHitsGem::CreateHits(), CbmMuchTrackFinderIdeal::DoFind(), CbmMvdClusterAna::Exec(), CbmStsAlgoAnaCluster::Exec(), CbmTrdHitDensityQa::Exec(), CbmTrdOccupancyQa::Exec(), CbmTrdQa::Exec(), CbmTrdRecoQa::Exec(), CbmMuchFindHitsGem::ExecClusteringPeaks(), CbmMuchFindHitsGem::ExecClusteringSimple(), CbmHadronAnalysis::ExecEvent(), CbmMuchMatchTracks::ExecPixel(), PairAnalysisVarManager::FillVarTrdCluster(), CbmTrdModuleRecR::IsClusterComplete(), CbmMatchRecoToMC::MatchClusters(), CbmMatchRecoToMC::MatchClusters(), CbmLitClusteringQa::ProcessClusters(), CbmMuchHitFinderQa::PullsQa(), CbmTrdCalibTracker::ResolutionQa(), CbmKFParticleFinderPID::SetRecoPID(), CbmMuchHitFinderQa::StatisticsQa(), CbmCluster::ToString(), ToString(), and CbmStsAlgoAnaCluster::WeightedMean().

◆ GetPosition()

double CbmStsCluster::GetPosition ( ) const

inline

Cluster position @value Cluster position in channel number units.

Definition at line 71 of file CbmStsCluster.h.

References fPosition.

Referenced by CbmStsAlgoFindHits::IntersectClusters(), CbmStsAlgoFindHitsOrtho::IntersectClusters(), and ToString().

◆ GetPositionError()

double CbmStsCluster::GetPositionError ( ) const

inline

Cluster position error @value Error (r.m.s.) of cluster position in channel number units.

Definition at line 77 of file CbmStsCluster.h.

References fPositionError.

Referenced by CbmStsAlgoFindHits::IntersectClusters(), CbmStsAlgoFindHitsOrtho::IntersectClusters(), and ToString().

◆ GetSize()

int32_t CbmStsCluster::GetSize ( ) const

inline

Set size of the cluster (number of channels) @value size Number of channels from first to last.

Note that this can be different from the number of digis in the cluster in case there are gaps e.g. due to dead channels.

Definition at line 86 of file CbmStsCluster.h.

References fSize.

◆ GetTime()

double CbmStsCluster::GetTime ( ) const

inline

Get cluster time.

Returns: Time of cluster [ns]

This is the average time of the contributing digis.

Definition at line 94 of file CbmStsCluster.h.

References fTime.

Referenced by CbmStsAlgoFindHits::CreateHit(), CbmStsAlgoFindHitsOrtho::CreateHit(), CbmStsAlgoFindHits::Exec(), and CbmStsAlgoFindHitsOrtho::Exec().

◆ GetTimeError()

double CbmStsCluster::GetTimeError ( ) const

inline

Get error of cluster time.

Returns: Time error [ns]

Definition at line 100 of file CbmStsCluster.h.

References fTimeError.

Referenced by CbmStsAlgoFindHits::CreateHit(), CbmStsAlgoFindHitsOrtho::CreateHit(), CbmStsAlgoFindHits::Exec(), and CbmStsAlgoFindHitsOrtho::Exec().

◆ SetAddress()

void CbmCluster::SetAddress ( int32_t address )

inlineinherited

Modifiers

Definition at line 94 of file CbmCluster.h.

References CbmCluster::fAddress.

Referenced by CbmTrdModuleRecR::addClusters(), CbmStsAlgoFindClusters::CreateCluster(), CbmMvdSensorClusterfinderTask::ExecFrame(), CbmMuchFindHitsGem::FindClusters(), CbmRecoSts::ForwardGpuClusterAndHits(), CbmTrdCluster::ReInit(), and TEST().

◆ SetDigis()

void CbmCluster::SetDigis ( const std::vector< int32_t > & indices )

inlineinherited

Set array of digi to cluster. Overwrites existing array.

Parameters

[in] indices Array of digi indices in TClonesArray.

Definition at line 63 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmTrdModuleRecR::addClusters(), and TEST().

◆ SetIndex()

void CbmStsCluster::SetIndex ( int32_t index )

inline

Set cluster index To keep track of the input during hit finding.

Parameters

index Index of cluster in cluster array

Definition at line 107 of file CbmStsCluster.h.

References fIndex.

◆ SetMatch()

void CbmCluster::SetMatch ( CbmMatch * match )

inherited

Definition at line 80 of file CbmCluster.cxx.

References CbmCluster::fMatch.

◆ SetPositionError()

void CbmStsCluster::SetPositionError ( double error )

inline

Set the position error.

Parameters

error Position error (r.m.s.) in channel units

Definition at line 113 of file CbmStsCluster.h.

References fPositionError.

◆ SetProperties()

void CbmStsCluster::SetProperties	(	double	charge,
		double	position,
		double	positionError,
		double	time = 0.,
		double	timeError = 0. )

inline

Set cluster properties (time, charge, mean)

Parameters

charge	Total charge in cluster
position	Cluster centre in channel units
positionError	Error of cluster centre in channel units
time	Cluster time [ns]
timeError	Error of cluster time [ns]

Definition at line 123 of file CbmStsCluster.h.

References fCharge, fPosition, fPositionError, fTime, and fTimeError.

Referenced by CbmStsAlgoAnaCluster::AnaSize1(), CbmStsAlgoAnaCluster::AnaSize2(), and CbmStsAlgoAnaCluster::AnaSizeN().

◆ SetSize()

void CbmStsCluster::SetSize ( int32_t size )

inline

Set size of the cluster (number of channels)

Parameters

size	Number of channels from first to last

Note that this can be different from the number of digis in the cluster in case there are gaps e.g. due to dead channels.

Definition at line 139 of file CbmStsCluster.h.

References fSize, and size().

Referenced by CbmStsAlgoAnaCluster::AnaSize1(), CbmStsAlgoAnaCluster::AnaSize2(), and CbmStsAlgoAnaCluster::AnaSizeN().

◆ ToString()

string CbmStsCluster::ToString ( ) const

virtual

String output

Reimplemented from CbmCluster.

Definition at line 40 of file CbmStsCluster.cxx.

References fCharge, fIndex, fTime, fTimeError, CbmCluster::GetAddress(), CbmCluster::GetNofDigis(), GetPosition(), GetPositionError(), and CbmCluster::ToString().

Member Data Documentation

◆ fAddress

int32_t CbmCluster::fAddress

privateinherited

Unique detector ID.

Definition at line 105 of file CbmCluster.h.

Referenced by CbmCluster::GetAddress(), CbmCluster::operator=(), CbmCluster::SetAddress(), and CbmCluster::ToString().

◆ fCharge

double CbmStsCluster::fCharge

private

Total charge.

Definition at line 147 of file CbmStsCluster.h.

Referenced by GetCharge(), SetProperties(), and ToString().

◆ fDigis

std::vector<int32_t> CbmCluster::fDigis

privateinherited

Array of digi indices.

Definition at line 104 of file CbmCluster.h.

Referenced by CbmCluster::AddDigi(), CbmCluster::AddDigis(), CbmCluster::CbmCluster(), CbmCluster::ClearDigis(), CbmCluster::GetDigi(), CbmCluster::GetDigis(), CbmCluster::GetNofDigis(), CbmCluster::operator=(), CbmCluster::SetDigis(), and CbmCluster::ToString().

◆ fIndex

int32_t CbmStsCluster::fIndex

private

Index of cluster in input array.

Definition at line 153 of file CbmStsCluster.h.

Referenced by GetIndex(), SetIndex(), and ToString().

◆ fMatch

CbmMatch* CbmCluster::fMatch

privateinherited

link to Monte-Carlo information

Definition at line 106 of file CbmCluster.h.

Referenced by CbmCluster::CbmCluster(), CbmCluster::GetMatch(), CbmCluster::operator=(), and CbmCluster::SetMatch().

◆ fPosition

double CbmStsCluster::fPosition

private

Cluster centre in channel number units.

Definition at line 149 of file CbmStsCluster.h.

Referenced by GetPosition(), and SetProperties().

◆ fPositionError

double CbmStsCluster::fPositionError

private

Cluster centre error (r.m.s.) in channel number units.

Definition at line 150 of file CbmStsCluster.h.

Referenced by GetPositionError(), SetPositionError(), and SetProperties().

◆ fSize

int32_t CbmStsCluster::fSize

private

Difference between first and last channel.

Definition at line 148 of file CbmStsCluster.h.

Referenced by GetSize(), and SetSize().

◆ fTime

double CbmStsCluster::fTime

private

Cluster time (average of digi times) [ns].

Definition at line 151 of file CbmStsCluster.h.

Referenced by GetTime(), SetProperties(), and ToString().

◆ fTimeError

double CbmStsCluster::fTimeError

private

Error of cluster time [ns].

Definition at line 152 of file CbmStsCluster.h.

Referenced by GetTimeError(), SetProperties(), and ToString().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbmStsCluster() [1/2]

◆ CbmStsCluster() [2/2]

◆ ~CbmStsCluster()

Member Function Documentation

◆ AddDigi()

◆ AddDigis()

◆ ClassDef()

◆ ClearDigis()

◆ GetAddress()

◆ GetCharge()

◆ GetDigi()

◆ GetDigis()

◆ GetIndex()

◆ GetMatch()

◆ GetNofDigis()

◆ GetPosition()

◆ GetPositionError()

◆ GetSize()

◆ GetTime()

◆ GetTimeError()

◆ SetAddress()

◆ SetDigis()

◆ SetIndex()

◆ SetMatch()

◆ SetPositionError()

◆ SetProperties()

◆ SetSize()

◆ ToString()

Member Data Documentation

◆ fAddress

◆ fCharge

◆ fDigis

◆ fIndex

◆ fMatch

◆ fPosition

◆ fPositionError

◆ fSize

◆ fTime

◆ fTimeError