edm4eic::MCRecoParticleAssociation Class Reference

#include <MCRecoParticleAssociation.h>

Public Types
using	mutable_type = MutableMCRecoParticleAssociation
using	collection_type = MCRecoParticleAssociationCollection

Public Member Functions
	MCRecoParticleAssociation ()
	default constructor
	MCRecoParticleAssociation (const std::uint32_t simID, const std::uint32_t recID, const float weight)
	Constructor initializing all members.
	MCRecoParticleAssociation (const MCRecoParticleAssociation &other)=default
	copy constructor
MCRecoParticleAssociation &	operator= (MCRecoParticleAssociation other) &
	copy-assignment operator
MCRecoParticleAssociation &	operator= (MCRecoParticleAssociation other) &&=delete
MutableMCRecoParticleAssociation	clone (bool cloneRelations=true) const
	~MCRecoParticleAssociation ()=default
	destructor
	MCRecoParticleAssociation (const MutableMCRecoParticleAssociation &other)
	converting constructor from mutable object
std::uint32_t	getSimID () const
	Access the Index of corresponding MCParticle (position in MCParticles array)
std::uint32_t	getRecID () const
	Access the Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
float	getWeight () const
	Access the weight of this association.
const edm4eic::ReconstructedParticle	getRec () const
	Access the reference to the reconstructed particle.
const edm4hep::MCParticle	getSim () const
	Access the reference to the Monte-Carlo particle.
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from MCRecoParticleAssociationObj instance
bool	operator== (const MCRecoParticleAssociation &other) const
bool	operator== (const MutableMCRecoParticleAssociation &other) const
bool	operator!= (const MCRecoParticleAssociation &other) const
bool	operator!= (const MutableMCRecoParticleAssociation &other) const
bool	operator< (const MCRecoParticleAssociation &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static MCRecoParticleAssociation	makeEmpty ()

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

Friends
class	MutableMCRecoParticleAssociation
class	MCRecoParticleAssociationCollection
class	edm4eic::MCRecoParticleAssociationCollectionData
class	MCRecoParticleAssociationCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const MCRecoParticleAssociation &obj)
void	swap (MCRecoParticleAssociation &a, MCRecoParticleAssociation &b)

Detailed Description

Used to keep track of the correspondence between MC and reconstructed particles

Author

: S. Joosten

Member Typedef Documentation

collection_type

using edm4eic::MCRecoParticleAssociation::collection_type = MCRecoParticleAssociationCollection

mutable_type

using edm4eic::MCRecoParticleAssociation::mutable_type = MutableMCRecoParticleAssociation

Constructor & Destructor Documentation

MCRecoParticleAssociation() [1/4]

edm4eic::MCRecoParticleAssociation::MCRecoParticleAssociation

(

)

default constructor

MCRecoParticleAssociation() [2/4]

edm4eic::MCRecoParticleAssociation::MCRecoParticleAssociation	(	const std::uint32_t	simID,
		const std::uint32_t	recID,
		const float	weight )

Constructor initializing all members.

MCRecoParticleAssociation() [3/4]

edm4eic::MCRecoParticleAssociation::MCRecoParticleAssociation ( const MCRecoParticleAssociation & other )

default

copy constructor

~MCRecoParticleAssociation()

edm4eic::MCRecoParticleAssociation::~MCRecoParticleAssociation ( )

default

destructor

MCRecoParticleAssociation() [4/4]

edm4eic::MCRecoParticleAssociation::MCRecoParticleAssociation

(

const MutableMCRecoParticleAssociation &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableMCRecoParticleAssociation edm4eic::MCRecoParticleAssociation::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

getObjectID()

const podio::ObjectID edm4eic::MCRecoParticleAssociation::getObjectID

(

)

const

getRec()

const edm4eic::ReconstructedParticle edm4eic::MCRecoParticleAssociation::getRec

(

)

const

Access the reference to the reconstructed particle.

getRecID()

std::uint32_t edm4eic::MCRecoParticleAssociation::getRecID

(

)

const

Access the Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)

getSim()

const edm4hep::MCParticle edm4eic::MCRecoParticleAssociation::getSim

(

)

const

Access the reference to the Monte-Carlo particle.

getSimID()

std::uint32_t edm4eic::MCRecoParticleAssociation::getSimID

(

)

const

Access the Index of corresponding MCParticle (position in MCParticles array)

getWeight()

float edm4eic::MCRecoParticleAssociation::getWeight

(

)

const

Access the weight of this association.

id()

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

inline

isAvailable()

bool edm4eic::MCRecoParticleAssociation::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

MCRecoParticleAssociation edm4eic::MCRecoParticleAssociation::makeEmpty ( )

static

operator!=() [1/2]

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

inline

operator!=() [2/2]

bool edm4eic::MCRecoParticleAssociation::operator!= ( const MutableMCRecoParticleAssociation & other ) const

inline

operator<()

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

inline

operator=() [1/2]

MCRecoParticleAssociation & edm4eic::MCRecoParticleAssociation::operator=

(

MCRecoParticleAssociation

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::MCRecoParticleAssociation::operator==

(

const MutableMCRecoParticleAssociation &

other

)

const

unlink()

void edm4eic::MCRecoParticleAssociation::unlink ( )

inline

disconnect from MCRecoParticleAssociationObj instance

Friends And Related Symbol Documentation

edm4eic::MCRecoParticleAssociationCollectionData

friend class edm4eic::MCRecoParticleAssociationCollectionData

friend

MCRecoParticleAssociationCollection

friend class MCRecoParticleAssociationCollection

friend

MCRecoParticleAssociationCollectionIterator

friend class MCRecoParticleAssociationCollectionIterator

friend

MutableMCRecoParticleAssociation

friend class MutableMCRecoParticleAssociation

friend

podio::detail::getOrderKey

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

friend

swap

void swap ( MCRecoParticleAssociation & a, MCRecoParticleAssociation & b )

friend

Member Data Documentation

typeName

std::string_view edm4eic::MCRecoParticleAssociation::typeName = "edm4eic::MCRecoParticleAssociation"

staticconstexpr

---

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

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