ca::Hit class describes a generic hit for the CA tracker More...

#include <CaHit.h>

Public Member Functions
	Hit ()=default
	Default constructor.

bool	Check () const
	Checks, if the hit is defined.

void	SetFrontKey (HitKeyIndex_t key)
	Set the front key index.

void	SetBackKey (HitKeyIndex_t key)
	Set the back key index.

void	SetX (fscal x)
	Set the X coordinate.

void	SetY (fscal y)
	Set the Y coordinate.

void	SetZ (fscal z)
	Set the Z coordinate.

void	SetT (fscal t)
	Set the time.

void	SetDx2 (fscal dx2)
	Set the uncertainty of X coordinate.

void	SetDy2 (fscal dy2)
	Set the uncertainty of Y coordinate.

void	SetDxy (fscal dxy)
	Set the X/Y covariance.

void	SetDt2 (fscal dt2)
	Set the uncertainty of time.

void	SetRangeX (fscal rangeX)
	Set the +/- range of uncertainty of X coordinate.

void	SetRangeY (fscal rangeY)
	Set the +/- range of uncertainty of Y coordinate.

void	SetRangeT (fscal rangeT)
	Set the +/- range of uncertainty of time.

void	SetId (HitIndex_t id)
	Set the hit id.

void	SetStation (int station)
	Set the station index.

HitKeyIndex_t	FrontKey () const
	Get the front key index.

HitKeyIndex_t	BackKey () const
	Get the back key index.

fscal	X () const
	Get the X coordinate.

fscal	Y () const
	Get the Y coordinate.

fscal	Z () const
	Get the Z coordinate.

fscal	T () const
	Get the time.

fscal	dX2 () const
	Get the uncertainty of X coordinate.

fscal	dY2 () const
	Get the uncertainty of Y coordinate.

fscal	dXY () const
	Get the X/Y covariance.

fscal	dT2 () const
	Get the uncertainty of time.

fscal	RangeX () const
	Get the +/- range of uncertainty of X coordinate.

fscal	RangeY () const
	Get the +/- range of uncertainty of Y coordinate.

fscal	RangeT () const
	Get the +/- range of uncertainty of time.

HitIndex_t	Id () const
	Get the hit id.

int	Station () const
	Get the station index.

std::string	ToString () const
	Simple string representation of the hit class.

std::string	ToString (int verbose, bool bHeader) const
	String representation of the hit class.

Private Member Functions
template<class Archive>
void	serialize (Archive &ar, const unsigned int)
	Serialization method, used to save ca::Hit objects into binary or text file in a defined order.

Private Attributes
HitKeyIndex_t	fFrontKey {0}
	front hit key index

HitKeyIndex_t	fBackKey {0}
	back hit key index

fscal	fX {0.}
	measured X coordinate [cm]

fscal	fY {0.}
	measured Y coordinate [cm]

fscal	fZ {0.}
	fixed Z coordinate [cm]

fscal	fT {0.}
	measured time [ns]

fscal	fDx2 {0.}
	rms^2 of uncertainty of X coordinate [cm2]

fscal	fDy2 {0.}
	rms^2 of uncertainty of Y coordinate [cm2]

fscal	fDxy {0.}
	X/Y covariance [cm2].

fscal	fDt2 {0.}
	measured uncertainty of time [ns2]

fscal	fRangeX {0.}
	+/- range of uncertainty of X coordinate [cm]

fscal	fRangeY {0.}
	+/- range of uncertainty of Y coordinate [cm]

fscal	fRangeT {0.}
	+/- range of uncertainty of time [ns]

HitIndex_t	fId {0}
	id of the hit

int	fStation {-1}
	index of station in the active stations array

Friends
class	boost::serialization::access

Detailed Description

ca::Hit class describes a generic hit for the CA tracker

Definition at line 32 of file CaHit.h.

Constructor & Destructor Documentation

◆ Hit()

cbm::algo::ca::Hit::Hit ( )

default

Default constructor.

Member Function Documentation

◆ BackKey()

HitKeyIndex_t cbm::algo::ca::Hit::BackKey ( ) const

inline

Get the back key index.

Definition at line 99 of file CaHit.h.

◆ Check()

bool cbm::algo::ca::Hit::Check ( ) const

inline

Checks, if the hit is defined.

Returns: true Hit is defined; false Hit is undefined and will be skipped

Definition at line 199 of file CaHit.h.

◆ dT2()

fscal cbm::algo::ca::Hit::dT2 ( ) const

inline

Get the uncertainty of time.

Definition at line 123 of file CaHit.h.

◆ dX2()

fscal cbm::algo::ca::Hit::dX2 ( ) const

inline

Get the uncertainty of X coordinate.

Definition at line 114 of file CaHit.h.

◆ dXY()

fscal cbm::algo::ca::Hit::dXY ( ) const

inline

Get the X/Y covariance.

Definition at line 120 of file CaHit.h.

◆ dY2()

fscal cbm::algo::ca::Hit::dY2 ( ) const

inline

Get the uncertainty of Y coordinate.

Definition at line 117 of file CaHit.h.

◆ FrontKey()

HitKeyIndex_t cbm::algo::ca::Hit::FrontKey ( ) const

inline

Get the front key index.

getters

Definition at line 96 of file CaHit.h.

◆ Id()

HitIndex_t cbm::algo::ca::Hit::Id ( ) const

inline

Get the hit id.

Definition at line 135 of file CaHit.h.

◆ RangeT()

fscal cbm::algo::ca::Hit::RangeT ( ) const

inline

Get the +/- range of uncertainty of time.

Definition at line 132 of file CaHit.h.

◆ RangeX()

fscal cbm::algo::ca::Hit::RangeX ( ) const

inline

Get the +/- range of uncertainty of X coordinate.

Definition at line 126 of file CaHit.h.

◆ RangeY()

fscal cbm::algo::ca::Hit::RangeY ( ) const

inline

Get the +/- range of uncertainty of Y coordinate.

Definition at line 129 of file CaHit.h.

◆ serialize()

template<class Archive>

void cbm::algo::ca::Hit::serialize	(	Archive &	ar,
		const unsigned int	)

inlineprivate

Serialization method, used to save ca::Hit objects into binary or text file in a defined order.

Definition at line 177 of file CaHit.h.

◆ SetBackKey()

void cbm::algo::ca::Hit::SetBackKey ( HitKeyIndex_t key )

inline

Set the back key index.

Definition at line 51 of file CaHit.h.

◆ SetDt2()

void cbm::algo::ca::Hit::SetDt2 ( fscal dt2 )

inline

Set the uncertainty of time.

Definition at line 75 of file CaHit.h.

◆ SetDx2()

void cbm::algo::ca::Hit::SetDx2 ( fscal dx2 )

inline

Set the uncertainty of X coordinate.

Definition at line 66 of file CaHit.h.

◆ SetDxy()

void cbm::algo::ca::Hit::SetDxy ( fscal dxy )

inline

Set the X/Y covariance.

Definition at line 72 of file CaHit.h.

◆ SetDy2()

void cbm::algo::ca::Hit::SetDy2 ( fscal dy2 )

inline

Set the uncertainty of Y coordinate.

Definition at line 69 of file CaHit.h.

◆ SetFrontKey()

void cbm::algo::ca::Hit::SetFrontKey ( HitKeyIndex_t key )

inline

Set the front key index.

setters

Definition at line 48 of file CaHit.h.

◆ SetId()

void cbm::algo::ca::Hit::SetId ( HitIndex_t id )

inline

Set the hit id.

Definition at line 87 of file CaHit.h.

◆ SetRangeT()

void cbm::algo::ca::Hit::SetRangeT ( fscal rangeT )

inline

Set the +/- range of uncertainty of time.

Definition at line 84 of file CaHit.h.

◆ SetRangeX()

void cbm::algo::ca::Hit::SetRangeX ( fscal rangeX )

inline

Set the +/- range of uncertainty of X coordinate.

Definition at line 78 of file CaHit.h.

◆ SetRangeY()

void cbm::algo::ca::Hit::SetRangeY ( fscal rangeY )

inline

Set the +/- range of uncertainty of Y coordinate.

Definition at line 81 of file CaHit.h.

◆ SetStation()

void cbm::algo::ca::Hit::SetStation ( int station )

inline

Set the station index.

Definition at line 90 of file CaHit.h.

◆ SetT()

void cbm::algo::ca::Hit::SetT ( fscal t )

inline

Set the time.

Definition at line 63 of file CaHit.h.

◆ SetX()

void cbm::algo::ca::Hit::SetX ( fscal x )

inline

Set the X coordinate.

Definition at line 54 of file CaHit.h.

◆ SetY()

void cbm::algo::ca::Hit::SetY ( fscal y )

inline

Set the Y coordinate.

Definition at line 57 of file CaHit.h.

◆ SetZ()

void cbm::algo::ca::Hit::SetZ ( fscal z )

inline

Set the Z coordinate.

Definition at line 60 of file CaHit.h.

◆ Station()

int cbm::algo::ca::Hit::Station ( ) const

inline

Get the station index.

Definition at line 138 of file CaHit.h.

◆ T()

fscal cbm::algo::ca::Hit::T ( ) const

inline

Get the time.

Definition at line 111 of file CaHit.h.

◆ ToString() [1/2]

std::string Hit::ToString ( ) const

Simple string representation of the hit class.

Definition at line 17 of file CaHit.cxx.

◆ ToString() [2/2]

std::string Hit::ToString	(	int	verbose,
		bool	bHeader ) const

String representation of the hit class.

Parameters

verbose	Verbosity level
bHeader	If true, prints the header

Definition at line 26 of file CaHit.cxx.

◆ X()

fscal cbm::algo::ca::Hit::X ( ) const

inline

Get the X coordinate.

Definition at line 102 of file CaHit.h.

◆ Y()

fscal cbm::algo::ca::Hit::Y ( ) const

inline

Get the Y coordinate.

Definition at line 105 of file CaHit.h.

◆ Z()

fscal cbm::algo::ca::Hit::Z ( ) const

inline

Get the Z coordinate.

Definition at line 108 of file CaHit.h.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 33 of file CaHit.h.

Member Data Documentation

◆ fBackKey

HitKeyIndex_t cbm::algo::ca::Hit::fBackKey {0}

private

back hit key index

Definition at line 157 of file CaHit.h.

◆ fDt2

fscal cbm::algo::ca::Hit::fDt2 {0.}

private

measured uncertainty of time [ns2]

Definition at line 166 of file CaHit.h.

◆ fDx2

fscal cbm::algo::ca::Hit::fDx2 {0.}

private

rms^2 of uncertainty of X coordinate [cm2]

Definition at line 163 of file CaHit.h.

◆ fDxy

fscal cbm::algo::ca::Hit::fDxy {0.}

private

X/Y covariance [cm2].

Definition at line 165 of file CaHit.h.

◆ fDy2

fscal cbm::algo::ca::Hit::fDy2 {0.}

private

rms^2 of uncertainty of Y coordinate [cm2]

Definition at line 164 of file CaHit.h.

◆ fFrontKey

HitKeyIndex_t cbm::algo::ca::Hit::fFrontKey {0}

private

front hit key index

data members NOTE: For STS f and b correspond to the indexes of the front and back clusters of the hit in a dataset. For other tracking detectors (MVD, MuCh, TRD, TOF) f == b and corresponds to the index of the hit. Indexes f and b do not intersect between different detector stations.

Definition at line 156 of file CaHit.h.

◆ fId

HitIndex_t cbm::algo::ca::Hit::fId {0}

private

id of the hit

Definition at line 171 of file CaHit.h.

◆ fRangeT

fscal cbm::algo::ca::Hit::fRangeT {0.}

private

+/- range of uncertainty of time [ns]

Definition at line 169 of file CaHit.h.

◆ fRangeX

fscal cbm::algo::ca::Hit::fRangeX {0.}

private

+/- range of uncertainty of X coordinate [cm]

Definition at line 167 of file CaHit.h.

◆ fRangeY

fscal cbm::algo::ca::Hit::fRangeY {0.}

private

+/- range of uncertainty of Y coordinate [cm]

Definition at line 168 of file CaHit.h.

◆ fStation

int cbm::algo::ca::Hit::fStation {-1}

private

index of station in the active stations array

Definition at line 172 of file CaHit.h.

◆ fT

fscal cbm::algo::ca::Hit::fT {0.}

private

measured time [ns]

Definition at line 162 of file CaHit.h.

◆ fX

fscal cbm::algo::ca::Hit::fX {0.}

private

measured X coordinate [cm]

Definition at line 159 of file CaHit.h.

◆ fY

fscal cbm::algo::ca::Hit::fY {0.}

private

measured Y coordinate [cm]

Definition at line 160 of file CaHit.h.

◆ fZ

fscal cbm::algo::ca::Hit::fZ {0.}

private

fixed Z coordinate [cm]

Definition at line 161 of file CaHit.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Hit()

Member Function Documentation

◆ BackKey()

◆ Check()

◆ dT2()

◆ dX2()

◆ dXY()

◆ dY2()

◆ FrontKey()

◆ Id()

◆ RangeT()

◆ RangeX()

◆ RangeY()

◆ serialize()

◆ SetBackKey()

◆ SetDt2()

◆ SetDx2()

◆ SetDxy()

◆ SetDy2()

◆ SetFrontKey()

◆ SetId()

◆ SetRangeT()

◆ SetRangeX()

◆ SetRangeY()

◆ SetStation()

◆ SetT()

◆ SetX()

◆ SetY()

◆ SetZ()

◆ Station()

◆ T()

◆ ToString() [1/2]

◆ ToString() [2/2]

◆ X()

◆ Y()

◆ Z()

Friends And Related Symbol Documentation

◆ boost::serialization::access

Member Data Documentation

◆ fBackKey

◆ fDt2

◆ fDx2

◆ fDxy

◆ fDy2

◆ fFrontKey

◆ fId

◆ fRangeT

◆ fRangeX

◆ fRangeY

◆ fStation

◆ fT

◆ fX

◆ fY

◆ fZ