edm4eic::Jet Class Reference

#include <Jet.h>

Public Types
using	mutable_type = MutableJet
using	collection_type = JetCollection

Public Member Functions
	Jet ()=default
	default constructor
	Jet (const std::uint32_t type, const float area, const float energy, const float backgroundEnergyDensity, const edm4hep::Vector3f &momentum)
	Constructor initializing all members.
	Jet (const Jet &other)=default
	copy constructor
Jet &	operator= (Jet other) &
	copy-assignment operator
Jet &	operator= (Jet other) &&=delete
MutableJet	clone (bool cloneRelations=true) const
	~Jet ()=default
	destructor
	Jet (const MutableJet &other)
	converting constructor from mutable object
std::uint32_t	getType () const
	Access the Jet type as enumerated in fastjet::JetAlgorithm.
float	getArea () const
	Access the Jet area.
float	getEnergy () const
	Access the Jet energy [GeV].
float	getBackgroundEnergyDensity () const
	Access the Background energy density [GeV/area].
const edm4hep::Vector3f &	getMomentum () const
	Access the Jet 3-momentum [GeV].
std::size_t	constituents_size () const
edm4eic::ReconstructedParticle	getConstituents (std::size_t) const
std::vector< edm4eic::ReconstructedParticle >::const_iterator	constituents_begin () const
std::vector< edm4eic::ReconstructedParticle >::const_iterator	constituents_end () const
podio::RelationRange< edm4eic::ReconstructedParticle >	getConstituents () const
float	getBackgroundEnergy () const
	Compute the background energy in [GeV].
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from JetObj instance
bool	operator== (const Jet &other) const
bool	operator== (const MutableJet &other) const
bool	operator!= (const Jet &other) const
bool	operator!= (const MutableJet &other) const
bool	operator< (const Jet &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static Jet	makeEmpty ()

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::Jet"

Friends
class	MutableJet
class	JetCollection
class	edm4eic::JetCollectionData
class	JetCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const Jet &obj)
void	swap (Jet &a, Jet &b)

Detailed Description

A reconstructed jet, inspired by the FastJet PseudoJet

Author

: D. Anderson

Member Typedef Documentation

collection_type

using edm4eic::Jet::collection_type = JetCollection

mutable_type

using edm4eic::Jet::mutable_type = MutableJet

Constructor & Destructor Documentation

Jet() [1/4]

edm4eic::Jet::Jet ( )

default

default constructor

Jet() [2/4]

edm4eic::Jet::Jet	(	const std::uint32_t	type,
		const float	area,
		const float	energy,
		const float	backgroundEnergyDensity,
		const edm4hep::Vector3f &	momentum )

Constructor initializing all members.

Jet() [3/4]

edm4eic::Jet::Jet ( const Jet & other )

default

copy constructor

~Jet()

edm4eic::Jet::~Jet ( )

default

destructor

Jet() [4/4]

edm4eic::Jet::Jet

(

const MutableJet &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableJet edm4eic::Jet::clone

(

bool

cloneRelations = true

)

const

create a mutable deep-copy of the object with identical relations if cloneRelations=false, the relations are not cloned and will be empty

constituents_begin()

std::vector< edm4eic::ReconstructedParticle >::const_iterator edm4eic::Jet::constituents_begin

(

)

const

constituents_end()

std::vector< edm4eic::ReconstructedParticle >::const_iterator edm4eic::Jet::constituents_end

(

)

const

constituents_size()

std::size_t edm4eic::Jet::constituents_size

(

)

const

getArea()

float edm4eic::Jet::getArea

(

)

const

Access the Jet area.

getBackgroundEnergy()

float edm4eic::Jet::getBackgroundEnergy ( ) const

inline

Compute the background energy in [GeV].

getBackgroundEnergyDensity()

float edm4eic::Jet::getBackgroundEnergyDensity

(

)

const

Access the Background energy density [GeV/area].

getConstituents() [1/2]

podio::RelationRange< edm4eic::ReconstructedParticle > edm4eic::Jet::getConstituents

(

)

const

getConstituents() [2/2]

edm4eic::ReconstructedParticle edm4eic::Jet::getConstituents

(

std::size_t

index

)

const

getEnergy()

float edm4eic::Jet::getEnergy

(

)

const

Access the Jet energy [GeV].

getMomentum()

const edm4hep::Vector3f & edm4eic::Jet::getMomentum

(

)

const

Access the Jet 3-momentum [GeV].

getObjectID()

const podio::ObjectID edm4eic::Jet::getObjectID

(

)

const

getType()

std::uint32_t edm4eic::Jet::getType

(

)

const

Access the Jet type as enumerated in fastjet::JetAlgorithm.

id()

podio::ObjectID edm4eic::Jet::id ( ) const

inline

isAvailable()

bool edm4eic::Jet::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

Jet edm4eic::Jet::makeEmpty ( )

static

operator!=() [1/2]

bool edm4eic::Jet::operator!= ( const Jet & other ) const

inline

operator!=() [2/2]

bool edm4eic::Jet::operator!= ( const MutableJet & other ) const

inline

operator<()

bool edm4eic::Jet::operator< ( const Jet & other ) const

inline

operator=() [1/2]

Jet & edm4eic::Jet::operator=

(

Jet

other

)

&

copy-assignment operator

operator=() [2/2]

Jet & edm4eic::Jet::operator= ( Jet other ) &&

delete

operator==() [1/2]

bool edm4eic::Jet::operator== ( const Jet & other ) const

inline

operator==() [2/2]

bool edm4eic::Jet::operator==

(

const MutableJet &

other

)

const

unlink()

void edm4eic::Jet::unlink ( )

inline

disconnect from JetObj instance

Friends And Related Symbol Documentation

edm4eic::JetCollectionData

friend class edm4eic::JetCollectionData

friend

JetCollection

friend class JetCollection

friend

JetCollectionIterator

friend class JetCollectionIterator

friend

MutableJet

friend class MutableJet

friend

podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const Jet & obj )

friend

swap

void swap ( Jet & a, Jet & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::Jet::typeName = "edm4eic::Jet"

staticconstexpr

---

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

• build/edm4eic/Jet.h
• build/src/Jet.cc