Data class for SSD clusters. More...

#include <BmnSsdCluster.h>

Inheritance diagram for BmnSsdCluster:

Collaboration diagram for BmnSsdCluster:

Public Member Functions
	BmnSsdCluster ()
	Default constructor.

virtual	~BmnSsdCluster ()
	Destructor.

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

Int_t	GetIndex () const
	Get cluster index.

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

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

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

Double_t	GetTime () const
	Get cluster time.

Double_t	GetTimeError () const
	Get error of cluster time.

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

void	SetPositionError (Double_t error)
	Set the position error.

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)

virtual std::string	ToString () const

Public Member Functions inherited from BmnCluster
	BmnCluster ()
	Constructor.

	BmnCluster (const std::vector< Int_t > &indices, Int_t address)

virtual	~BmnCluster ()
	Destructor.

void	AddDigi (Int_t index)
	Add digi to cluster.

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

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

Int_t	GetNofDigis () const
	Number of digis in cluster.

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

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

void	ClearDigis ()
	Remove all digis.

Int_t	GetAddress () const

BmnMatch *	GetMatch () const

void	SetAddress (Int_t address)

void	SetMatch (BmnMatch *match)

Detailed Description

Data class for SSD clusters.

The BmnSsdCluster is a collection of BmnSsdDigis 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 23 of file BmnSsdCluster.h.

Constructor & Destructor Documentation

◆ BmnSsdCluster()

BmnSsdCluster::BmnSsdCluster ( )

Default constructor.

Definition at line 17 of file BmnSsdCluster.cxx.

◆ ~BmnSsdCluster()

BmnSsdCluster::~BmnSsdCluster ( )

virtual

Destructor.

Definition at line 31 of file BmnSsdCluster.cxx.

Member Function Documentation

◆ GetCharge()

Double_t BmnSsdCluster::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 45 of file BmnSsdCluster.h.

◆ GetIndex()

Int_t BmnSsdCluster::GetIndex ( ) const

inline

Get cluster index.

Returns: Index of cluster in cluster array

Definition at line 51 of file BmnSsdCluster.h.

Referenced by BmnSsdSensor::CreateHit().

◆ GetPosition()

Double_t BmnSsdCluster::GetPosition ( ) const

inline

Cluster position @value Cluster position in channel number units.

Definition at line 57 of file BmnSsdCluster.h.

Referenced by BmnSsdSensorDssd::FindHits(), BmnSsdSensorDssdStereo::IntersectClusters(), and ToString().

◆ GetPositionError()

Double_t BmnSsdCluster::GetPositionError ( ) const

inline

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

Definition at line 63 of file BmnSsdCluster.h.

Referenced by BmnSsdSensorDssdStereo::IntersectClusters(), and ToString().

◆ GetSize()

Int_t BmnSsdCluster::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 72 of file BmnSsdCluster.h.

◆ GetTime()

Double_t BmnSsdCluster::GetTime ( ) const

inline

Get cluster time.

Returns: Time of cluster [ns]

This is the average time of the contributing digis.

Definition at line 80 of file BmnSsdCluster.h.

Referenced by BmnSsdSensor::CreateHit(), and BmnSsdSensorDssd::FindHits().

◆ GetTimeError()

Double_t BmnSsdCluster::GetTimeError ( ) const

inline

Get error of cluster time.

Returns: Time error [ns]

Definition at line 86 of file BmnSsdCluster.h.

Referenced by BmnSsdSensor::CreateHit(), and BmnSsdSensorDssd::FindHits().

◆ SetIndex()

void BmnSsdCluster::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 93 of file BmnSsdCluster.h.

◆ SetPositionError()

void BmnSsdCluster::SetPositionError ( Double_t error )

inline

Set the position error.

Parameters

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

Definition at line 99 of file BmnSsdCluster.h.

◆ SetProperties()

void BmnSsdCluster::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 109 of file BmnSsdCluster.h.

◆ SetSize()

void BmnSsdCluster::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 126 of file BmnSsdCluster.h.

◆ ToString()

string BmnSsdCluster::ToString ( ) const

virtual

String output

Reimplemented from BmnCluster.

Definition at line 37 of file BmnSsdCluster.cxx.

References BmnCluster::GetAddress(), BmnCluster::GetNofDigis(), GetPosition(), and GetPositionError().

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

detectors/ssd/auxx/data/BmnSsdCluster.h
detectors/ssd/auxx/data/BmnSsdCluster.cxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BmnSsdCluster()

◆ ~BmnSsdCluster()

Member Function Documentation

◆ GetCharge()

◆ GetIndex()

◆ GetPosition()

◆ GetPositionError()

◆ GetSize()

◆ GetTime()

◆ GetTimeError()

◆ SetIndex()

◆ SetPositionError()

◆ SetProperties()

◆ SetSize()

◆ ToString()