HEJ::Event Class Reference

#include <Event.hh>

Public Member Functions
	Event ()=default
	Default Event Constructor. More...
	Event (UnclusteredEvent ev, fastjet::JetDefinition const &jet_def, double min_jet_pt)
	Event Constructor adding jet clustering to an unclustered event. More...
std::vector< fastjet::PseudoJet >	jets () const
	The jets formed by the outgoing partons. More...
UnclusteredEvent const &	unclustered () const
	The corresponding event before jet clustering. More...
EventParameters const &	central () const
	Central parameter choice. More...
EventParameters &	central ()
	Central parameter choice. More...
std::array< Particle, 2 > const &	incoming () const
	Incoming particles. More...
std::vector< Particle > const &	outgoing () const
	Outgoing particles. More...
std::unordered_map< size_t, std::vector< Particle > > const &	decays () const
	Particle decays. More...
std::vector< EventParameters > const &	variations () const
	Parameter (scale) variations. More...
std::vector< EventParameters > &	variations ()
	Parameter (scale) variations. More...
EventParameters const &	variations (size_t i) const
	Parameter (scale) variation. More...
EventParameters &	variations (size_t i)
	Parameter (scale) variation. More...
std::vector< int >	particle_jet_indices (std::vector< fastjet::PseudoJet > const &jets) const
	Indices of the jets the outgoing partons belong to. More...
fastjet::JetDefinition const &	jet_def () const
	Jet definition used for clustering. More...
double	min_jet_pt () const
	Minimum jet transverse momentum. More...
event_type::EventType	type () const
	Event type. More...

Detailed Description

An event with clustered jets

This is the main HEJ 2 event class. It contains kinematic information including jet clustering, parameter (e.g. scale) settings and the event weight.

Constructor & Destructor Documentation

Event() [1/2]

HEJ::Event::Event ( )

default

Default Event Constructor.

Event() [2/2]

HEJ::Event::Event	(	UnclusteredEvent	ev,
		fastjet::JetDefinition const &	jet_def,
		double	min_jet_pt
	)

Event Constructor adding jet clustering to an unclustered event.

Member Function Documentation

central() [1/2]

EventParameters & HEJ::Event::central ( )

inline

Central parameter choice.

central() [2/2]

EventParameters const & HEJ::Event::central ( ) const

inline

Central parameter choice.

decays()

std::unordered_map< size_t, std::vector< Particle > > const & HEJ::Event::decays ( ) const

inline

Particle decays.

The key in the returned map corresponds to the index in the vector returned by outgoing()

incoming()

std::array< Particle, 2 > const & HEJ::Event::incoming ( ) const

inline

Incoming particles.

jet_def()

fastjet::JetDefinition const & HEJ::Event::jet_def ( ) const

inline

Jet definition used for clustering.

jets()

std::vector< fastjet::PseudoJet > HEJ::Event::jets

(

)

const

The jets formed by the outgoing partons.

min_jet_pt()

double HEJ::Event::min_jet_pt ( ) const

inline

Minimum jet transverse momentum.

outgoing()

std::vector< Particle > const & HEJ::Event::outgoing ( ) const

inline

Outgoing particles.

particle_jet_indices()

std::vector< int > HEJ::Event::particle_jet_indices ( std::vector< fastjet::PseudoJet > const &  jets ) const

inline

Indices of the jets the outgoing partons belong to.

Parameters

jets	Jets to be tested

Returns

A vector containing, for each outgoing parton, the index in the vector of jets the considered parton belongs to. If the parton is not inside any of the passed jets, the corresponding index is set to -1.

type()

event_type::EventType HEJ::Event::type ( ) const

inline

Event type.

unclustered()

UnclusteredEvent const & HEJ::Event::unclustered ( ) const

inline

The corresponding event before jet clustering.

variations() [1/4]

std::vector< EventParameters > & HEJ::Event::variations ( )

inline

Parameter (scale) variations.

variations() [2/4]

std::vector< EventParameters > const & HEJ::Event::variations ( ) const

inline

Parameter (scale) variations.

variations() [3/4]

EventParameters & HEJ::Event::variations ( size_t  i )

inline

Parameter (scale) variation.

Parameters

i	Index of the requested variation

variations() [4/4]

EventParameters const & HEJ::Event::variations ( size_t  i ) const

inline

Parameter (scale) variation.

Parameters

i	Index of the requested variation

---

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

• /home/andersen/HEJProjects/website/build/hej/include/HEJ/Event.hh