Helper struct to convert HepMC3 vertex into the internal format. More...

#include <acts/blob/sPHENIX/Examples/Io/HepMC3/include/ActsExamples/Plugins/HepMC3/HepMC3Vertex.hpp>

Public Member Functions
std::unique_ptr< SimVertex >	processVertex (const std::shared_ptr< HepMC3::GenVertex > vertex)
	Returns a vertex translated into Acts.

bool	inEvent (const std::shared_ptr< HepMC3::GenVertex > vertex)
	Returns a boolean expression if a vertex is in an event translated into Acts.

int	id (const std::shared_ptr< HepMC3::GenVertex > vertex)
	Returns a vertex translated into Acts.

std::vector< SimParticle >	particlesIn (const std::shared_ptr< HepMC3::GenVertex > vertex)
	Returns the incoming particles of a vertex translated into Acts.

std::vector< SimParticle >	particlesOut (const std::shared_ptr< HepMC3::GenVertex > vertex)
	Returns the outgoing particles of a vertex translated into Acts.

Acts::Vector3D	position (const std::shared_ptr< HepMC3::GenVertex > vertex)
	Returns the position of a vertex translated into Acts.

double	time (const std::shared_ptr< HepMC3::GenVertex > vertex)
	Returns the time of a vertex translated into Acts.

void	addParticleIn (std::shared_ptr< HepMC3::GenVertex > vertex, std::shared_ptr< SimParticle > particle)
	Adds an incoming particle to a vertex translated into Acts.

void	addParticleOut (std::shared_ptr< HepMC3::GenVertex > vertex, std::shared_ptr< SimParticle > particle)
	Adds an outgoing particle to a vertex translated into Acts.

void	removeParticleIn (std::shared_ptr< HepMC3::GenVertex > vertex, std::shared_ptr< SimParticle > particle)
	Removes an incoming particle from a vertex translated into Acts.

void	removeParticleOut (std::shared_ptr< HepMC3::GenVertex > vertex, std::shared_ptr< SimParticle > particle)
	Removes an outgoing particle from a vertex translated into Acts.

void	position (const std::shared_ptr< HepMC3::GenVertex > vertex, Acts::Vector3D pos)
	Sets the position of a vertex translated into Acts.

void	time (const std::shared_ptr< HepMC3::GenVertex > vertex, double time)
	Sets the time of a vertex translated into Acts.

Private Member Functions
std::vector< SimParticle >	genParticlesToActs (const std::vector< HepMC3::GenParticlePtr > &genParticles)
	Converts HepMC3::GenParticle objects into Acts.

HepMC3::GenParticlePtr	actsParticleToGen (std::shared_ptr< SimParticle > actsParticle)
	Converts an SimParticle into HepMC3::GenParticle.

HepMC3::GenParticlePtr	matchParticles (const std::vector< HepMC3::GenParticlePtr > &genParticles, std::shared_ptr< SimParticle > actsParticle)
	Finds a HepMC3::GenParticle from a list that matches an SimParticle object.

Detailed Description

Helper struct to convert HepMC3 vertex into the internal format.

Definition at line 21 of file HepMC3Vertex.hpp.

View newest version in sPHENIX GitHub at line 21 of file HepMC3Vertex.hpp

Member Function Documentation

HepMC3::GenParticlePtr ActsExamples::HepMC3Vertex::actsParticleToGen ( std::shared_ptr< SimParticle > actsParticle )

private

Converts an SimParticle into HepMC3::GenParticle.

Note: The conversion ignores HepMC status codes

Parameters

actsParticle Acts particle that will be converted

Returns: converted particle

Definition at line 71 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 71 of file HepMC3Vertex.cpp

References charm_jet_coverage::mom.

void ActsExamples::HepMC3Vertex::addParticleIn	(	std::shared_ptr< HepMC3::GenVertex >	vertex,
		std::shared_ptr< SimParticle >	particle
	)

Adds an incoming particle to a vertex translated into Acts.

Parameters

vertex	vertex in HepMC data type
particle	incoming particle that will be added

Definition at line 83 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 83 of file HepMC3Vertex.cpp

void ActsExamples::HepMC3Vertex::addParticleOut	(	std::shared_ptr< HepMC3::GenVertex >	vertex,
		std::shared_ptr< SimParticle >	particle
	)

Adds an outgoing particle to a vertex translated into Acts.

Parameters

vertex	vertex in HepMC data type
particle	outgoing particle that will be added

Definition at line 89 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 89 of file HepMC3Vertex.cpp

std::vector< ActsExamples::SimParticle > ActsExamples::HepMC3Vertex::genParticlesToActs ( const std::vector< HepMC3::GenParticlePtr > & genParticles )

private

Converts HepMC3::GenParticle objects into Acts.

Parameters

genParticles list of HepMC3::GenParticle objects

Returns: converted list

Definition at line 14 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 14 of file HepMC3Vertex.cpp

References ActsExamples::HepMC3Particle::particle().

Here is the call graph for this function:

int ActsExamples::HepMC3Vertex::id ( const std::shared_ptr< HepMC3::GenVertex > vertex )

Returns a vertex translated into Acts.

Parameters

vertex vertex in HepMC data type

Returns: id of the vertex

Definition at line 42 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 42 of file HepMC3Vertex.cpp

bool ActsExamples::HepMC3Vertex::inEvent ( const std::shared_ptr< HepMC3::GenVertex > vertex )

Returns a boolean expression if a vertex is in an event translated into Acts.

Parameters

vertex vertex in HepMC data type

Returns: boolean expression if the vertex is in an event

Definition at line 37 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 37 of file HepMC3Vertex.cpp

HepMC3::GenParticlePtr ActsExamples::HepMC3Vertex::matchParticles	(	const std::vector< HepMC3::GenParticlePtr > &	genParticles,
		std::shared_ptr< SimParticle >	actsParticle
	)

private

Finds a HepMC3::GenParticle from a list that matches an SimParticle object.

Parameters

genParticles	list of HepMC particles
actsParticle	Acts particle

Returns: HepMC particle that matched with the Acts particle or nullptr if no match was found

Definition at line 95 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 95 of file HepMC3Vertex.cpp

std::vector< ActsExamples::SimParticle > ActsExamples::HepMC3Vertex::particlesIn ( const std::shared_ptr< HepMC3::GenVertex > vertex )

Returns the incoming particles of a vertex translated into Acts.

Parameters

vertex vertex in HepMC data type

Returns: incoming particles of the vertex

Definition at line 47 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 47 of file HepMC3Vertex.cpp

std::vector< ActsExamples::SimParticle > ActsExamples::HepMC3Vertex::particlesOut ( const std::shared_ptr< HepMC3::GenVertex > vertex )

Returns the outgoing particles of a vertex translated into Acts.

Parameters

vertex vertex in HepMC data type

Returns: outgoing particles of the vertex

Definition at line 52 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 52 of file HepMC3Vertex.cpp

Acts::Vector3D ActsExamples::HepMC3Vertex::position ( const std::shared_ptr< HepMC3::GenVertex > vertex )

Returns the position of a vertex translated into Acts.

Parameters

vertex vertex in HepMC data type

Returns: position of the vertex

Definition at line 57 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 57 of file HepMC3Vertex.cpp

void ActsExamples::HepMC3Vertex::position	(	const std::shared_ptr< HepMC3::GenVertex >	vertex,
		Acts::Vector3D	pos
	)

Sets the position of a vertex translated into Acts.

Parameters

vertex	vertex in HepMC data type
pos	new position of the vertex

Definition at line 127 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 127 of file HepMC3Vertex.cpp

References pos().

Here is the call graph for this function:

std::unique_ptr< ActsExamples::SimVertex > ActsExamples::HepMC3Vertex::processVertex ( const std::shared_ptr< HepMC3::GenVertex > vertex )

Returns a vertex translated into Acts.

Parameters

vertex vertex in HepMC data type

Returns: corresponding Acts vertex

Definition at line 27 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 27 of file HepMC3Vertex.cpp

References vtx().

Referenced by ActsExamples::HepMC3Particle::endVertex(), ActsExamples::HepMC3Particle::productionVertex(), and ActsExamples::HepMC3Event::vertices().

Here is the call graph for this function:

Here is the caller graph for this function:

void ActsExamples::HepMC3Vertex::removeParticleIn	(	std::shared_ptr< HepMC3::GenVertex >	vertex,
		std::shared_ptr< SimParticle >	particle
	)

Removes an incoming particle from a vertex translated into Acts.

Parameters

vertex	vertex in HepMC data type
particle	incoming particle that will be removed

Definition at line 109 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 109 of file HepMC3Vertex.cpp

References particle.

void ActsExamples::HepMC3Vertex::removeParticleOut	(	std::shared_ptr< HepMC3::GenVertex >	vertex,
		std::shared_ptr< SimParticle >	particle
	)

Removes an outgoing particle from a vertex translated into Acts.

Parameters

vertex	vertex in HepMC data type
particle	outgoing particle that will be removed

Definition at line 118 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 118 of file HepMC3Vertex.cpp

References particle.

double ActsExamples::HepMC3Vertex::time ( const std::shared_ptr< HepMC3::GenVertex > vertex )

Returns the time of a vertex translated into Acts.

Parameters

vertex vertex in HepMC data type

Returns: time of the vertex

Definition at line 66 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 66 of file HepMC3Vertex.cpp

void ActsExamples::HepMC3Vertex::time	(	const std::shared_ptr< HepMC3::GenVertex >	vertex,
		double	time
	)

Sets the time of a vertex translated into Acts.

Parameters

vertex	vertex in HepMC data type
time	new time of the vertex

Definition at line 133 of file HepMC3Vertex.cpp.

View newest version in sPHENIX GitHub at line 133 of file HepMC3Vertex.cpp

References Acts::Test::time.

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

acts/blob/sPHENIX/Examples/Io/HepMC3/include/ActsExamples/Plugins/HepMC3/HepMC3Vertex.hpp
acts/blob/sPHENIX/Examples/Io/HepMC3/src/HepMC3Vertex.cpp

Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation