edm4eic::MutableJet Class Reference

#include <MutableJet.h>

Public Types
using	object_type = Jet
using	collection_type = JetCollection

Public Member Functions
	MutableJet ()=default
	default constructor
	MutableJet (const std::uint32_t type, const float area, const float energy, const float backgroundEnergyDensity, const edm4hep::Vector3f &momentum)
	Constructor initializing all members.
	MutableJet (const MutableJet &other)=default
	copy constructor
MutableJet &	operator= (MutableJet other) &
	copy-assignment operator
MutableJet &	operator= (MutableJet other) &&=delete
MutableJet	clone (bool cloneRelations=true) const
	~MutableJet ()=default
	destructor
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].
void	setType (const std::uint32_t type)
	Set the Jet type as enumerated in fastjet::JetAlgorithm.
std::uint32_t &	getType ()
	Get mutable reference to Jet type as enumerated in fastjet::JetAlgorithm.
std::uint32_t &	type ()
	Get reference to Jet type as enumerated in fastjet::JetAlgorithm.
void	setArea (const float area)
	Set the Jet area.
float &	getArea ()
	Get mutable reference to Jet area.
float &	area ()
	Get reference to Jet area.
void	setEnergy (const float energy)
	Set the Jet energy [GeV].
float &	getEnergy ()
	Get mutable reference to Jet energy [GeV].
float &	energy ()
	Get reference to Jet energy [GeV].
void	setBackgroundEnergyDensity (const float backgroundEnergyDensity)
	Set the Background energy density [GeV/area].
float &	getBackgroundEnergyDensity ()
	Get mutable reference to Background energy density [GeV/area].
float &	backgroundEnergyDensity ()
	Get reference to Background energy density [GeV/area].
void	setMomentum (const edm4hep::Vector3f &momentum)
	Set the Jet 3-momentum [GeV].
edm4hep::Vector3f &	getMomentum ()
	Get mutable reference to Jet 3-momentum [GeV].
edm4hep::Vector3f &	momentum ()
	Get reference to Jet 3-momentum [GeV].
void	addToConstituents (const edm4eic::ReconstructedParticle &)
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 MutableJet &other) const
bool	operator== (const Jet &other) const
bool	operator!= (const MutableJet &other) const
bool	operator!= (const Jet &other) const
bool	operator< (const MutableJet &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Friends
class	JetCollection
class	JetMutableCollectionIterator
class	Jet
void	swap (MutableJet &a, MutableJet &b)

Detailed Description

A reconstructed jet, inspired by the FastJet PseudoJet

Author

: D. Anderson

Member Typedef Documentation

collection_type

using edm4eic::MutableJet::collection_type = JetCollection

object_type

using edm4eic::MutableJet::object_type = Jet

Constructor & Destructor Documentation

MutableJet() [1/3]

edm4eic::MutableJet::MutableJet ( )

default

default constructor

MutableJet() [2/3]

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

Constructor initializing all members.

MutableJet() [3/3]

edm4eic::MutableJet::MutableJet ( const MutableJet & other )

default

copy constructor

~MutableJet()

edm4eic::MutableJet::~MutableJet ( )

default

destructor

Member Function Documentation

addToConstituents()

void edm4eic::MutableJet::addToConstituents

(

const edm4eic::ReconstructedParticle &

component

)

area()

float & edm4eic::MutableJet::area

(

)

Get reference to Jet area.

backgroundEnergyDensity()

float & edm4eic::MutableJet::backgroundEnergyDensity

(

)

Get reference to Background energy density [GeV/area].

clone()

MutableJet edm4eic::MutableJet::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::MutableJet::constituents_begin

(

)

const

constituents_end()

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

(

)

const

constituents_size()

std::size_t edm4eic::MutableJet::constituents_size

(

)

const

energy()

float & edm4eic::MutableJet::energy

(

)

Get reference to Jet energy [GeV].

getArea() [1/2]

float & edm4eic::MutableJet::getArea

(

)

Get mutable reference to Jet area.

getArea() [2/2]

float edm4eic::MutableJet::getArea

(

)

const

Access the Jet area.

getBackgroundEnergy()

float edm4eic::MutableJet::getBackgroundEnergy ( ) const

inline

Compute the background energy in [GeV].

getBackgroundEnergyDensity() [1/2]

float & edm4eic::MutableJet::getBackgroundEnergyDensity

(

)

Get mutable reference to Background energy density [GeV/area].

getBackgroundEnergyDensity() [2/2]

float edm4eic::MutableJet::getBackgroundEnergyDensity

(

)

const

Access the Background energy density [GeV/area].

getConstituents() [1/2]

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

(

)

const

getConstituents() [2/2]

edm4eic::ReconstructedParticle edm4eic::MutableJet::getConstituents

(

std::size_t

index

)

const

getEnergy() [1/2]

float & edm4eic::MutableJet::getEnergy

(

)

Get mutable reference to Jet energy [GeV].

getEnergy() [2/2]

float edm4eic::MutableJet::getEnergy

(

)

const

Access the Jet energy [GeV].

getMomentum() [1/2]

edm4hep::Vector3f & edm4eic::MutableJet::getMomentum

(

)

Get mutable reference to Jet 3-momentum [GeV].

getMomentum() [2/2]

const edm4hep::Vector3f & edm4eic::MutableJet::getMomentum

(

)

const

Access the Jet 3-momentum [GeV].

getObjectID()

const podio::ObjectID edm4eic::MutableJet::getObjectID

(

)

const

getType() [1/2]

std::uint32_t & edm4eic::MutableJet::getType

(

)

Get mutable reference to Jet type as enumerated in fastjet::JetAlgorithm.

getType() [2/2]

std::uint32_t edm4eic::MutableJet::getType

(

)

const

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

id()

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

inline

isAvailable()

bool edm4eic::MutableJet::isAvailable

(

)

const

check whether the object is actually available

momentum()

edm4hep::Vector3f & edm4eic::MutableJet::momentum

(

)

Get reference to Jet 3-momentum [GeV].

operator!=() [1/2]

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

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

MutableJet & edm4eic::MutableJet::operator=

(

MutableJet

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

bool edm4eic::MutableJet::operator==

(

const Jet &

other

)

const

operator==() [2/2]

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

inline

setArea()

void edm4eic::MutableJet::setArea

(

const float

area

)

Set the Jet area.

setBackgroundEnergyDensity()

void edm4eic::MutableJet::setBackgroundEnergyDensity

(

const float

backgroundEnergyDensity

)

Set the Background energy density [GeV/area].

setEnergy()

void edm4eic::MutableJet::setEnergy

(

const float

energy

)

Set the Jet energy [GeV].

setMomentum()

void edm4eic::MutableJet::setMomentum

(

const edm4hep::Vector3f &

momentum

)

Set the Jet 3-momentum [GeV].

setType()

void edm4eic::MutableJet::setType

(

const std::uint32_t

type

)

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

type()

std::uint32_t & edm4eic::MutableJet::type

(

)

Get reference to Jet type as enumerated in fastjet::JetAlgorithm.

unlink()

void edm4eic::MutableJet::unlink ( )

inline

disconnect from JetObj instance

Friends And Related Symbol Documentation

Jet

friend class Jet

friend

JetCollection

friend class JetCollection

friend

JetMutableCollectionIterator

friend class JetMutableCollectionIterator

friend

swap

void swap ( MutableJet & a, MutableJet & b )

friend

---

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

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