edm4eic::MutableTruthiness Class Reference

#include <MutableTruthiness.h>

Public Types
using	object_type = Truthiness
using	collection_type = TruthinessCollection

Public Member Functions
	MutableTruthiness ()
	default constructor
	MutableTruthiness (const float truthiness, const edm4eic::TruthinessContribution &associationContribution, const float unassociatedMCParticlesContribution, const float unassociatedRecoParticlesContribution)
	Constructor initializing all members.
	MutableTruthiness (const MutableTruthiness &other)=default
	copy constructor
MutableTruthiness &	operator= (MutableTruthiness other) &
	copy-assignment operator
MutableTruthiness &	operator= (MutableTruthiness other) &&=delete
MutableTruthiness	clone (bool cloneRelations=true) const
	~MutableTruthiness ()=default
	destructor
float	getTruthiness () const
	Access the Overall truthiness of the entire event.
const edm4eic::TruthinessContribution &	getAssociationContribution () const
	Access the Contribution from all associated particles.
float	getUnassociatedMCParticlesContribution () const
	Access the Contribution from unassociated MC particles.
float	getUnassociatedRecoParticlesContribution () const
	Access the Contribution from unassociated reconstructed particles.
void	setTruthiness (const float truthiness)
	Set the Overall truthiness of the entire event.
float &	getTruthiness ()
	Get mutable reference to Overall truthiness of the entire event.
float &	truthiness ()
	Get reference to Overall truthiness of the entire event.
void	setAssociationContribution (const edm4eic::TruthinessContribution &associationContribution)
	Set the Contribution from all associated particles.
edm4eic::TruthinessContribution &	getAssociationContribution ()
	Get mutable reference to Contribution from all associated particles.
edm4eic::TruthinessContribution &	associationContribution ()
	Get reference to Contribution from all associated particles.
void	setUnassociatedMCParticlesContribution (const float unassociatedMCParticlesContribution)
	Set the Contribution from unassociated MC particles.
float &	getUnassociatedMCParticlesContribution ()
	Get mutable reference to Contribution from unassociated MC particles.
float &	unassociatedMCParticlesContribution ()
	Get reference to Contribution from unassociated MC particles.
void	setUnassociatedRecoParticlesContribution (const float unassociatedRecoParticlesContribution)
	Set the Contribution from unassociated reconstructed particles.
float &	getUnassociatedRecoParticlesContribution ()
	Get mutable reference to Contribution from unassociated reconstructed particles.
float &	unassociatedRecoParticlesContribution ()
	Get reference to Contribution from unassociated reconstructed particles.
void	addToAssociations (const edm4eic::MCRecoParticleAssociation &)
std::size_t	associations_size () const
edm4eic::MCRecoParticleAssociation	getAssociations (std::size_t) const
std::vector< edm4eic::MCRecoParticleAssociation >::const_iterator	associations_begin () const
std::vector< edm4eic::MCRecoParticleAssociation >::const_iterator	associations_end () const
podio::RelationRange< edm4eic::MCRecoParticleAssociation >	getAssociations () const
void	addToUnassociatedMCParticles (const edm4hep::MCParticle &)
std::size_t	unassociatedMCParticles_size () const
edm4hep::MCParticle	getUnassociatedMCParticles (std::size_t) const
std::vector< edm4hep::MCParticle >::const_iterator	unassociatedMCParticles_begin () const
std::vector< edm4hep::MCParticle >::const_iterator	unassociatedMCParticles_end () const
podio::RelationRange< edm4hep::MCParticle >	getUnassociatedMCParticles () const
void	addToUnassociatedRecoParticles (const edm4eic::ReconstructedParticle &)
std::size_t	unassociatedRecoParticles_size () const
edm4eic::ReconstructedParticle	getUnassociatedRecoParticles (std::size_t) const
std::vector< edm4eic::ReconstructedParticle >::const_iterator	unassociatedRecoParticles_begin () const
std::vector< edm4eic::ReconstructedParticle >::const_iterator	unassociatedRecoParticles_end () const
podio::RelationRange< edm4eic::ReconstructedParticle >	getUnassociatedRecoParticles () const
void	addToAssociationContributions (const edm4eic::TruthinessContribution &)
std::size_t	associationContributions_size () const
edm4eic::TruthinessContribution	getAssociationContributions (std::size_t) const
std::vector< edm4eic::TruthinessContribution >::const_iterator	associationContributions_begin () const
std::vector< edm4eic::TruthinessContribution >::const_iterator	associationContributions_end () const
podio::RelationRange< edm4eic::TruthinessContribution >	getAssociationContributions () const
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from TruthinessObj instance
bool	operator== (const MutableTruthiness &other) const
bool	operator== (const Truthiness &other) const
bool	operator!= (const MutableTruthiness &other) const
bool	operator!= (const Truthiness &other) const
bool	operator< (const MutableTruthiness &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Friends
class	TruthinessCollection
class	TruthinessMutableCollectionIterator
class	Truthiness
void	swap (MutableTruthiness &a, MutableTruthiness &b)

Detailed Description

Positive-definite convex norm of how confidently wrong the reconstruction is, with non-negative contributions from various aspects of the reconstruction, where a zero value indicates a perfect reconstruction.

Author

: W. Deconinck, S. Colbert

Member Typedef Documentation

collection_type

using edm4eic::MutableTruthiness::collection_type = TruthinessCollection

object_type

using edm4eic::MutableTruthiness::object_type = Truthiness

Constructor & Destructor Documentation

MutableTruthiness() [1/3]

edm4eic::MutableTruthiness::MutableTruthiness

(

)

default constructor

MutableTruthiness() [2/3]

edm4eic::MutableTruthiness::MutableTruthiness	(	const float	truthiness,
		const edm4eic::TruthinessContribution &	associationContribution,
		const float	unassociatedMCParticlesContribution,
		const float	unassociatedRecoParticlesContribution )

Constructor initializing all members.

MutableTruthiness() [3/3]

edm4eic::MutableTruthiness::MutableTruthiness ( const MutableTruthiness & other )

default

copy constructor

~MutableTruthiness()

edm4eic::MutableTruthiness::~MutableTruthiness ( )

default

destructor

Member Function Documentation

addToAssociationContributions()

void edm4eic::MutableTruthiness::addToAssociationContributions

(

const edm4eic::TruthinessContribution &

component

)

addToAssociations()

void edm4eic::MutableTruthiness::addToAssociations

(

const edm4eic::MCRecoParticleAssociation &

component

)

addToUnassociatedMCParticles()

void edm4eic::MutableTruthiness::addToUnassociatedMCParticles

(

const edm4hep::MCParticle &

component

)

addToUnassociatedRecoParticles()

void edm4eic::MutableTruthiness::addToUnassociatedRecoParticles

(

const edm4eic::ReconstructedParticle &

component

)

associationContribution()

edm4eic::TruthinessContribution & edm4eic::MutableTruthiness::associationContribution

(

)

Get reference to Contribution from all associated particles.

associationContributions_begin()

std::vector< edm4eic::TruthinessContribution >::const_iterator edm4eic::MutableTruthiness::associationContributions_begin

(

)

const

associationContributions_end()

std::vector< edm4eic::TruthinessContribution >::const_iterator edm4eic::MutableTruthiness::associationContributions_end

(

)

const

associationContributions_size()

std::size_t edm4eic::MutableTruthiness::associationContributions_size

(

)

const

associations_begin()

std::vector< edm4eic::MCRecoParticleAssociation >::const_iterator edm4eic::MutableTruthiness::associations_begin

(

)

const

associations_end()

std::vector< edm4eic::MCRecoParticleAssociation >::const_iterator edm4eic::MutableTruthiness::associations_end

(

)

const

associations_size()

std::size_t edm4eic::MutableTruthiness::associations_size

(

)

const

clone()

MutableTruthiness edm4eic::MutableTruthiness::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

getAssociationContribution() [1/2]

edm4eic::TruthinessContribution & edm4eic::MutableTruthiness::getAssociationContribution

(

)

Get mutable reference to Contribution from all associated particles.

getAssociationContribution() [2/2]

const edm4eic::TruthinessContribution & edm4eic::MutableTruthiness::getAssociationContribution

(

)

const

Access the Contribution from all associated particles.

getAssociationContributions() [1/2]

podio::RelationRange< edm4eic::TruthinessContribution > edm4eic::MutableTruthiness::getAssociationContributions

(

)

const

getAssociationContributions() [2/2]

edm4eic::TruthinessContribution edm4eic::MutableTruthiness::getAssociationContributions

(

std::size_t

index

)

const

getAssociations() [1/2]

podio::RelationRange< edm4eic::MCRecoParticleAssociation > edm4eic::MutableTruthiness::getAssociations

(

)

const

getAssociations() [2/2]

edm4eic::MCRecoParticleAssociation edm4eic::MutableTruthiness::getAssociations

(

std::size_t

index

)

const

getObjectID()

const podio::ObjectID edm4eic::MutableTruthiness::getObjectID

(

)

const

getTruthiness() [1/2]

float & edm4eic::MutableTruthiness::getTruthiness

(

)

Get mutable reference to Overall truthiness of the entire event.

getTruthiness() [2/2]

float edm4eic::MutableTruthiness::getTruthiness

(

)

const

Access the Overall truthiness of the entire event.

getUnassociatedMCParticles() [1/2]

podio::RelationRange< edm4hep::MCParticle > edm4eic::MutableTruthiness::getUnassociatedMCParticles

(

)

const

getUnassociatedMCParticles() [2/2]

edm4hep::MCParticle edm4eic::MutableTruthiness::getUnassociatedMCParticles

(

std::size_t

index

)

const

getUnassociatedMCParticlesContribution() [1/2]

float & edm4eic::MutableTruthiness::getUnassociatedMCParticlesContribution

(

)

Get mutable reference to Contribution from unassociated MC particles.

getUnassociatedMCParticlesContribution() [2/2]

float edm4eic::MutableTruthiness::getUnassociatedMCParticlesContribution

(

)

const

Access the Contribution from unassociated MC particles.

getUnassociatedRecoParticles() [1/2]

podio::RelationRange< edm4eic::ReconstructedParticle > edm4eic::MutableTruthiness::getUnassociatedRecoParticles

(

)

const

getUnassociatedRecoParticles() [2/2]

edm4eic::ReconstructedParticle edm4eic::MutableTruthiness::getUnassociatedRecoParticles

(

std::size_t

index

)

const

getUnassociatedRecoParticlesContribution() [1/2]

float & edm4eic::MutableTruthiness::getUnassociatedRecoParticlesContribution

(

)

Get mutable reference to Contribution from unassociated reconstructed particles.

getUnassociatedRecoParticlesContribution() [2/2]

float edm4eic::MutableTruthiness::getUnassociatedRecoParticlesContribution

(

)

const

Access the Contribution from unassociated reconstructed particles.

id()

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

inline

isAvailable()

bool edm4eic::MutableTruthiness::isAvailable

(

)

const

check whether the object is actually available

operator!=() [1/2]

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

inline

operator!=() [2/2]

bool edm4eic::MutableTruthiness::operator!= ( const Truthiness & other ) const

inline

operator<()

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

inline

operator=() [1/2]

MutableTruthiness & edm4eic::MutableTruthiness::operator=

(

MutableTruthiness

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::MutableTruthiness::operator==

(

const Truthiness &

other

)

const

setAssociationContribution()

void edm4eic::MutableTruthiness::setAssociationContribution

(

const edm4eic::TruthinessContribution &

associationContribution

)

Set the Contribution from all associated particles.

setTruthiness()

void edm4eic::MutableTruthiness::setTruthiness

(

const float

truthiness

)

Set the Overall truthiness of the entire event.

setUnassociatedMCParticlesContribution()

void edm4eic::MutableTruthiness::setUnassociatedMCParticlesContribution

(

const float

unassociatedMCParticlesContribution

)

Set the Contribution from unassociated MC particles.

setUnassociatedRecoParticlesContribution()

void edm4eic::MutableTruthiness::setUnassociatedRecoParticlesContribution

(

const float

unassociatedRecoParticlesContribution

)

Set the Contribution from unassociated reconstructed particles.

truthiness()

float & edm4eic::MutableTruthiness::truthiness

(

)

Get reference to Overall truthiness of the entire event.

unassociatedMCParticles_begin()

std::vector< edm4hep::MCParticle >::const_iterator edm4eic::MutableTruthiness::unassociatedMCParticles_begin

(

)

const

unassociatedMCParticles_end()

std::vector< edm4hep::MCParticle >::const_iterator edm4eic::MutableTruthiness::unassociatedMCParticles_end

(

)

const

unassociatedMCParticles_size()

std::size_t edm4eic::MutableTruthiness::unassociatedMCParticles_size

(

)

const

unassociatedMCParticlesContribution()

float & edm4eic::MutableTruthiness::unassociatedMCParticlesContribution

(

)

Get reference to Contribution from unassociated MC particles.

unassociatedRecoParticles_begin()

std::vector< edm4eic::ReconstructedParticle >::const_iterator edm4eic::MutableTruthiness::unassociatedRecoParticles_begin

(

)

const

unassociatedRecoParticles_end()

std::vector< edm4eic::ReconstructedParticle >::const_iterator edm4eic::MutableTruthiness::unassociatedRecoParticles_end

(

)

const

unassociatedRecoParticles_size()

std::size_t edm4eic::MutableTruthiness::unassociatedRecoParticles_size

(

)

const

unassociatedRecoParticlesContribution()

float & edm4eic::MutableTruthiness::unassociatedRecoParticlesContribution

(

)

Get reference to Contribution from unassociated reconstructed particles.

unlink()

void edm4eic::MutableTruthiness::unlink ( )

inline

disconnect from TruthinessObj instance

Friends And Related Symbol Documentation

swap

void swap ( MutableTruthiness & a, MutableTruthiness & b )

friend

Truthiness

friend class Truthiness

friend

TruthinessCollection

friend class TruthinessCollection

friend

TruthinessMutableCollectionIterator

friend class TruthinessMutableCollectionIterator

friend

---

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

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