edm4eic::Truthiness Class Reference

#include <Truthiness.h>

Public Types
using	mutable_type = MutableTruthiness
using	collection_type = TruthinessCollection

Public Member Functions
	Truthiness ()=default
	default constructor
	Truthiness (const float truthiness, const edm4eic::TruthinessContribution &associationContribution, const float unassociatedMCParticlesContribution, const float unassociatedRecoParticlesContribution)
	Constructor initializing all members.
	Truthiness (const Truthiness &other)=default
	copy constructor
Truthiness &	operator= (Truthiness other) &
	copy-assignment operator
Truthiness &	operator= (Truthiness other) &&=delete
MutableTruthiness	clone (bool cloneRelations=true) const
	~Truthiness ()=default
	destructor
	Truthiness (const MutableTruthiness &other)
	converting constructor from mutable object
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.
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
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
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
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 Truthiness &other) const
bool	operator== (const MutableTruthiness &other) const
bool	operator!= (const Truthiness &other) const
bool	operator!= (const MutableTruthiness &other) const
bool	operator< (const Truthiness &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static Truthiness	makeEmpty ()

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

Friends
class	MutableTruthiness
class	TruthinessCollection
class	edm4eic::TruthinessCollectionData
class	TruthinessCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const Truthiness &obj)
void	swap (Truthiness &a, Truthiness &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::Truthiness::collection_type = TruthinessCollection

mutable_type

using edm4eic::Truthiness::mutable_type = MutableTruthiness

Constructor & Destructor Documentation

Truthiness() [1/4]

edm4eic::Truthiness::Truthiness ( )

default

default constructor

Truthiness() [2/4]

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

Constructor initializing all members.

Truthiness() [3/4]

edm4eic::Truthiness::Truthiness ( const Truthiness & other )

default

copy constructor

~Truthiness()

edm4eic::Truthiness::~Truthiness ( )

default

destructor

Truthiness() [4/4]

edm4eic::Truthiness::Truthiness

(

const MutableTruthiness &

other

)

converting constructor from mutable object

Member Function Documentation

associationContributions_begin()

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

(

)

const

associationContributions_end()

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

(

)

const

associationContributions_size()

std::size_t edm4eic::Truthiness::associationContributions_size

(

)

const

associations_begin()

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

(

)

const

associations_end()

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

(

)

const

associations_size()

std::size_t edm4eic::Truthiness::associations_size

(

)

const

clone()

MutableTruthiness edm4eic::Truthiness::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()

const edm4eic::TruthinessContribution & edm4eic::Truthiness::getAssociationContribution

(

)

const

Access the Contribution from all associated particles.

getAssociationContributions() [1/2]

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

(

)

const

getAssociationContributions() [2/2]

edm4eic::TruthinessContribution edm4eic::Truthiness::getAssociationContributions

(

std::size_t

index

)

const

getAssociations() [1/2]

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

(

)

const

getAssociations() [2/2]

edm4eic::MCRecoParticleAssociation edm4eic::Truthiness::getAssociations

(

std::size_t

index

)

const

getObjectID()

const podio::ObjectID edm4eic::Truthiness::getObjectID

(

)

const

getTruthiness()

float edm4eic::Truthiness::getTruthiness

(

)

const

Access the Overall truthiness of the entire event.

getUnassociatedMCParticles() [1/2]

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

(

)

const

getUnassociatedMCParticles() [2/2]

edm4hep::MCParticle edm4eic::Truthiness::getUnassociatedMCParticles

(

std::size_t

index

)

const

getUnassociatedMCParticlesContribution()

float edm4eic::Truthiness::getUnassociatedMCParticlesContribution

(

)

const

Access the Contribution from unassociated MC particles.

getUnassociatedRecoParticles() [1/2]

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

(

)

const

getUnassociatedRecoParticles() [2/2]

edm4eic::ReconstructedParticle edm4eic::Truthiness::getUnassociatedRecoParticles

(

std::size_t

index

)

const

getUnassociatedRecoParticlesContribution()

float edm4eic::Truthiness::getUnassociatedRecoParticlesContribution

(

)

const

Access the Contribution from unassociated reconstructed particles.

id()

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

inline

isAvailable()

bool edm4eic::Truthiness::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

Truthiness edm4eic::Truthiness::makeEmpty ( )

static

operator!=() [1/2]

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

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

Truthiness & edm4eic::Truthiness::operator=

(

Truthiness

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

operator==() [1/2]

bool edm4eic::Truthiness::operator==

(

const MutableTruthiness &

other

)

const

operator==() [2/2]

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

inline

unassociatedMCParticles_begin()

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

(

)

const

unassociatedMCParticles_end()

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

(

)

const

unassociatedMCParticles_size()

std::size_t edm4eic::Truthiness::unassociatedMCParticles_size

(

)

const

unassociatedRecoParticles_begin()

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

(

)

const

unassociatedRecoParticles_end()

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

(

)

const

unassociatedRecoParticles_size()

std::size_t edm4eic::Truthiness::unassociatedRecoParticles_size

(

)

const

unlink()

void edm4eic::Truthiness::unlink ( )

inline

disconnect from TruthinessObj instance

Friends And Related Symbol Documentation

edm4eic::TruthinessCollectionData

friend class edm4eic::TruthinessCollectionData

friend

MutableTruthiness

friend class MutableTruthiness

friend

podio::detail::getOrderKey

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

friend

swap

void swap ( Truthiness & a, Truthiness & b )

friend

TruthinessCollection

friend class TruthinessCollection

friend

TruthinessCollectionIterator

friend class TruthinessCollectionIterator

friend

Member Data Documentation

typeName

std::string_view edm4eic::Truthiness::typeName = "edm4eic::Truthiness"

staticconstexpr

---

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

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