Project
Loading...
Searching...
No Matches
o2::emcal::CellLabel Class Reference

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

#include <CellLabel.h>

Public Member Functions

 CellLabel (const gsl::span< const int > labels, const gsl::span< const float > amplitudeFractions)
 Constructor.
 
size_t GetLabelSize (void) const
 Getter of label size.
 
int32_t GetLabel (size_t index) const
 Getter for label.
 
gsl::span< const int32_t > GetLabels () const
 Getter for labels.
 
float GetAmplitudeFraction (size_t index) const
 Getter for amplitude fraction.
 
gsl::span< const float > GetAmplitudeFractions () const
 Getter for amplitude fractions.
 
int32_t GetLeadingMCLabel () const
 Getter for label with leading amplitude fraction.
 

Protected Attributes

gsl::span< const int32_t > mLabels
 List of MC particles that generated the cluster, ordered in deposited energy.
 
gsl::span< const 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 32 of file CellLabel.h.

Constructor & Destructor Documentation

◆ CellLabel()

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

Constructor.

Parameters
labelslist of mc labels
amplitudeFractionslist of amplitude fractions

Definition at line 22 of file CellLabel.cxx.

Member Function Documentation

◆ GetAmplitudeFraction()

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

Getter for amplitude fraction.

Parameters
indexindex which amplitude fraction to get

Definition at line 59 of file CellLabel.h.

◆ GetAmplitudeFractions()

gsl::span< const float > o2::emcal::CellLabel::GetAmplitudeFractions ( ) const
inline

Getter for amplitude fractions.

Definition at line 62 of file CellLabel.h.

◆ GetLabel()

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

Getter for label.

Parameters
indexindex which label to get

Definition at line 52 of file CellLabel.h.

◆ GetLabels()

gsl::span< const int32_t > o2::emcal::CellLabel::GetLabels ( ) const
inline

Getter for labels.

Definition at line 55 of file CellLabel.h.

◆ GetLabelSize()

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

Getter of label size.

Parameters
indexindex which label to get

Definition at line 48 of file CellLabel.h.

◆ GetLeadingMCLabel()

int32_t CellLabel::GetLeadingMCLabel ( ) const

Getter for label with leading amplitude fraction.

Definition at line 29 of file CellLabel.cxx.

Member Data Documentation

◆ mAmplitudeFraction

gsl::span<const 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 69 of file CellLabel.h.

◆ mLabels

gsl::span<const int32_t> o2::emcal::CellLabel::mLabels
protected

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

Definition at line 68 of file CellLabel.h.


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