A class to store information about simulated Monte Carlo primary vertices. More...

#include <KFParticle/blob/master/KFParticlePerformance/KFMCVertex.h>

Collaboration diagram for KFMCVertex:

Public Member Functions
	KFMCVertex ()

float	Par (int i) const
	Returns parameter with index "i" from KFMCVertex::fPar.

float	X () const
	Returns X coordinate of the vertex.

float	Y () const
	Returns Y coordinate of the vertex.

float	Z () const
	Returns Z coordinate of the vertex.

const float *	GetPar () const
	Returns pointer to the parameters of the vertex KFMCVertex::fPar.

void	SetPar (int i, float v)
	Sets a value "v" to parameter "i".

void	SetX (float v)
	Sets value "v" to the X coordinate.

void	SetY (float v)
	Sets value "v" to the Y coordinate.

void	SetZ (float v)
	Sets value "v" to the Z coordinate.

int	NDaughterTracks () const
	Returns number of Monte Carlo tracks produced at the current vertex.

int	NReconstructedDaughterTracks () const
	Returns number of reconstructed tracks from this vertex.

void	AddDaughterTrack (int iTr)
	Adds unique id of the Monte Carlo track produced at the current vertex.

int	DaughterTrack (int iTr) const

bool	IsMCReconstructable () const
	Returns flag showing if the vertex can be found (definition is based on the MC tracks)

bool	IsReconstructable () const
	Returns flag showing if the vertex can be found (definition is based on the reconstructed tracks)

bool	IsReconstructed () const
	Returns flag showing if the vertex was reconstructed.

void	SetReconstructable ()
	Defines the current vertex as such that can be reconstructed (based on the reconstructed tracks)

void	SetUnReconstructable ()
	Defines the current vertex as such that can not be reconstructed (based on the reconstructed tracks)

void	SetMCReconstructable ()
	Defines the current vertex as such that can be reconstructed (based on the MC tracks)

void	SetMCUnReconstructable ()
	Defines the current vertex as such that can not be reconstructed (based on the MC tracks)

void	SetReconstructed ()
	Defines the current vertex as such that was reconstructed.

void	SetUnReconstructed ()
	Defines the current vertex as such that was not reconstructed.

void	SetNReconstructedDaughters (int n)
	Defines number of the reconstructed tracks produced at the current vertex.

bool	IsTriggerPV () const
	Returns flag showing if the vertex is considerred as tigger.

void	SetTriggerPV ()
	Defines the current vertex as the trigger primary vertex.

Protected Attributes
float	fPar [3]
	Cartesian coordinates of the vertex: { X, Y, Z }.

std::vector< int >	fDaughterTracks
	Vector with unique ids of the Monte Carlo tracks produced at this vertex.

bool	fIsReconstructable
	Flag showing if the vertex considered as reconstructable based on the reconstructed tracks.

bool	fIsMCReconstructable
	Flag showing if the vertex considered as reconstructable based on the Monte Carlo tracks.

bool	fIsReconstructed
	Flag showing if vertex was reconstructed.

int	fNReconstructedDaughters
	Number of found tracks, produced at the current vertex.

bool	fIsTriggerPV
	Flag showing if the vertex was a trigger primary vertex.

Friends
std::ostream &	operator<< (std::ostream &out, const KFMCVertex &a)

std::istream &	operator>> (std::istream &in, KFMCVertex &a)

Detailed Description

A class to store information about simulated Monte Carlo primary vertices.

Author: M.Zyzak, I.Kisel

Date: 05.02.2019

Version: 1.0

The class contains coordinates of the vertex, indices of the Monte Carlo tracks produced at this vertex, classification flags, number of the reconstructed Monte Carlo tracks.

Definition at line 38 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 38 of file KFMCVertex.h

Constructor & Destructor Documentation

KFMCVertex::KFMCVertex ( )

Definition at line 24 of file KFMCVertex.cxx.

View newest version in sPHENIX GitHub at line 24 of file KFMCVertex.cxx

References fPar, and i.

Member Function Documentation

void KFMCVertex::AddDaughterTrack ( int iTr )

inline

Adds unique id of the Monte Carlo track produced at the current vertex.

Definition at line 59 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 59 of file KFMCVertex.h

References fDaughterTracks.

int KFMCVertex::DaughterTrack ( int iTr ) const

inline

Returns unique id of the Monte Carlo track from this vertex with index "iTr".

Parameters

[in] iTr - index of the track.

Definition at line 60 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 60 of file KFMCVertex.h

References fDaughterTracks, and NDaughterTracks().

Here is the call graph for this function:

const float* KFMCVertex::GetPar ( ) const

inline

Returns pointer to the parameters of the vertex KFMCVertex::fPar.

Definition at line 49 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 49 of file KFMCVertex.h

References fPar.

bool KFMCVertex::IsMCReconstructable ( ) const

inline

Returns flag showing if the vertex can be found (definition is based on the MC tracks)

Definition at line 73 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 73 of file KFMCVertex.h

References fIsMCReconstructable.

bool KFMCVertex::IsReconstructable ( ) const

inline

Returns flag showing if the vertex can be found (definition is based on the reconstructed tracks)

Definition at line 74 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 74 of file KFMCVertex.h

References fIsReconstructable.

bool KFMCVertex::IsReconstructed ( ) const

inline

Returns flag showing if the vertex was reconstructed.

Definition at line 75 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 75 of file KFMCVertex.h

References fIsReconstructed.

bool KFMCVertex::IsTriggerPV ( ) const

inline

Returns flag showing if the vertex is considerred as tigger.

Definition at line 88 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 88 of file KFMCVertex.h

References fIsTriggerPV.

int KFMCVertex::NDaughterTracks ( ) const

inline

Returns number of Monte Carlo tracks produced at the current vertex.

Definition at line 57 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 57 of file KFMCVertex.h

References fDaughterTracks.

Referenced by DaughterTrack().

Here is the caller graph for this function:

int KFMCVertex::NReconstructedDaughterTracks ( ) const

inline

Returns number of reconstructed tracks from this vertex.

Definition at line 58 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 58 of file KFMCVertex.h

References fNReconstructedDaughters.

float KFMCVertex::Par ( int i ) const

inline

Returns parameter with index "i" from KFMCVertex::fPar.

Definition at line 43 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 43 of file KFMCVertex.h

References fPar, and i.

void KFMCVertex::SetMCReconstructable ( )

inline

Defines the current vertex as such that can be reconstructed (based on the MC tracks)

Definition at line 80 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 80 of file KFMCVertex.h

References fIsMCReconstructable.

void KFMCVertex::SetMCUnReconstructable ( )

inline

Defines the current vertex as such that can not be reconstructed (based on the MC tracks)

Definition at line 81 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 81 of file KFMCVertex.h

References fIsMCReconstructable.

void KFMCVertex::SetNReconstructedDaughters ( int n )

inline

Defines number of the reconstructed tracks produced at the current vertex.

Definition at line 86 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 86 of file KFMCVertex.h

References fNReconstructedDaughters, and n.

void KFMCVertex::SetPar	(	int	i,
		float	v
	)

inline

Sets a value "v" to parameter "i".

Definition at line 51 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 51 of file KFMCVertex.h

References fPar, i, and testSigmaEff::v.

void KFMCVertex::SetReconstructable ( )

inline

Defines the current vertex as such that can be reconstructed (based on the reconstructed tracks)

Definition at line 77 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 77 of file KFMCVertex.h

References fIsReconstructable.

void KFMCVertex::SetReconstructed ( )

inline

Defines the current vertex as such that was reconstructed.

Definition at line 83 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 83 of file KFMCVertex.h

References fIsReconstructed.

void KFMCVertex::SetTriggerPV ( )

inline

Defines the current vertex as the trigger primary vertex.

Definition at line 89 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 89 of file KFMCVertex.h

References fIsTriggerPV.

void KFMCVertex::SetUnReconstructable ( )

inline

Defines the current vertex as such that can not be reconstructed (based on the reconstructed tracks)

Definition at line 78 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 78 of file KFMCVertex.h

References fIsReconstructable.

void KFMCVertex::SetUnReconstructed ( )

inline

Defines the current vertex as such that was not reconstructed.

Definition at line 84 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 84 of file KFMCVertex.h

References fIsReconstructed.

void KFMCVertex::SetX ( float v )

inline

Sets value "v" to the X coordinate.

Definition at line 53 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 53 of file KFMCVertex.h

References fPar, and testSigmaEff::v.

void KFMCVertex::SetY ( float v )

inline

Sets value "v" to the Y coordinate.

Definition at line 54 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 54 of file KFMCVertex.h

References fPar, and testSigmaEff::v.

void KFMCVertex::SetZ ( float v )

inline

Sets value "v" to the Z coordinate.

Definition at line 55 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 55 of file KFMCVertex.h

References fPar, and testSigmaEff::v.

float KFMCVertex::X ( ) const

inline

Returns X coordinate of the vertex.

Definition at line 45 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 45 of file KFMCVertex.h

References fPar.

float KFMCVertex::Y ( ) const

inline

Returns Y coordinate of the vertex.

Definition at line 46 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 46 of file KFMCVertex.h

References fPar.

float KFMCVertex::Z ( ) const

inline

Returns Z coordinate of the vertex.

Definition at line 47 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 47 of file KFMCVertex.h

References fPar.

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	out,
		const KFMCVertex &	a
	)

friend

Operator to print coordinates of the MC vertex "a".

Parameters

[in]	out	- stream, where coordinates will be printed
[in]	a	- vertex to be printed

Definition at line 29 of file KFMCVertex.cxx.

View newest version in sPHENIX GitHub at line 29 of file KFMCVertex.cxx

std::istream& operator>>	(	std::istream &	in,
		KFMCVertex &	a
	)

friend

Operator to read coordinates of the vertex from the input stream.

Parameters

[in]	in	- input stream
[in]	a	- vertex, where the coordinates will be read in

Definition at line 39 of file KFMCVertex.cxx.

View newest version in sPHENIX GitHub at line 39 of file KFMCVertex.cxx

Member Data Documentation

std::vector<int> KFMCVertex::fDaughterTracks

protected

Vector with unique ids of the Monte Carlo tracks produced at this vertex.

Definition at line 97 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 97 of file KFMCVertex.h

Referenced by AddDaughterTrack(), DaughterTrack(), and NDaughterTracks().

bool KFMCVertex::fIsMCReconstructable

protected

Flag showing if the vertex considered as reconstructable based on the Monte Carlo tracks.

Definition at line 99 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 99 of file KFMCVertex.h

Referenced by IsMCReconstructable(), SetMCReconstructable(), and SetMCUnReconstructable().

bool KFMCVertex::fIsReconstructable

protected

Flag showing if the vertex considered as reconstructable based on the reconstructed tracks.

Definition at line 98 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 98 of file KFMCVertex.h

Referenced by IsReconstructable(), SetReconstructable(), and SetUnReconstructable().

bool KFMCVertex::fIsReconstructed

protected

Flag showing if vertex was reconstructed.

Definition at line 100 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 100 of file KFMCVertex.h

Referenced by IsReconstructed(), SetReconstructed(), and SetUnReconstructed().

bool KFMCVertex::fIsTriggerPV

protected

Flag showing if the vertex was a trigger primary vertex.

Definition at line 102 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 102 of file KFMCVertex.h

Referenced by IsTriggerPV(), and SetTriggerPV().

int KFMCVertex::fNReconstructedDaughters

protected

Number of found tracks, produced at the current vertex.

Definition at line 101 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 101 of file KFMCVertex.h

Referenced by NReconstructedDaughterTracks(), and SetNReconstructedDaughters().

float KFMCVertex::fPar[3]

protected

Cartesian coordinates of the vertex: { X, Y, Z }.

Definition at line 96 of file KFMCVertex.h.

View newest version in sPHENIX GitHub at line 96 of file KFMCVertex.h

Referenced by GetPar(), KFMCVertex(), operator<<(), operator>>(), Par(), SetPar(), SetX(), SetY(), SetZ(), X(), Y(), and Z().

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

KFParticle/blob/master/KFParticlePerformance/KFMCVertex.h
KFParticle/blob/master/KFParticlePerformance/KFMCVertex.cxx

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation