o2::emcal::CellLabel Class Reference

cell class for MC particle IDs and their respective amplitude fraction More...

#include <CellLabel.h>

Public Member Functions
	CellLabel (std::vector< int > labels, std::vector< float > amplitudeFractions)
	Constructor using std::vector by moving NOT copying.
	CellLabel (gsl::span< const int > labels, gsl::span< const float > amplitudeFractions)
	Constructor using gsl::span.
size_t	GetLabelSize (void) const
	Getter of label size.
int32_t	GetLabel (size_t index) const
	Getter for label.
std::vector< int32_t >	GetLabels () const
	Getter for labels.
float	GetAmplitudeFraction (size_t index) const
	Getter for amplitude fraction.
std::vector< float >	GetAmplitudeFractions () const
	Getter for amplitude fractions.
int32_t	GetLeadingMCLabel () const
	Getter for label with leading amplitude fraction.

Protected Attributes
std::vector< int32_t >	mLabels
	List of MC particles that generated the cluster, ordered in deposited energy.
std::vector< float >	mAmplitudeFraction
	List of the fraction of the cell energy coming from a MC particle. Index aligns with mLabels!

Detailed Description

cell class for MC particle IDs and their respective amplitude fraction

Author

Marvin Hemmer marvi.nosp@m.n.he.nosp@m.mmer@.nosp@m.cern.nosp@m..ch, Goethe university Frankfurt

Since

December 13, 2023

Definition at line 33 of file CellLabel.h.

Constructor & Destructor Documentation

CellLabel() [1/2]

CellLabel::CellLabel	(	std::vector< int >	labels,
		std::vector< float >	amplitudeFractions
	)

Constructor using std::vector by moving NOT copying.

Parameters

labels	list of mc labels
amplitudeFractions	list of amplitude fractions

Definition at line 24 of file CellLabel.cxx.

CellLabel() [2/2]

CellLabel::CellLabel	(	gsl::span< const int >	labels,
		gsl::span< const float >	amplitudeFractions
	)

Constructor using gsl::span.

Parameters

labels	list of mc labels
amplitudeFractions	list of amplitude fractions

Definition at line 31 of file CellLabel.cxx.

Member Function Documentation

GetAmplitudeFraction()

float o2::emcal::CellLabel::GetAmplitudeFraction ( size_t  index ) const

inline

Getter for amplitude fraction.

Parameters

index

index which amplitude fraction to get

Definition at line 65 of file CellLabel.h.

GetAmplitudeFractions()

std::vector< float > o2::emcal::CellLabel::GetAmplitudeFractions ( ) const

inline

Getter for amplitude fractions.

Definition at line 68 of file CellLabel.h.

GetLabel()

int32_t o2::emcal::CellLabel::GetLabel ( size_t  index ) const

inline

Getter for label.

Parameters

index

index which label to get

Definition at line 58 of file CellLabel.h.

GetLabels()

std::vector< int32_t > o2::emcal::CellLabel::GetLabels ( ) const

inline

Getter for labels.

Definition at line 61 of file CellLabel.h.

GetLabelSize()

size_t o2::emcal::CellLabel::GetLabelSize ( void  ) const

inline

Getter of label size.

Parameters

index

index which label to get

Definition at line 54 of file CellLabel.h.

GetLeadingMCLabel()

int32_t CellLabel::GetLeadingMCLabel

(

)

const

Getter for label with leading amplitude fraction.

Definition at line 38 of file CellLabel.cxx.

Member Data Documentation

mAmplitudeFraction

std::vector<float> o2::emcal::CellLabel::mAmplitudeFraction

protected

List of the fraction of the cell energy coming from a MC particle. Index aligns with mLabels!

Definition at line 75 of file CellLabel.h.

mLabels

std::vector<int32_t> o2::emcal::CellLabel::mLabels

protected

List of MC particles that generated the cluster, ordered in deposited energy.

Definition at line 74 of file CellLabel.h.

---

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

• /home/runner/work/AliceO2/AliceO2/DataFormats/Detectors/EMCAL/include/DataFormatsEMCAL/CellLabel.h
• /home/runner/work/AliceO2/AliceO2/DataFormats/Detectors/EMCAL/src/CellLabel.cxx