PHHepMCGenHelper provides service of DST upload of HepMC subevent, vertex assignment and random generator. More...

#include </dev/shm/kenichi/update-github-e1039-doc/e1039-core/generators/phhepmc/PHHepMCGenHelper.h>

Public Types
enum	VTXFUNC { Uniform , Gaus }
	supported function distributions More...

Public Member Functions
	PHHepMCGenHelper ()

virtual	~PHHepMCGenHelper ()

void	set_vertex_distribution_function (VTXFUNC x, VTXFUNC y, VTXFUNC z, VTXFUNC t)
	toss a new vertex according to a Uniform or Gaus distribution More...

void	set_vertex_distribution_mean (const double x, const double y, const double z, const double t)
	set the mean value of the vertex distribution, use PHENIX units of cm, ns More...

void	set_vertex_distribution_width (const double x, const double y, const double z, const double t)
	set the width of the vertex distribution function about the mean, use PHENIX units of cm, ns More...

int	get_embedding_id () const

void	set_embedding_id (int id)

void	set_reuse_vertex (int src_embedding_id)
	reuse vertex from another PHHepMCGenEvent with embedding_id = src_embedding_id Additional smearing and shift possible with set_vertex_distribution_*() More...

int	create_node_tree (PHCompositeNode *topNode)
	init interface nodes More...

PHHepMCGenEvent *	insert_event (HepMC::GenEvent *evt)
	send HepMC::GenEvent to DST tree. This function takes ownership of evt More...

void	move_vertex (PHHepMCGenEvent *genevent)
	move vertex according to vertex settings More...

const PHHepMCGenEventMap *	get_geneventmap () const

PHHepMCGenEventMap *	get_geneventmap ()

gsl_rng *	get_random_generator ()

void	set_geneventmap (PHHepMCGenEventMap *geneventmap)

void	enableLegacyVtxGen ()
	to use the vertex from legacy generator More...

double	get_LegacyPARatio ()

Protected Member Functions
double	smear (const double position, const double width, VTXFUNC dist) const

Protected Attributes
gsl_rng *	RandomGenerator

Detailed Description

PHHepMCGenHelper provides service of DST upload of HepMC subevent, vertex assignment and random generator.

Definition at line 33 of file PHHepMCGenHelper.h.

Member Enumeration Documentation

◆ VTXFUNC

enum PHHepMCGenHelper::VTXFUNC

supported function distributions

Enumerator
Uniform	uniform distribution with half width set via set_vertex_distribution_width()
Gaus	normal distribution with sigma width set via set_vertex_distribution_width()

Definition at line 40 of file PHHepMCGenHelper.h.

Constructor & Destructor Documentation

◆ PHHepMCGenHelper()

PHHepMCGenHelper::PHHepMCGenHelper ( )

Definition at line 36 of file PHHepMCGenHelper.cc.

References RandomGenerator.

◆ ~PHHepMCGenHelper()

PHHepMCGenHelper::~PHHepMCGenHelper ( )

virtual

Definition at line 63 of file PHHepMCGenHelper.cc.

References RandomGenerator.

Member Function Documentation

◆ create_node_tree()

int PHHepMCGenHelper::create_node_tree ( PHCompositeNode * topNode )

init interface nodes

for legacy vertex gen

Definition at line 70 of file PHHepMCGenHelper.cc.

References Fun4AllReturnCodes::ABORTRUN, PHCompositeNode::addNode(), Fun4AllReturnCodes::EVENT_OK, PHNodeIterator::findFirst(), SQPrimaryVertexGen::InitRun(), and PHWHERE.

Here is the call graph for this function:

◆ enableLegacyVtxGen()

void PHHepMCGenHelper::enableLegacyVtxGen ( )

inline

to use the vertex from legacy generator

Definition at line 106 of file PHHepMCGenHelper.h.

Referenced by PHPythia8::enableLegacyVtxGen().

Here is the caller graph for this function:

◆ get_embedding_id()

int PHHepMCGenHelper::get_embedding_id ( ) const

inline

embedding ID for the event positive ID is the embedded event of interest, e.g. jetty event from pythia negative IDs are backgrounds, .e.g out of time pile up collisions Usually, ID = 0 means the primary Au+Au collision background

Definition at line 61 of file PHHepMCGenHelper.h.

Referenced by Fun4AllOscarInputManager::ConvertFromOscar(), Fun4AllHepMCInputManager::get_embedding_id(), Fun4AllOscarInputManager::get_embedding_id(), PHPythia8::get_embedding_id(), Fun4AllHepMCInputManager::run(), and Fun4AllHepMCPileupInputManager::run().

Here is the caller graph for this function:

◆ get_geneventmap() [1/2]

PHHepMCGenEventMap* PHHepMCGenHelper::get_geneventmap ( )

inline

Definition at line 91 of file PHHepMCGenHelper.h.

◆ get_geneventmap() [2/2]

const PHHepMCGenEventMap* PHHepMCGenHelper::get_geneventmap ( ) const

inline

Definition at line 86 of file PHHepMCGenHelper.h.

Referenced by Fun4AllOscarInputManager::ConvertFromOscar(), Fun4AllHepMCInputManager::run(), and Fun4AllHepMCPileupInputManager::run().

Here is the caller graph for this function:

◆ get_LegacyPARatio()

double PHHepMCGenHelper::get_LegacyPARatio ( )

inline

Definition at line 107 of file PHHepMCGenHelper.h.

Referenced by PHPythia8::get_LegacyPARatio().

Here is the caller graph for this function:

◆ get_random_generator()

gsl_rng* PHHepMCGenHelper::get_random_generator ( )

inline

Definition at line 97 of file PHHepMCGenHelper.h.

References RandomGenerator.

◆ insert_event()

PHHepMCGenEvent * PHHepMCGenHelper::insert_event ( HepMC::GenEvent * evt )

send HepMC::GenEvent to DST tree. This function takes ownership of evt

Definition at line 97 of file PHHepMCGenHelper.cc.

References PHHepMCGenEvent::addEvent(), PHHepMCGenEventMap::insert_event(), and move_vertex().

Referenced by Fun4AllOscarInputManager::ConvertFromOscar(), and Fun4AllHepMCInputManager::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ move_vertex()

void PHHepMCGenHelper::move_vertex ( PHHepMCGenEvent * genevent )

move vertex according to vertex settings

setting vertex from E906 legacy generator

Definition at line 110 of file PHHepMCGenHelper.cc.

References SQPrimaryVertexGen::generateVertex(), PHHepMCGenEventMap::get(), PHHepMCGenEvent::get_collision_vertex(), SQPrimaryVertexGen::getPARatio(), PHHepMCGenEventMap::identify(), PHHepMCGenEvent::moveVertex(), and smear().

Referenced by insert_event(), and Fun4AllHepMCPileupInputManager::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_embedding_id()

void PHHepMCGenHelper::set_embedding_id ( int id )

inline

embedding ID for the event positive ID is the embedded event of interest, e.g. jetty event from pythia negative IDs are backgrounds, .e.g out of time pile up collisions Usually, ID = 0 means the primary Au+Au collision background

Definition at line 67 of file PHHepMCGenHelper.h.

Referenced by Fun4AllHepMCPileupInputManager::Fun4AllHepMCPileupInputManager(), Fun4AllHepMCInputManager::set_embedding_id(), Fun4AllOscarInputManager::set_embedding_id(), and PHPythia8::set_embedding_id().

Here is the caller graph for this function:

◆ set_geneventmap()

void PHHepMCGenHelper::set_geneventmap ( PHHepMCGenEventMap * geneventmap )

inline

Definition at line 100 of file PHHepMCGenHelper.h.

Referenced by Fun4AllHepMCInputManager::Fun4AllHepMCInputManager(), and Fun4AllOscarInputManager::Fun4AllOscarInputManager().

Here is the caller graph for this function:

◆ set_reuse_vertex()

void PHHepMCGenHelper::set_reuse_vertex ( int src_embedding_id )

inline

reuse vertex from another PHHepMCGenEvent with embedding_id = src_embedding_id Additional smearing and shift possible with set_vertex_distribution_*()

Definition at line 70 of file PHHepMCGenHelper.h.

Referenced by Fun4AllHepMCInputManager::set_reuse_vertex(), Fun4AllOscarInputManager::set_reuse_vertex(), and PHPythia8::set_reuse_vertex().

Here is the caller graph for this function:

◆ set_vertex_distribution_function()

void PHHepMCGenHelper::set_vertex_distribution_function	(	VTXFUNC	x,
		VTXFUNC	y,
		VTXFUNC	z,
		VTXFUNC	t
	)

toss a new vertex according to a Uniform or Gaus distribution

Definition at line 157 of file PHHepMCGenHelper.cc.

Referenced by Fun4AllHepMCPileupInputManager::Fun4AllHepMCPileupInputManager(), Fun4AllHepMCInputManager::set_vertex_distribution_function(), Fun4AllOscarInputManager::set_vertex_distribution_function(), and PHPythia8::set_vertex_distribution_function().

Here is the caller graph for this function:

◆ set_vertex_distribution_mean()

void PHHepMCGenHelper::set_vertex_distribution_mean	(	const double	x,
		const double	y,
		const double	z,
		const double	t
	)

set the mean value of the vertex distribution, use PHENIX units of cm, ns

Definition at line 166 of file PHHepMCGenHelper.cc.

Referenced by Fun4AllHepMCPileupInputManager::Fun4AllHepMCPileupInputManager(), Fun4AllHepMCInputManager::set_vertex_distribution_mean(), Fun4AllOscarInputManager::set_vertex_distribution_mean(), and PHPythia8::set_vertex_distribution_mean().

Here is the caller graph for this function:

◆ set_vertex_distribution_width()

void PHHepMCGenHelper::set_vertex_distribution_width	(	const double	x,
		const double	y,
		const double	z,
		const double	t
	)

set the width of the vertex distribution function about the mean, use PHENIX units of cm, ns

Definition at line 175 of file PHHepMCGenHelper.cc.

Referenced by Fun4AllHepMCPileupInputManager::Fun4AllHepMCPileupInputManager(), Fun4AllHepMCInputManager::set_vertex_distribution_width(), Fun4AllOscarInputManager::set_vertex_distribution_width(), and PHPythia8::set_vertex_distribution_width().

Here is the caller graph for this function:

◆ smear()

double PHHepMCGenHelper::smear	(	const double	position,
		const double	width,
		VTXFUNC	dist
	)		const

protected

Definition at line 184 of file PHHepMCGenHelper.cc.

References Gaus, RandomGenerator, and Uniform.

Referenced by move_vertex().

Here is the caller graph for this function:

Member Data Documentation

◆ RandomGenerator

gsl_rng* PHHepMCGenHelper::RandomGenerator

protected

Definition at line 111 of file PHHepMCGenHelper.h.

Referenced by get_random_generator(), PHHepMCGenHelper(), smear(), and ~PHHepMCGenHelper().

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

/dev/shm/kenichi/update-github-e1039-doc/e1039-core/generators/phhepmc/PHHepMCGenHelper.h
/dev/shm/kenichi/update-github-e1039-doc/e1039-core/generators/phhepmc/PHHepMCGenHelper.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ VTXFUNC

Constructor & Destructor Documentation

◆ PHHepMCGenHelper()

◆ ~PHHepMCGenHelper()

Member Function Documentation

◆ create_node_tree()

◆ enableLegacyVtxGen()

◆ get_embedding_id()

◆ get_geneventmap() [1/2]

◆ get_geneventmap() [2/2]

◆ get_LegacyPARatio()

◆ get_random_generator()

◆ insert_event()

◆ move_vertex()

◆ set_embedding_id()

◆ set_geneventmap()

◆ set_reuse_vertex()

◆ set_vertex_distribution_function()

◆ set_vertex_distribution_mean()

◆ set_vertex_distribution_width()

◆ smear()

Member Data Documentation

◆ RandomGenerator