HepMC3 main namespace. More...

Data Structures
class	_children
	Provides operator to find the child particles of a Vertex or Particle. More...

class	_parents
	Provides operator to find the parent particles of a Vertex or Particle. More...

class	AssociatedParticle
	Attribute class allowing eg. a GenParticle to refer to another GenParticle. More...

class	ATTRIBUTE
	Filter for the attributes. More...

class	Attribute
	Forward declaration of GenParticle. More...

class	AttributeFeature
	AttributeFeature. More...

class	BoolAttribute
	Attribute that holds an Booleger implemented as an int. More...

class	CharAttribute
	Attribute that holds an Chareger implemented as an int. More...

class	DoubleAttribute
	Attribute that holds a real number as a double. More...

class	Exception
	Standard runtime error. More...

class	Feature
	Expose GenericFeature interface to derived Feature class. More...

class	Feature< Feature_type, typename std::enable_if< std::is_floating_point< Feature_type >::value, void >::type >
	specialisation of Feature for floating point type More...

class	Feature< Feature_type, typename std::enable_if< std::is_integral< Feature_type >::value, void >::type >
	Specialisation of Feature for integral types. More...

class	FloatAttribute
	Attribute that holds a real number as a float. More...

class	FourVector
	Generic 4-vector. More...

class	GenCrossSection
	Stores additional information about cross-section. More...

class	GenericFeature
	GenericFeature defines the Feature interface GenericFeature is not intended to be used directly. The derived Feature class and its specialisations should be used. More...

class	GenEvent
	Stores event-related information. More...

struct	GenEventData
	Stores serializable event information. More...

class	GenHeavyIon
	Stores additional information about Heavy Ion generator. More...

class	GenParticle
	Stores particle-related information. More...

struct	GenParticleData
	Stores serializable particle information. More...

struct	GenParticlePtr_greater_order
	comparison of two particles More...

class	GenPdfInfo
	Stores additional information about PDFs. More...

class	GenRunInfo
	Stores run-related information. More...

struct	GenRunInfoData
	Stores serializable run information. More...

class	GenVertex
	Stores vertex-related information. More...

struct	GenVertexData
	Stores serializable vertex information. More...

class	HEPEUPAttribute
	Class for storing data for LHEF run information. More...

class	HEPEVT_Wrapper
	An interface to HEPEVT common block. More...

class	HEPRUPAttribute
	Class for storing data for LHEF run information. More...

class	IntAttribute
	Attribute that holds an Integer implemented as an int. More...

class	LongAttribute
	Attribute that holds an Integer implemented as an int. More...

class	LongDoubleAttribute
	Attribute that holds a real number as a double. More...

class	LongLongAttribute
	Attribute that holds an Integer implemented as an int. More...

union	magic_t
	Union to hold first 4 byts of file, i.e. magic bytes. More...

struct	pair_GenVertexPtr_int_greater
	Order vertices with equal paths. More...

class	Print
	Provides different printing formats. More...

class	Reader
	Base class for all I/O readers. More...

class	ReaderAscii
	GenEvent I/O parsing for structured text files. More...

class	ReaderAsciiHepMC2
	Parser for HepMC2 I/O files. More...

class	ReaderGZ
	GenEvent I/O parsing for structured text files compressed with gzip. More...

class	ReaderHEPEVT
	GenEvent I/O parsing and serialization for HEPEVT files. More...

class	ReaderLHEF
	GenEvent I/O parsing and serialization for LHEF files. More...

class	ReaderRoot
	GenEvent I/O parsing and serialization for root files. More...

class	ReaderRootTree
	GenEvent I/O parsing and serialization for root files based on root TTree. More...

class	Recursive
	forward declare the recursion wrapper More...

class	Relatives
	Define a common interface that all Relatives objects will satisfy Relatives provides an operator to get the relatives of a range of different GenObject types. The following are examples. More...

class	RelativesInterface
	forward declare the Relatives interface in which _parents and _children are wrapped More...

class	Selector
	Selector is an interface to "standard" Features that are valid for both integral and floating point comparisons. More...

class	SelectorWrapper
	Forward declaration of SelectorWrapper. More...

class	Setup
	Configuration for HepMC. More...

struct	sort_by_id_asc
	Comparison of two particle by id. More...

class	StringAttribute
	Attribute that holds a string. More...

class	UIntAttribute
	Attribute that holds an unsigned int. More...

class	ULongAttribute
	Attribute that holds an unsigned long. More...

class	ULongLongAttribute
	Attribute that holds an unsigned long long. More...

class	Units
	Stores units-related enums and conversion functions. More...

struct	WeightError
	Exception related to weight lookups, setting, and index consistency. More...

class	Writer
	Base class for all I/O writers. More...

class	WriterAscii
	GenEvent I/O serialization for structured text files. More...

class	WriterAsciiHepMC2
	GenEvent I/O serialization for structured text files. More...

class	WriterDOT
	GenEvent I/O output to dot files that should be processed by graphviz or other software. More...

class	WriterHEPEVT
	GenEvent I/O serialization for HEPEVT files. More...

class	WriterHEPEVTZEUS
	GenEvent I/O output to files readable by ZEUS software. More...

class	WriterRoot
	GenEvent I/O serialization for root files. More...

class	WriterRootTree
	GenEvent I/O serialization for root files based on root TTree. More...

class	WriterRootTreeOPAL
	GenEvent I/O output to files similar to these produced by OPAL software. More...

Typedefs
typedef GenHeavyIon	HeavyIon
	Backward compatibility typedef.

using	Filter = std::function< bool(ConstGenParticlePtr)>
	type of Filter

using	Parents = RelativesInterface< _parents >
	alias of _parents wrapped in the Relatives interface

using	Children = RelativesInterface< _children >
	alias of _children wrapped in the Relatives interface

using	Ancestors = RelativesInterface< Recursive< _parents > >
	Ancestors is an alias to Recursion applied to the _parents and wrapped in the Relatives interface.

using	Descendants = RelativesInterface< Recursive< _children > >
	Descendants is an alias to Recursion applied to the _children and wrapped in the Relatives interface.

using	ConstSelectorPtr = std::shared_ptr< const Selector >
	Declaration of ConstSelectorPtr.

Functions
bool	is_parton (const int &pd)
	Detects if particle is parton. Might be used to draw partons different from hadrons.

std::ostream &	operator<< (std::ostream &os, const GenEvent &event)
	Print content of all GenEvent containers with idiomatic C++ printing.

std::ostream &	operator<< (std::ostream &os, ConstGenVertexPtr v)
	Print one-line info with idiomatic C++ printing.

std::ostream &	operator<< (std::ostream &os, ConstGenParticlePtr p)
	Print one-line info with idiomatic C++ printing.

std::ostream &	operator<< (std::ostream &os, shared_ptr< GenCrossSection > &cs)
	Print one-line info with idiomatic C++ printing.

std::ostream &	operator<< (std::ostream &os, shared_ptr< GenHeavyIon > &hi)
	Print one-line info with idiomatic C++ printing.

std::ostream &	operator<< (std::ostream &os, shared_ptr< GenPdfInfo > &pi)
	Print one-line info with idiomatic C++ printing.

std::ostream &	operator<< (std::ostream &os, const FourVector &p)
	Print one-line info with idiomatic C++ printing.

std::ostream &	operator<< (std::ostream &os, const GenRunInfo::ToolInfo &t)
	Print one-line info with idiomatic C++ printing.

std::ostream &	operator<< (std::ostream &os, const GenRunInfo &ri)
	Print one-line info with idiomatic C++ printing.

std::shared_ptr< Reader >	deduce_reader (const std::string &filename)
	THis function will deduce the type of input file based on the name/URL and it's content and will return appropriate Reader.

std::string	version ()
	Get the HepMC library version string.

template<typename Feature_type >
Feature< Feature_type >	abs (const Feature< Feature_type > &input)
	Obtain the absolute value of a Feature. This works as you'd expect. If foo is a valid Feature, then abs(foo) returns a new Feature that corresponds to the absolute value of the foo feature. You can construct a Filter from that in the usual way with e.g. Filter f = abs(foo) > 10.;.

vector< GenParticlePtr >	applyFilter (const Filter &filter, const vector< GenParticlePtr > &particles)
	Apply a Filter to a list of GenParticles Returns a vector of GenParticles that satisfy the Filter.

vector< ConstGenParticlePtr >	applyFilter (const Filter &filter, const vector< ConstGenParticlePtr > &particles)
	Apply a Filter to a list of ConstGenParticles Returns a vector of ConstGenParticles that satisfy the Filter.

bool	ACCEPT_ALL (ConstGenParticlePtr dummy)
	A Filter that will accept all particles This might be needed if a signature requires a default Filter.

Filter	operator&& (const Filter &lhs, const Filter &rhs)
	The logical AND of two Filters is itself a Filter.

Filter	operator\|\| (const Filter &lhs, const Filter &rhs)
	The logical OR of two Filters is itself a Filter.

Filter	operator! (const Filter &rhs)
	The negation of a Filter is itself a Filter.

ConstSelectorPtr	abs (const Selector &input)
	ConstSelectorPtr abs.

static bool	visit_children (std::map< ConstGenVertexPtr, int > &a, ConstGenVertexPtr v)

void	calculate_longest_path_to_top (ConstGenVertexPtr v, std::map< ConstGenVertexPtr, int > &pathl)
	Calculates the path to the top (beam) particles.

Unbound vector comparison functions
double	delta_phi (const FourVector &a, const FourVector &b)
	Signed azimuthal angle separation in [-pi, pi] between vecs `a` and `b`.

double	delta_eta (const FourVector &a, const FourVector &b)
	Pseudorapidity separation between vecs `a` and `b`.

double	delta_rap (const FourVector &a, const FourVector &b)
	Rapidity separation between vecs `a` and `b`.

double	delta_r2_eta (const FourVector &a, const FourVector &b)
	R_eta^2-distance separation dR^2 = dphi^2 + deta^2 between vecs `a` and `b`.

double	delta_r_eta (const FourVector &a, const FourVector &b)
	R_eta-distance separation dR = sqrt(dphi^2 + deta^2) between vecs `a` and `b`.

double	delta_r2_rap (const FourVector &a, const FourVector &b)
	R_rap^2-distance separation dR^2 = dphi^2 + drap^2 between vecs `a` and `b`.

double	delta_r_rap (const FourVector &a, const FourVector &b)
	R_rap-distance separation dR = sqrt(dphi^2 + drap^2) between vecs `a` and `b`.

Variables
struct HEPEVT *	hepevtptr
	Pointer to external (e.g. in Pythia6) struct with HEPEVT.

Detailed Description

HepMC3 main namespace.

HepMC3 main namespace

Typedef Documentation

◆ Ancestors

using Ancestors = RelativesInterface<Recursive<_parents> >

Ancestors is an alias to Recursion applied to the _parents and wrapped in the Relatives interface.

Definition at line 35 of file Relatives.h.

◆ Children

using Children = RelativesInterface<_children>

alias of _children wrapped in the Relatives interface

Definition at line 33 of file Relatives.h.

◆ ConstSelectorPtr

using ConstSelectorPtr = std::shared_ptr<const Selector>

Declaration of ConstSelectorPtr.

Definition at line 24 of file Selector.h.

◆ Descendants

using Descendants = RelativesInterface<Recursive<_children> >

Descendants is an alias to Recursion applied to the _children and wrapped in the Relatives interface.

Definition at line 37 of file Relatives.h.

◆ Filter

using Filter = std::function<bool(ConstGenParticlePtr)>

type of Filter

Definition at line 17 of file Filter.h.

◆ HeavyIon

typedef GenHeavyIon HeavyIon

Backward compatibility typedef.

Definition at line 247 of file GenHeavyIon.h.

◆ Parents

using Parents = RelativesInterface<_parents>

alias of _parents wrapped in the Relatives interface

Definition at line 31 of file Relatives.h.

Function Documentation

◆ abs() [1/2]

template<typename Feature_type >

Feature< Feature_type > abs ( const Feature< Feature_type > & input )

Obtain the absolute value of a Feature. This works as you'd expect. If foo is a valid Feature, then abs(foo) returns a new Feature that corresponds to the absolute value of the foo feature. You can construct a Filter from that in the usual way with e.g. Filter f = abs(foo) > 10.;.

Definition at line 316 of file Feature.h.

◆ abs() [2/2]

ConstSelectorPtr abs ( const Selector & input )

ConstSelectorPtr abs.

Definition at line 25 of file Selector.cc.

◆ ACCEPT_ALL()

bool ACCEPT_ALL ( ConstGenParticlePtr dummy )

inline

A Filter that will accept all particles This might be needed if a signature requires a default Filter.

Definition at line 41 of file Filter.h.

◆ applyFilter() [1/2]

vector< ConstGenParticlePtr > applyFilter	(	const Filter &	filter,
		const vector< ConstGenParticlePtr > &	particles
	)

inline

Apply a Filter to a list of ConstGenParticles Returns a vector of ConstGenParticles that satisfy the Filter.

Definition at line 31 of file Filter.h.

◆ applyFilter() [2/2]

vector< GenParticlePtr > applyFilter	(	const Filter &	filter,
		const vector< GenParticlePtr > &	particles
	)

inline

Apply a Filter to a list of GenParticles Returns a vector of GenParticles that satisfy the Filter.

Definition at line 21 of file Filter.h.

◆ calculate_longest_path_to_top()

void calculate_longest_path_to_top	(	ConstGenVertexPtr	v,
		std::map< ConstGenVertexPtr, int > &	pathl
	)

Calculates the path to the top (beam) particles.

Definition at line 92 of file HEPEVT_Wrapper.cc.

References calculate_longest_path_to_top().

◆ deduce_reader()

std::shared_ptr< Reader > deduce_reader ( const std::string & filename )

THis function will deduce the type of input file based on the name/URL and it's content and will return appropriate Reader.

Definition at line 21 of file ReaderFactory.h.

◆ delta_eta()

double delta_eta	(	const FourVector &	a,
		const FourVector &	b
	)

inline

Pseudorapidity separation between vecs a and b.

Definition at line 297 of file FourVector.h.

References FourVector::delta_eta().

◆ delta_phi()

double delta_phi	(	const FourVector &	a,
		const FourVector &	b
	)

inline

Signed azimuthal angle separation in [-pi, pi] between vecs a and b.

Definition at line 294 of file FourVector.h.

References FourVector::delta_phi().

◆ delta_r2_eta()

double delta_r2_eta	(	const FourVector &	a,
		const FourVector &	b
	)

inline

R_eta^2-distance separation dR^2 = dphi^2 + deta^2 between vecs a and b.

Definition at line 303 of file FourVector.h.

References FourVector::delta_r2_eta().

◆ delta_r2_rap()

double delta_r2_rap	(	const FourVector &	a,
		const FourVector &	b
	)

inline

R_rap^2-distance separation dR^2 = dphi^2 + drap^2 between vecs a and b.

Definition at line 309 of file FourVector.h.

References FourVector::delta_r2_rap().

◆ delta_r_eta()

double delta_r_eta	(	const FourVector &	a,
		const FourVector &	b
	)

inline

R_eta-distance separation dR = sqrt(dphi^2 + deta^2) between vecs a and b.

Definition at line 306 of file FourVector.h.

References FourVector::delta_r_eta().

◆ delta_r_rap()

double delta_r_rap	(	const FourVector &	a,
		const FourVector &	b
	)

inline

R_rap-distance separation dR = sqrt(dphi^2 + drap^2) between vecs a and b.

Definition at line 312 of file FourVector.h.

References FourVector::delta_r_rap().

◆ delta_rap()

double delta_rap	(	const FourVector &	a,
		const FourVector &	b
	)

inline

Rapidity separation between vecs a and b.

Definition at line 300 of file FourVector.h.

References FourVector::delta_rap().

◆ is_parton()

bool is_parton ( const int & pd )

Detects if particle is parton. Might be used to draw partons different from hadrons.

Definition at line 33 of file WriterDOT.cc.

◆ operator!()

Filter operator! ( const Filter & rhs )

inline

The negation of a Filter is itself a Filter.

Definition at line 56 of file Filter.h.

◆ operator&&()

Filter operator&&	(	const Filter &	lhs,
		const Filter &	rhs
	)

inline

The logical AND of two Filters is itself a Filter.

Definition at line 46 of file Filter.h.

◆ operator<<() [1/9]

std::ostream & operator<<	(	std::ostream &	os,
		const FourVector &	p
	)

inline

Print one-line info with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 45 of file PrintStreams.h.

References Print::line().

◆ operator<<() [2/9]

std::ostream & operator<<	(	std::ostream &	os,
		const GenEvent &	event
	)

inline

Print content of all GenEvent containers with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 21 of file PrintStreams.h.

References Print::content().

◆ operator<<() [3/9]

std::ostream & operator<<	(	std::ostream &	os,
		const GenRunInfo &	ri
	)

inline

Print one-line info with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 53 of file PrintStreams.h.

References Print::line().

◆ operator<<() [4/9]

std::ostream & operator<<	(	std::ostream &	os,
		const GenRunInfo::ToolInfo &	t
	)

inline

Print one-line info with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 49 of file PrintStreams.h.

References Print::line().

◆ operator<<() [5/9]

std::ostream & operator<<	(	std::ostream &	os,
		ConstGenParticlePtr	p
	)

inline

Print one-line info with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 29 of file PrintStreams.h.

References Print::line().

◆ operator<<() [6/9]

std::ostream & operator<<	(	std::ostream &	os,
		ConstGenVertexPtr	v
	)

inline

Print one-line info with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 25 of file PrintStreams.h.

References Print::line().

◆ operator<<() [7/9]

std::ostream & operator<<	(	std::ostream &	os,
		shared_ptr< GenCrossSection > &	cs
	)

inline

Print one-line info with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 33 of file PrintStreams.h.

References Print::line().

◆ operator<<() [8/9]

std::ostream & operator<<	(	std::ostream &	os,
		shared_ptr< GenHeavyIon > &	hi
	)

inline

Print one-line info with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 37 of file PrintStreams.h.

References Print::line().

◆ operator<<() [9/9]

std::ostream & operator<<	(	std::ostream &	os,
		shared_ptr< GenPdfInfo > &	pi
	)

inline

Print one-line info with idiomatic C++ printing.

Note: More generic printing methods from HepMC3::Print should be preffered

Definition at line 41 of file PrintStreams.h.

References Print::line().

◆ operator||()

Filter operator\|\|	(	const Filter &	lhs,
		const Filter &	rhs
	)

inline

The logical OR of two Filters is itself a Filter.

Definition at line 51 of file Filter.h.

◆ version()

std::string version ( )

inline

Get the HepMC library version string.

Definition at line 20 of file Version.h.

◆ visit_children()

static bool visit_children	(	std::map< ConstGenVertexPtr, int > &	a,
		ConstGenVertexPtr	v
	)

static

Todo:: This looks dangerously similar to the recusive event traversel that we forbade in the Core library due to wories about generator dependence

Definition at line 256 of file GenEvent.cc.

References visit_children().

Variable Documentation

◆ hepevtptr

struct HEPEVT * hepevtptr

Pointer to external (e.g. in Pythia6) struct with HEPEVT.

Definition at line 27 of file HEPEVT_Wrapper.cc.

Data Structures

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ Ancestors

◆ Children

◆ ConstSelectorPtr

◆ Descendants

◆ Filter

◆ HeavyIon

◆ Parents

Function Documentation

◆ abs() [1/2]

◆ abs() [2/2]

◆ ACCEPT_ALL()

◆ applyFilter() [1/2]

◆ applyFilter() [2/2]

◆ calculate_longest_path_to_top()

◆ deduce_reader()

◆ delta_eta()

◆ delta_phi()

◆ delta_r2_eta()

◆ delta_r2_rap()

◆ delta_r_eta()

◆ delta_r_rap()

◆ delta_rap()

◆ is_parton()

◆ operator!()

◆ operator&&()

◆ operator<<() [1/9]

◆ operator<<() [2/9]

◆ operator<<() [3/9]

◆ operator<<() [4/9]

◆ operator<<() [5/9]

◆ operator<<() [6/9]

◆ operator<<() [7/9]

◆ operator<<() [8/9]

◆ operator<<() [9/9]

◆ operator||()

◆ version()

◆ visit_children()

Variable Documentation

◆ hepevtptr