Detailed Description

Stores particle-related information.

Definition at line 30 of file build/outputs/include/HepMC/GenParticle.h.

#include <GenParticle.h>

Collaboration diagram for GenParticle:

Public Member Functions
	GenParticle (const FourVector &momentum=FourVector::ZERO_VECTOR(), int pid=0, int status=0)
	Default constructor. More...

	GenParticle (const GenParticleData &data)
	Constructor based on particle data. More...

bool	in_event () const
	Check if this particle belongs to an event. More...

GenEvent *	parent_event () const
	Get parent event. More...

int	id () const
	Get particle id. More...

const GenParticleData &	data () const
	Get particle data. More...

const GenVertexPtr	production_vertex () const
	Get production vertex. More...

const GenVertexPtr	end_vertex () const
	Get end vertex. More...

GenVertexPtr	production_vertex ()
	Get production vertex. More...

GenVertexPtr	end_vertex ()
	Get end vertex. More...

vector< GenParticlePtr >	parents () const
	Convenience access to immediate incoming particles via production vertex. More...

vector< GenParticlePtr >	children () const
	Convenience access to immediate outgoing particles via end vertex. More...

vector< GenParticlePtr >	ancestors () const
	Convenience access to all incoming particles via production vertex. More...

vector< GenParticlePtr >	descendants () const
	Convenience access to all outgoing particles via end vertex. More...

int	pid () const
	Get PDG ID. More...

int	status () const
	Get status code. More...

const FourVector &	momentum () const
	Get momentum. More...

bool	is_generated_mass_set () const
	Check if generated mass is set. More...

double	generated_mass () const
	Get generated mass. More...

void	set_pid (int pid)
	Set PDG ID. More...

void	set_status (int status)
	Set status code. More...

void	set_momentum (const FourVector &momentum)
	Set momentum. More...

void	set_generated_mass (double m)
	Set generated mass. More...

void	unset_generated_mass ()
	Declare that generated mass is not set. More...

bool	add_attribute (string name, shared_ptr< Attribute > att)
	Add an attribute to this particle. More...

vector< string >	attribute_names () const
	Get list of names of attributes assigned to this particle. More...

void	remove_attribute (string name)
	Remove attribute. More...

template<class T >
shared_ptr< T >	attribute (string name) const
	Get attribute of type T. More...

string	attribute_as_string (string name) const
	Get attribute of any type as string. More...

	GenParticle (const FourVector &momentum=FourVector::ZERO_VECTOR(), int pid=0, int status=0)
	Default constructor. More...

	GenParticle (const GenParticleData &data)
	Constructor based on particle data. More...

bool	in_event () const
	Check if this particle belongs to an event. More...

GenEvent *	parent_event () const
	Get parent event. More...

int	id () const
	Get particle id. More...

const GenParticleData &	data () const
	Get particle data. More...

const GenVertexPtr	production_vertex () const
	Get production vertex. More...

const GenVertexPtr	end_vertex () const
	Get end vertex. More...

GenVertexPtr	production_vertex ()
	Get production vertex. More...

GenVertexPtr	end_vertex ()
	Get end vertex. More...

vector< GenParticlePtr >	parents () const
	Convenience access to immediate incoming particles via production vertex. More...

vector< GenParticlePtr >	children () const
	Convenience access to immediate outgoing particles via end vertex. More...

vector< GenParticlePtr >	ancestors () const
	Convenience access to all incoming particles via production vertex. More...

vector< GenParticlePtr >	descendants () const
	Convenience access to all outgoing particles via end vertex. More...

int	pid () const
	Get PDG ID. More...

int	status () const
	Get status code. More...

const FourVector &	momentum () const
	Get momentum. More...

bool	is_generated_mass_set () const
	Check if generated mass is set. More...

double	generated_mass () const
	Get generated mass. More...

void	set_pid (int pid)
	Set PDG ID. More...

void	set_status (int status)
	Set status code. More...

void	set_momentum (const FourVector &momentum)
	Set momentum. More...

void	set_generated_mass (double m)
	Set generated mass. More...

void	unset_generated_mass ()
	Declare that generated mass is not set. More...

bool	add_attribute (string name, shared_ptr< Attribute > att)
	Add an attribute to this particle. More...

vector< string >	attribute_names () const
	Get list of names of attributes assigned to this particle. More...

void	remove_attribute (string name)
	Remove attribute. More...

template<class T >
shared_ptr< T >	attribute (string name) const
	Get attribute of type T. More...

string	attribute_as_string (string name) const
	Get attribute of any type as string. More...

template<class T >
HepMC::shared_ptr< T >	attribute (string name) const
	Get attribute of type T. More...

Deprecated functionality
int	pdg_id () const
	Get PDG ID. More...

void	set_pdg_id (int pidin)
	Set PDG ID. More...

int	pdg_id () const
	Get PDG ID. More...

void	set_pdg_id (int pidin)
	Set PDG ID. More...

Private Attributes
GenEvent *	m_event
	Parent event. More...

int	m_id
	Index. More...

GenParticleData	m_data
	Particle data. More...

weak_ptr< GenVertex >	m_production_vertex
	Production vertex. More...

weak_ptr< GenVertex >	m_end_vertex
	End vertex. More...

weak_ptr< GenParticle >	m_this
	Pointer to shared pointer managing this particle. More...

Friends
class	GenEvent

class	GenVertex

class	SmartPointer< GenParticle >

Constructor & Destructor Documentation

◆ GenParticle() [1/4]

GenParticle	(	const FourVector &	momentum = `FourVector::ZERO_VECTOR()`,
		int	pid = `0`,
		int	status = `0`
	)

Default constructor.

Definition at line 21 of file GenParticle.cc.

References GenParticleData::is_mass_set, GenParticle::m_data, GenParticleData::mass, GenParticleData::momentum, GenParticleData::pid, and GenParticleData::status.

◆ GenParticle() [2/4]

GenParticle ( const GenParticleData & data )

Constructor based on particle data.

Definition at line 31 of file GenParticle.cc.

◆ GenParticle() [3/4]

GenParticle	(	const FourVector &	momentum = `FourVector::ZERO_VECTOR()`,
		int	pid = `0`,
		int	status = `0`
	)

Default constructor.

◆ GenParticle() [4/4]

GenParticle ( const GenParticleData & data )

Constructor based on particle data.

Member Function Documentation

◆ add_attribute() [1/2]

bool add_attribute	(	std::string	name,
		shared_ptr< Attribute >	att
	)

Add an attribute to this particle.

This will overwrite existing attribute if an attribute with the same name is present. The attribute will be stored in the parent_event().

Returns: false if there is no parent_event();

Definition at line 96 of file GenParticle.cc.

References GenEvent::add_attribute(), and GenParticle::parent_event().

◆ add_attribute() [2/2]

bool add_attribute	(	string	name,
		shared_ptr< Attribute >	att
	)

Add an attribute to this particle.

This will overwrite existing attribute if an attribute with the same name is present. The attribute will be stored in the parent_event().

Returns: false if there is no parent_event();

◆ ancestors() [1/2]

vector< GenParticlePtr > ancestors ( ) const

Convenience access to all incoming particles via production vertex.

Definition at line 88 of file GenParticle.cc.

References HepMC::findParticles(), and GenParticle::production_vertex().

◆ ancestors() [2/2]

vector<GenParticlePtr> ancestors ( ) const

Convenience access to all incoming particles via production vertex.

◆ attribute() [1/3]

shared_ptr<T> attribute ( string name ) const

Get attribute of type T.

◆ attribute() [2/3]

shared_ptr<T> attribute ( string name ) const

Get attribute of type T.

◆ attribute() [3/3]

HepMC::shared_ptr< T > attribute ( string name ) const

Get attribute of type T.

Definition at line 162 of file build/outputs/include/HepMC/GenParticle.h.

◆ attribute_as_string() [1/2]

string attribute_as_string ( string name ) const

Get attribute of any type as string.

Definition at line 112 of file GenParticle.cc.

References GenEvent::attribute_as_string(), and GenParticle::parent_event().

◆ attribute_as_string() [2/2]

string attribute_as_string ( string name ) const

Get attribute of any type as string.

◆ attribute_names() [1/2]

vector< string > attribute_names ( ) const

Get list of names of attributes assigned to this particle.

Definition at line 102 of file GenParticle.cc.

References GenEvent::attribute_names(), and GenParticle::parent_event().

◆ attribute_names() [2/2]

vector<string> attribute_names ( ) const

Get list of names of attributes assigned to this particle.

◆ children() [1/2]

vector<GenParticlePtr> children ( ) const

Convenience access to immediate outgoing particles via end vertex.

Note: Less efficient than via the vertex since return must be by value (in case there is no vertex)

◆ children() [2/2]

vector< GenParticlePtr > children ( ) const

Convenience access to immediate outgoing particles via end vertex.

Note: Less efficient than via the vertex since return must be by value (in case there is no vertex)

Definition at line 84 of file GenParticle.cc.

References GenParticle::end_vertex().

◆ data() [1/2]

const GenParticleData& data ( ) const

inline

Get particle data.

Definition at line 60 of file include/HepMC/GenParticle.h.

◆ data() [2/2]

const GenParticleData& data ( ) const

inline

Get particle data.

Definition at line 60 of file build/outputs/include/HepMC/GenParticle.h.

◆ descendants() [1/2]

vector<GenParticlePtr> descendants ( ) const

Convenience access to all outgoing particles via end vertex.

◆ descendants() [2/2]

vector< GenParticlePtr > descendants ( ) const

Convenience access to all outgoing particles via end vertex.

Definition at line 92 of file GenParticle.cc.

References GenParticle::end_vertex(), and HepMC::findParticles().

◆ end_vertex() [1/4]

const GenVertexPtr end_vertex ( ) const

Get end vertex.

◆ end_vertex() [2/4]

const GenVertexPtr end_vertex ( ) const

Get end vertex.

Definition at line 76 of file GenParticle.cc.

References GenParticle::m_end_vertex.

◆ end_vertex() [3/4]

GenVertexPtr end_vertex ( )

Get end vertex.

◆ end_vertex() [4/4]

GenVertexPtr end_vertex ( )

Get end vertex.

Definition at line 72 of file GenParticle.cc.

References GenParticle::m_end_vertex.

◆ generated_mass() [1/2]

double generated_mass ( ) const

Get generated mass.

This function will return mass as set by a generator/tool. If not set, it will return momentum().m()

Definition at line 37 of file GenParticle.cc.

References GenParticleData::is_mass_set, FourVector::m(), GenParticle::m_data, GenParticleData::mass, and GenParticleData::momentum.

◆ generated_mass() [2/2]

double generated_mass ( ) const

Get generated mass.

This function will return mass as set by a generator/tool. If not set, it will return momentum().m()

◆ id() [1/2]

int id ( ) const

inline

Get particle id.

Definition at line 59 of file build/outputs/include/HepMC/GenParticle.h.

◆ id() [2/2]

int id ( ) const

inline

Get particle id.

Definition at line 59 of file include/HepMC/GenParticle.h.

◆ in_event() [1/2]

bool in_event ( ) const

inline

Check if this particle belongs to an event.

Definition at line 51 of file build/outputs/include/HepMC/GenParticle.h.

◆ in_event() [2/2]

bool in_event ( ) const

inline

Check if this particle belongs to an event.

Definition at line 51 of file include/HepMC/GenParticle.h.

◆ is_generated_mass_set() [1/2]

bool is_generated_mass_set ( ) const

inline

Check if generated mass is set.

Definition at line 87 of file build/outputs/include/HepMC/GenParticle.h.

◆ is_generated_mass_set() [2/2]

bool is_generated_mass_set ( ) const

inline

Check if generated mass is set.

Definition at line 87 of file include/HepMC/GenParticle.h.

◆ momentum() [1/2]

const FourVector& momentum ( ) const

inline

Get momentum.

Definition at line 86 of file include/HepMC/GenParticle.h.

◆ momentum() [2/2]

const FourVector& momentum ( ) const

inline

Get momentum.

Definition at line 86 of file build/outputs/include/HepMC/GenParticle.h.

◆ parent_event() [1/2]

GenEvent* parent_event ( ) const

inline

Get parent event.

Definition at line 58 of file build/outputs/include/HepMC/GenParticle.h.

◆ parent_event() [2/2]

GenEvent* parent_event ( ) const

inline

Get parent event.

Definition at line 58 of file include/HepMC/GenParticle.h.

◆ parents() [1/2]

vector< GenParticlePtr > parents ( ) const

Convenience access to immediate incoming particles via production vertex.

Note: Less efficient than via the vertex since return must be by value (in case there is no vertex)

Definition at line 80 of file GenParticle.cc.

References GenParticle::production_vertex().

◆ parents() [2/2]

vector<GenParticlePtr> parents ( ) const

Convenience access to immediate incoming particles via production vertex.

Note: Less efficient than via the vertex since return must be by value (in case there is no vertex)

◆ pdg_id() [1/2]

int pdg_id ( ) const

inline

Get PDG ID.

Deprecated:: Use pid() instead

Definition at line 133 of file include/HepMC/GenParticle.h.

◆ pdg_id() [2/2]

int pdg_id ( ) const

inline

Get PDG ID.

Deprecated:: Use pid() instead

Definition at line 133 of file build/outputs/include/HepMC/GenParticle.h.

◆ pid() [1/2]

int pid ( ) const

inline

Get PDG ID.

Definition at line 84 of file include/HepMC/GenParticle.h.

◆ pid() [2/2]

int pid ( ) const

inline

Get PDG ID.

Definition at line 84 of file build/outputs/include/HepMC/GenParticle.h.

◆ production_vertex() [1/4]

const GenVertexPtr production_vertex ( ) const

Get production vertex.

◆ production_vertex() [2/4]

const GenVertexPtr production_vertex ( ) const

Get production vertex.

Definition at line 68 of file GenParticle.cc.

References GenParticle::m_production_vertex.

◆ production_vertex() [3/4]

GenVertexPtr production_vertex ( )

Get production vertex.

◆ production_vertex() [4/4]

GenVertexPtr production_vertex ( )

Get production vertex.

Definition at line 64 of file GenParticle.cc.

References GenParticle::m_production_vertex.

◆ remove_attribute() [1/2]

void remove_attribute ( std::string name )

Remove attribute.

Definition at line 108 of file GenParticle.cc.

References GenParticle::parent_event(), and GenEvent::remove_attribute().

◆ remove_attribute() [2/2]

void remove_attribute ( string name )

Remove attribute.

◆ set_generated_mass() [1/2]

void set_generated_mass ( double m )

Set generated mass.

Definition at line 54 of file GenParticle.cc.

References GenParticleData::is_mass_set, GenParticle::m_data, and GenParticleData::mass.

◆ set_generated_mass() [2/2]

void set_generated_mass ( double m )

Set generated mass.

◆ set_momentum() [1/2]

void set_momentum ( const FourVector & momentum )

Set momentum.

Definition at line 50 of file GenParticle.cc.

References GenParticle::m_data, and GenParticleData::momentum.

◆ set_momentum() [2/2]

void set_momentum ( const FourVector & momentum )

Set momentum.

◆ set_pdg_id() [1/2]

void set_pdg_id ( int pidin )

inline

Set PDG ID.

Deprecated:: Use set_pid() instead

Definition at line 138 of file build/outputs/include/HepMC/GenParticle.h.

◆ set_pdg_id() [2/2]

void set_pdg_id ( int pidin )

inline

Set PDG ID.

Deprecated:: Use set_pid() instead

Definition at line 138 of file include/HepMC/GenParticle.h.

◆ set_pid() [1/2]

void set_pid ( int pid )

Set PDG ID.

◆ set_pid() [2/2]

void set_pid ( int pid )

Set PDG ID.

Definition at line 42 of file GenParticle.cc.

References GenParticle::m_data, and GenParticleData::pid.

◆ set_status() [1/2]

void set_status ( int status )

Set status code.

◆ set_status() [2/2]

void set_status ( int status )

Set status code.

Definition at line 46 of file GenParticle.cc.

References GenParticle::m_data, and GenParticleData::status.

◆ status() [1/2]

int status ( ) const

inline

Get status code.

Definition at line 85 of file build/outputs/include/HepMC/GenParticle.h.

◆ status() [2/2]

int status ( ) const

inline

Get status code.

Definition at line 85 of file include/HepMC/GenParticle.h.

◆ unset_generated_mass() [1/2]

void unset_generated_mass ( )

Declare that generated mass is not set.

Definition at line 59 of file GenParticle.cc.

References GenParticleData::is_mass_set, GenParticle::m_data, and GenParticleData::mass.

◆ unset_generated_mass() [2/2]

void unset_generated_mass ( )

Declare that generated mass is not set.

Field Documentation

◆ m_data

GenParticleData m_data

private

Particle data.

Definition at line 149 of file build/outputs/include/HepMC/GenParticle.h.

◆ m_end_vertex

weak_ptr< GenVertex > m_end_vertex

private

End vertex.

Definition at line 152 of file build/outputs/include/HepMC/GenParticle.h.

◆ m_event

GenEvent * m_event

private

Parent event.

Definition at line 147 of file build/outputs/include/HepMC/GenParticle.h.

◆ m_id

int m_id

private

Index.

Definition at line 148 of file build/outputs/include/HepMC/GenParticle.h.

◆ m_production_vertex

weak_ptr< GenVertex > m_production_vertex

private

Production vertex.

Definition at line 151 of file build/outputs/include/HepMC/GenParticle.h.

◆ m_this

weak_ptr< GenParticle > m_this

private

Pointer to shared pointer managing this particle.

Definition at line 153 of file build/outputs/include/HepMC/GenParticle.h.

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

Detailed Description

Public Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ GenParticle() [1/4]

◆ GenParticle() [2/4]

◆ GenParticle() [3/4]

◆ GenParticle() [4/4]

Member Function Documentation

◆ add_attribute() [1/2]

◆ add_attribute() [2/2]

◆ ancestors() [1/2]

◆ ancestors() [2/2]

◆ attribute() [1/3]

◆ attribute() [2/3]

◆ attribute() [3/3]

◆ attribute_as_string() [1/2]

◆ attribute_as_string() [2/2]

◆ attribute_names() [1/2]

◆ attribute_names() [2/2]

◆ children() [1/2]

◆ children() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ descendants() [1/2]

◆ descendants() [2/2]

◆ end_vertex() [1/4]

◆ end_vertex() [2/4]

◆ end_vertex() [3/4]

◆ end_vertex() [4/4]

◆ generated_mass() [1/2]

◆ generated_mass() [2/2]

◆ id() [1/2]

◆ id() [2/2]

◆ in_event() [1/2]

◆ in_event() [2/2]

◆ is_generated_mass_set() [1/2]

◆ is_generated_mass_set() [2/2]

◆ momentum() [1/2]

◆ momentum() [2/2]

◆ parent_event() [1/2]

◆ parent_event() [2/2]

◆ parents() [1/2]

◆ parents() [2/2]

◆ pdg_id() [1/2]

◆ pdg_id() [2/2]

◆ pid() [1/2]

◆ pid() [2/2]

◆ production_vertex() [1/4]

◆ production_vertex() [2/4]

◆ production_vertex() [3/4]

◆ production_vertex() [4/4]

◆ remove_attribute() [1/2]

◆ remove_attribute() [2/2]

◆ set_generated_mass() [1/2]

◆ set_generated_mass() [2/2]

◆ set_momentum() [1/2]

◆ set_momentum() [2/2]

◆ set_pdg_id() [1/2]

◆ set_pdg_id() [2/2]

◆ set_pid() [1/2]

◆ set_pid() [2/2]

◆ set_status() [1/2]

◆ set_status() [2/2]

◆ status() [1/2]

◆ status() [2/2]

◆ unset_generated_mass() [1/2]

◆ unset_generated_mass() [2/2]

Field Documentation

◆ m_data

◆ m_end_vertex

◆ m_event

◆ m_id

◆ m_production_vertex

◆ m_this