Data class for STS clusters. More...

#include <CbmStsCluster.h>

Inheritance diagram for CbmStsCluster:

Collaboration diagram for CbmStsCluster:

Public Member Functions
	CbmStsCluster ()
	Default constructor. More...

	CbmStsCluster (const CbmStsCluster &)=default
	Copy constructor. More...

virtual	~CbmStsCluster ()
	Destructor. More...

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

Int_t	GetIndex () const
	Get cluster index. More...

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

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

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

Double_t	GetTime () const
	Get cluster time. More...

Double_t	GetTimeError () const
	Get error of cluster time. More...

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

void	SetPositionError (Double_t error)
	Set the position error. More...

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

void	SetSize (Int_t size)
	Set size of the cluster (number of channels) More...

virtual std::string	ToString () const

void	AddDigi (Int_t index)
	Add digi to cluster. More...

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

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

Int_t	GetNofDigis () const
	Number of digis in cluster. More...

Int_t	GetDigi (Int_t index) const
	Get digi at position index. More...

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

void	ClearDigis ()
	Remove all digis. More...

Int_t	GetAddress () const

CbmMatch *	GetMatch () const

void	SetAddress (Int_t address)

void	SetMatch (CbmMatch *match)

Private Member Functions
	ClassDef (CbmStsCluster, 7)

Private Attributes
Double_t	fCharge
	Total charge. More...

Int_t	fSize
	Difference between first and last channel. More...

Double_t	fPosition
	Cluster centre in channel number units. More...

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

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

Double_t	fTimeError
	Error of cluster time [ns]. More...

Int_t	fIndex
	Index of cluster in input array. More...

std::vector< Int_t >	fDigis
	Array of digi indices. More...

Int_t	fAddress
	Unique detector ID. More...

CbmMatch *	fMatch
	link to Monte-Carlo information More...

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 31 of file CbmStsCluster.h.

Constructor & Destructor Documentation

◆ CbmStsCluster() [1/2]

CbmStsCluster::CbmStsCluster ( )

Default constructor.

Definition at line 18 of file CbmStsCluster.cxx.

◆ CbmStsCluster() [2/2]

CbmStsCluster::CbmStsCluster ( const CbmStsCluster & )

default

Copy constructor.

◆ ~CbmStsCluster()

CbmStsCluster::~CbmStsCluster ( )

virtual

Destructor.

Definition at line 30 of file CbmStsCluster.cxx.

Member Function Documentation

◆ AddDigi()

void CbmCluster::AddDigi ( Int_t index )

inlineinherited

Add digi to cluster.

Parameters

[in] index Digi index in TClonesArray.

Definition at line 47 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmTrdCluster::AddDigi(), and CbmMvdSensorClusterfinderTask::Exec().

◆ AddDigis()

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

inlineinherited

Add array of digi to cluster.

Parameters

[in] indices Array of digi indices in TClonesArray.

Definition at line 53 of file CbmCluster.h.

References CbmCluster::fDigis.

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

◆ 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(), and CbmTrdCluster::Merge().

◆ GetAddress()

Int_t CbmCluster::GetAddress ( ) const

inlineinherited

Accessors

Definition at line 90 of file CbmCluster.h.

References CbmCluster::fAddress.

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

◆ GetCharge()

Double_t 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 55 of file CbmStsCluster.h.

References fCharge.

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

◆ GetDigi()

Int_t CbmCluster::GetDigi ( Int_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 LxTBFinder::AddHit(), CbmStsAlgoAnaCluster::AnaSize1(), CbmStsAlgoAnaCluster::AnaSize2(), CbmStsAlgoAnaCluster::AnaSizeN(), CbmStsTrackFinder::CalculateEloss(), CbmMuchFindVectorsQA::CheckMatchGem(), CbmMuchHitFinderQa::ClusterDeconvQa(), compareClusterDataMembers(), CbmMuchFindHitsGem::CreateHits(), CbmMuchTrackFinderIdeal::DoFind(), CbmBinnedTrackerQANew::Exec(), CbmBinnedTrackerQA::Exec(), CbmTrdHitProducer::Exec(), LxFinderTriplet::Exec(), CbmTrdQa::Exec(), CbmTrdHitDensityQa::Exec(), LxTBTrdFinder::Exec(), CbmTrdRecoQa::Exec(), LxTrackAna::Exec(), LxTrackAnaTriplet::Exec(), LxTBMLFinder::Exec(), LxFinder::Exec(), CbmBinnedDebug::Exec(), CbmGlobalTrackingQA::Exec(), CbmTrdOccupancyQa::Exec(), CbmMuchFindHitsGem::ExecClusteringPeaks(), CbmMuchFindHitsGem::ExecClusteringSimple(), CbmHadronAnalysis::ExecEvent(), CbmMuchMatchTracks::ExecPixel(), CbmBinnedTrackerQA::HandleMuch(), CbmBinnedTrackerQA::HandleSts(), CbmBinnedTrackerQA::HandleTrd(), CbmBinnedTrackerQA::IterateTrdHits(), CbmMatchRecoToMC::MatchClusters(), CbmMuchHitFinderQa::PullsQa(), CbmKFParticleFinderPID::SetRecoPID(), CbmMuchFindVectorsGem::SetTrackId(), CbmTrdFindVectors::SetTrackId(), CbmMuchHitFinderQa::StatisticsQa(), and CbmStsAlgoAnaCluster::WeightedMean().

◆ GetDigis()

const std::vector<Int_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()

Int_t CbmStsCluster::GetIndex ( ) const

inline

Get cluster index.

Returns: Index of cluster in cluster array

Definition at line 61 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()

Int_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 LxTBFinder::AddHit(), CbmStsAlgoAnaCluster::AnaSizeN(), CbmStsTrackFinder::CalculateEloss(), CbmMuchFindVectorsQA::CheckMatchGem(), CbmMuchHitFinderQa::ClusterDeconvQa(), compareClusterDataMembers(), CbmMvdSensorHitfinderTask::ComputeCenterOfGravity(), CbmMuchFindHitsGem::CreateHits(), CbmMuchTrackFinderIdeal::DoFind(), CbmMvdClusterAna::Exec(), CbmBinnedTrackerQANew::Exec(), CbmTrdHitProducer::Exec(), CbmBinnedTrackerQA::Exec(), CbmTrdQa::Exec(), LxFinderTriplet::Exec(), CbmTrdHitDensityQa::Exec(), CbmStsAlgoAnaCluster::Exec(), CbmTrdRecoQa::Exec(), LxTBTrdFinder::Exec(), LxTrackAna::Exec(), LxTrackAnaTriplet::Exec(), LxTBMLFinder::Exec(), LxFinder::Exec(), CbmBinnedDebug::Exec(), CbmGlobalTrackingQA::Exec(), CbmTrdOccupancyQa::Exec(), CbmMuchFindHitsGem::ExecClusteringPeaks(), CbmMuchFindHitsGem::ExecClusteringSimple(), CbmHadronAnalysis::ExecEvent(), CbmMuchMatchTracks::ExecPixel(), PairAnalysisVarManager::FillVarTrdCluster(), CbmBinnedTrackerQA::HandleMuch(), CbmBinnedTrackerQA::HandleSts(), CbmBinnedTrackerQA::HandleTrd(), CbmBinnedTrackerQA::IterateTrdHits(), CbmMatchRecoToMC::MatchClusters(), CbmLitClusteringQa::ProcessClusters(), CbmMuchHitFinderQa::PullsQa(), CbmKFParticleFinderPID::SetRecoPID(), CbmMuchFindVectorsGem::SetTrackId(), CbmTrdFindVectors::SetTrackId(), CbmMuchHitFinderQa::StatisticsQa(), CbmCluster::ToString(), ToString(), and CbmStsAlgoAnaCluster::WeightedMean().

◆ GetPosition()

Double_t CbmStsCluster::GetPosition ( ) const

inline

Cluster position @value Cluster position in channel number units.

Definition at line 67 of file CbmStsCluster.h.

References fPosition.

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

◆ GetPositionError()

Double_t CbmStsCluster::GetPositionError ( ) const

inline

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

Definition at line 73 of file CbmStsCluster.h.

References fPositionError.

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

◆ GetSize()

Int_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 82 of file CbmStsCluster.h.

References fSize.

◆ GetTime()

Double_t CbmStsCluster::GetTime ( ) const

inline

Get cluster time.

Returns: Time of cluster [ns]

This is the average time of the contributing digis.

Definition at line 90 of file CbmStsCluster.h.

References fTime.

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

◆ GetTimeError()

Double_t CbmStsCluster::GetTimeError ( ) const

inline

Get error of cluster time.

Returns: Time error [ns]

Definition at line 96 of file CbmStsCluster.h.

References fTimeError.

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

◆ SetAddress()

void CbmCluster::SetAddress ( Int_t address )

inlineinherited

Modifiers

Definition at line 94 of file CbmCluster.h.

References CbmCluster::fAddress.

Referenced by CbmTrdModuleRecR::addClusters(), CbmStsAlgoFindClusters::CreateCluster(), CbmMvdSensorClusterfinderTask::Exec(), CbmMuchFindHitsGem::FindClusters(), and CbmTrdCluster::ReInit().

◆ SetDigis()

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

inlineinherited

Set array of digi to cluster. Overwrites existing array.

Parameters

[in] indices Array of digi indices in TClonesArray.

Definition at line 61 of file CbmCluster.h.

References CbmCluster::fDigis.

Referenced by CbmTrdModuleRecR::addClusters().

◆ SetIndex()

void CbmStsCluster::SetIndex ( Int_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 103 of file CbmStsCluster.h.

References fIndex.

◆ SetMatch()

void CbmCluster::SetMatch ( CbmMatch * match )

inherited

Definition at line 68 of file CbmCluster.cxx.

References CbmCluster::fMatch.

◆ SetPositionError()

void CbmStsCluster::SetPositionError ( Double_t error )

inline

Set the position error.

Parameters

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

Definition at line 109 of file CbmStsCluster.h.

References fPositionError.

◆ SetProperties()

void CbmStsCluster::SetProperties	(	Double_t	charge,
		Double_t	position,
		Double_t	positionError,
		Double_t	time = `0.`,
		Double_t	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 119 of file CbmStsCluster.h.

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

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

◆ SetSize()

void CbmStsCluster::SetSize ( Int_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 138 of file CbmStsCluster.h.

References fSize.

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

◆ ToString()

string CbmStsCluster::ToString ( ) const

virtual

String output

Reimplemented from CbmCluster.

Definition at line 34 of file CbmStsCluster.cxx.

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

Member Data Documentation

◆ fAddress

Int_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_t CbmStsCluster::fCharge

private

Total charge.

Definition at line 146 of file CbmStsCluster.h.

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

◆ fDigis

std::vector<Int_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

Int_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_t CbmStsCluster::fPosition

private

Cluster centre in channel number units.

Definition at line 148 of file CbmStsCluster.h.

Referenced by GetPosition(), and SetProperties().

◆ fPositionError

Double_t 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

Int_t CbmStsCluster::fSize

private

Difference between first and last channel.

Definition at line 147 of file CbmStsCluster.h.

Referenced by GetSize(), and SetSize().

◆ fTime

Double_t 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_t 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