Project
Loading...
Searching...
No Matches
o2::emcal::reconstructionerrors Namespace Reference

Enumerations

enum class  GeometryError_t { CELL_RANGE_EXCEED , CELL_INDEX_NEGATIVE , UNKNOWN_ERROR }
 
enum class  GainError_t { LGNOHG , HGNOLG , UNKNOWN_ERROR }
 
enum class  TRUDecodingError_t {
  TRU_INDEX_INVALID , PATCH_INDEX_INVALID , FASTOR_INDEX_INVALID , FASTOR_STARTTIME_INVALID ,
  UNKNOWN_ERROR
}
 

Functions

constexpr int getNumberOfGeometryErrorCodes ()
 Get the number of geometry error codes.
 
constexpr int getErrorCodeFromGeometryError (GeometryError_t errortype)
 Convert geometry error type into numberic representation.
 
GeometryError_t getGeometryErrorFromErrorCode (unsigned int errorcode)
 Convert error code to geometry error type.
 
const chargetGeometryErrorName (GeometryError_t errortype)
 Get name of a given geometry error type.
 
const chargetGeometryErrorName (unsigned int errorcode)
 Get name of a given geometry error code.
 
const chargetGeometryErrorTitle (GeometryError_t errortype)
 Get title of a given geometry error type.
 
const chargetGeometryErrorTitle (unsigned int errorcode)
 Get title of a given geometry error type.
 
const chargetGeometryErrorDescription (GeometryError_t errortype)
 Get detailed description of a given geometry error type.
 
const chargetGeometryErrorDescription (unsigned int errorcode)
 Get detailed description of a given geometry error type.
 
constexpr int getNumberOfGainErrorCodes ()
 Get the number of gain error codes.
 
constexpr int getErrorCodeFromGainError (GainError_t errortype)
 Convert gain error type into numberic representation.
 
GainError_t getGainErrorFromErrorCode (unsigned int errorcode)
 Convert error code to gain error type.
 
const chargetGainErrorName (GainError_t errortype)
 Get name of a given gain error type.
 
const chargetGainErrorName (unsigned int errorcode)
 Get name of a given gain error code.
 
const chargetGainErrorTitle (GainError_t errortype)
 Get title of a given gain error type.
 
const chargetGainErrorTitle (unsigned int errorcode)
 Get title of a given gain error type.
 
const chargetGainErrorDescription (GainError_t errortype)
 Get detailed description of a given gain error type.
 
const chargetGainErrorDescription (unsigned int errorcode)
 Get detailed description of a given gain error type.
 
constexpr int getNumberOfTRUErrorCodes ()
 Get the number of TRU error codes.
 
TRUDecodingError_t getTRUDecodingErrorFromErrorCode (unsigned int errorcode)
 Convert error code to TRU decoding error type.
 
constexpr int getErrorCodeFromTRUDecodingError (TRUDecodingError_t error)
 Convert TRU decoding error type into numberic representation.
 
const chargetTRUDecodingErrorName (TRUDecodingError_t errortype)
 Get name of a given TRU decoding error type.
 
const chargetTRUDecodingErrorName (unsigned int errorcode)
 Get name of a given TRU decoding error code.
 
const chargetTRUDecodingErrorTitle (TRUDecodingError_t errortype)
 Get title of a given TRU decoding error type.
 
const chargetTRUDecodingErrorTitle (unsigned int errorcode)
 Get title of a given TRU decoding error type.
 
const chargetTRUDecodingErrorErrorDescription (TRUDecodingError_t errortype)
 Get detailed description of a given TRU decoding error type.
 
const chargetTRUDecodingErrorErrorDescription (unsigned int errorcode)
 Get detailed description of a given TRU decoding error type.
 

Enumeration Type Documentation

◆ GainError_t

Enumerator
LGNOHG 

LG found below HG/LG transition, HG missing.

HGNOLG 

HG saturated, LG missing.

UNKNOWN_ERROR 

Unknown error code.

Definition at line 127 of file ReconstructionErrors.h.

◆ GeometryError_t

Enumerator
CELL_RANGE_EXCEED 

Requested cell value exceeding allowed cell range.

CELL_INDEX_NEGATIVE 

Requested cell value negative.

UNKNOWN_ERROR 

Unknown error code.

Definition at line 30 of file ReconstructionErrors.h.

◆ TRUDecodingError_t

Enumerator
TRU_INDEX_INVALID 

TRU index invalid.

PATCH_INDEX_INVALID 

Patch index outside range.

FASTOR_INDEX_INVALID 

FastOR index unknown.

FASTOR_STARTTIME_INVALID 

FastOr stattime is larger than 14.

UNKNOWN_ERROR 

Unknown error type.

Definition at line 224 of file ReconstructionErrors.h.

Function Documentation

◆ getErrorCodeFromGainError()

constexpr int o2::emcal::reconstructionerrors::getErrorCodeFromGainError ( GainError_t  errortype)
constexpr

Convert gain error type into numberic representation.

Parameters
errortypeGain error type
Returns
Error code connected to error type

Definition at line 140 of file ReconstructionErrors.h.

◆ getErrorCodeFromGeometryError()

constexpr int o2::emcal::reconstructionerrors::getErrorCodeFromGeometryError ( GeometryError_t  errortype)
constexpr

Convert geometry error type into numberic representation.

Parameters
errortypeGeometry error type
Returns
Error code connected to error type

Definition at line 43 of file ReconstructionErrors.h.

◆ getErrorCodeFromTRUDecodingError()

constexpr int o2::emcal::reconstructionerrors::getErrorCodeFromTRUDecodingError ( TRUDecodingError_t  error)
constexpr

Convert TRU decoding error type into numberic representation.

Parameters
errortypeTRU decoding error type
Returns
Error code connected to error type

Definition at line 248 of file ReconstructionErrors.h.

◆ getGainErrorDescription() [1/2]

const char * o2::emcal::reconstructionerrors::getGainErrorDescription ( GainError_t  errortype)

Get detailed description of a given gain error type.

Provides a long description to be used i.e. in error messages.

Parameters
errortypeError type of the gain type error
Returns
Detaied description connected to gain type error

Definition at line 133 of file ReconstructionErrors.cxx.

◆ getGainErrorDescription() [2/2]

const char * o2::emcal::reconstructionerrors::getGainErrorDescription ( unsigned int  errorcode)

Get detailed description of a given gain error type.

Provides a long description to be used i.e. in error messages. Attention: Error code must be a valid gain type error code.

Parameters
errortypeError type of the gain type error
Returns
Detaied description connected to gain type error

Definition at line 145 of file ReconstructionErrors.cxx.

◆ getGainErrorFromErrorCode()

GainError_t o2::emcal::reconstructionerrors::getGainErrorFromErrorCode ( unsigned int  errorcode)

Convert error code to gain error type.

Attention: Error code must be a valid error code, handled internally via assert.

Parameters
errorcodeError code to be converted
Returns
Error type connected to error code

Definition at line 86 of file ReconstructionErrors.cxx.

◆ getGainErrorName() [1/2]

const char * o2::emcal::reconstructionerrors::getGainErrorName ( GainError_t  errortype)

Get name of a given gain error type.

Name is a short single word descriptor used i.e. in object names.

Parameters
errortypeError type of the gain type error
Returns
Name connected to gain type error

Definition at line 99 of file ReconstructionErrors.cxx.

◆ getGainErrorName() [2/2]

const char * o2::emcal::reconstructionerrors::getGainErrorName ( unsigned int  errorcode)

Get name of a given gain error code.

Name is a short single word descriptor used i.e. in object names. Attention: Error code must be a valid gain type error code.

Parameters
errorcodeError code of the gain type error
Returns
Name connected to gain type error

Definition at line 111 of file ReconstructionErrors.cxx.

◆ getGainErrorTitle() [1/2]

const char * o2::emcal::reconstructionerrors::getGainErrorTitle ( GainError_t  errortype)

Get title of a given gain error type.

Title is a short descriptor used i.e. in histogram titles.

Parameters
errortypeError type of the gain type error
Returns
Title connected to gain type error

Definition at line 116 of file ReconstructionErrors.cxx.

◆ getGainErrorTitle() [2/2]

const char * o2::emcal::reconstructionerrors::getGainErrorTitle ( unsigned int  errorcode)

Get title of a given gain error type.

Title is a short descriptor used i.e. in histogram titles. Attention: Error code must be a valid gain type error code.

Parameters
errorcodeError code of the gain type error
Returns
Title connected to gain type error

Definition at line 128 of file ReconstructionErrors.cxx.

◆ getGeometryErrorDescription() [1/2]

const char * o2::emcal::reconstructionerrors::getGeometryErrorDescription ( GeometryError_t  errortype)

Get detailed description of a given geometry error type.

Provides a long description to be used i.e. in error messages.

Parameters
errortypeError type of the geometry error
Returns
Detaied description connected to geometry error type

Definition at line 69 of file ReconstructionErrors.cxx.

◆ getGeometryErrorDescription() [2/2]

const char * o2::emcal::reconstructionerrors::getGeometryErrorDescription ( unsigned int  errorcode)

Get detailed description of a given geometry error type.

Provides a long description to be used i.e. in error messages. Attention: Error code must be a valid geomentry error code.

Parameters
errortypeError type of the geometry error
Returns
Detaied description connected to geometry error type

Definition at line 81 of file ReconstructionErrors.cxx.

◆ getGeometryErrorFromErrorCode()

GeometryError_t o2::emcal::reconstructionerrors::getGeometryErrorFromErrorCode ( unsigned int  errorcode)

Convert error code to geometry error type.

Attention: Error code must be a valid error code, handled internally via assert.

Parameters
errorcodeError code to be converted
Returns
Error type connected to error code

Definition at line 22 of file ReconstructionErrors.cxx.

◆ getGeometryErrorName() [1/2]

const char * o2::emcal::reconstructionerrors::getGeometryErrorName ( GeometryError_t  errortype)

Get name of a given geometry error type.

Name is a short single word descriptor used i.e. in object names.

Parameters
errortypeError type of the geometry error
Returns
Name connected to geometry error type

Definition at line 35 of file ReconstructionErrors.cxx.

◆ getGeometryErrorName() [2/2]

const char * o2::emcal::reconstructionerrors::getGeometryErrorName ( unsigned int  errorcode)

Get name of a given geometry error code.

Name is a short single word descriptor used i.e. in object names. Attention: Error code must be a valid geomentry error code.

Parameters
errorcodeError code of the geometry error
Returns
Name connected to geometry error type

Definition at line 47 of file ReconstructionErrors.cxx.

◆ getGeometryErrorTitle() [1/2]

const char * o2::emcal::reconstructionerrors::getGeometryErrorTitle ( GeometryError_t  errortype)

Get title of a given geometry error type.

Title is a short descriptor used i.e. in histogram titles.

Parameters
errortypeError type of the geometry error
Returns
Title connected to geometry error type

Definition at line 52 of file ReconstructionErrors.cxx.

◆ getGeometryErrorTitle() [2/2]

const char * o2::emcal::reconstructionerrors::getGeometryErrorTitle ( unsigned int  errorcode)

Get title of a given geometry error type.

Title is a short descriptor used i.e. in histogram titles. Attention: Error code must be a valid geomentry error code.

Parameters
errorcodeError code of the geometry error
Returns
Title connected to geometry error type

Definition at line 64 of file ReconstructionErrors.cxx.

◆ getNumberOfGainErrorCodes()

constexpr int o2::emcal::reconstructionerrors::getNumberOfGainErrorCodes ( )
constexpr

Get the number of gain error codes.

Returns
Number of gain error codes

Definition at line 135 of file ReconstructionErrors.h.

◆ getNumberOfGeometryErrorCodes()

constexpr int o2::emcal::reconstructionerrors::getNumberOfGeometryErrorCodes ( )
constexpr

Get the number of geometry error codes.

Returns
Number of geometry error codes

Definition at line 38 of file ReconstructionErrors.h.

◆ getNumberOfTRUErrorCodes()

constexpr int o2::emcal::reconstructionerrors::getNumberOfTRUErrorCodes ( )
constexpr

Get the number of TRU error codes.

Returns
Number of TRU error codes

Definition at line 234 of file ReconstructionErrors.h.

◆ getTRUDecodingErrorErrorDescription() [1/2]

const char * o2::emcal::reconstructionerrors::getTRUDecodingErrorErrorDescription ( TRUDecodingError_t  errortype)

Get detailed description of a given TRU decoding error type.

Provides a long description to be used i.e. in error messages.

Parameters
errortypeError type of the TRU decoding error
Returns
Detaied description connected to TRU decoding error

Definition at line 208 of file ReconstructionErrors.cxx.

◆ getTRUDecodingErrorErrorDescription() [2/2]

const char * o2::emcal::reconstructionerrors::getTRUDecodingErrorErrorDescription ( unsigned int  errorcode)

Get detailed description of a given TRU decoding error type.

Provides a long description to be used i.e. in error messages. Attention: Error code must be a valid TRU decoding error code.

Parameters
errortypeError type of the TRU decoding error
Returns
Detaied description connected to TRU decoding error

Definition at line 224 of file ReconstructionErrors.cxx.

◆ getTRUDecodingErrorFromErrorCode()

TRUDecodingError_t o2::emcal::reconstructionerrors::getTRUDecodingErrorFromErrorCode ( unsigned int  errorcode)

Convert error code to TRU decoding error type.

Attention: Error code must be a valid error code, handled internally via assert.

Parameters
errorcodeError code to be converted
Returns
Error type connected to error code

Definition at line 150 of file ReconstructionErrors.cxx.

◆ getTRUDecodingErrorName() [1/2]

const char * o2::emcal::reconstructionerrors::getTRUDecodingErrorName ( TRUDecodingError_t  errortype)

Get name of a given TRU decoding error type.

Name is a short single word descriptor used i.e. in object names.

Parameters
errortypeError type of the TRU decoding error
Returns
Name connected to TRU decoding error type

Definition at line 166 of file ReconstructionErrors.cxx.

◆ getTRUDecodingErrorName() [2/2]

const char * o2::emcal::reconstructionerrors::getTRUDecodingErrorName ( unsigned int  errorcode)

Get name of a given TRU decoding error code.

Name is a short single word descriptor used i.e. in object names. Attention: Error code must be a valid TRU decoding error code.

Parameters
errorcodeError code of the TRU decoding error
Returns
Name connected to TRU decoding error type

Definition at line 182 of file ReconstructionErrors.cxx.

◆ getTRUDecodingErrorTitle() [1/2]

const char * o2::emcal::reconstructionerrors::getTRUDecodingErrorTitle ( TRUDecodingError_t  errortype)

Get title of a given TRU decoding error type.

Title is a short descriptor used i.e. in histogram titles.

Parameters
errortypeError type of the TRU decoding error
Returns
Title connected to TRU decoding error

Definition at line 187 of file ReconstructionErrors.cxx.

◆ getTRUDecodingErrorTitle() [2/2]

const char * o2::emcal::reconstructionerrors::getTRUDecodingErrorTitle ( unsigned int  errorcode)

Get title of a given TRU decoding error type.

Title is a short descriptor used i.e. in histogram titles. Attention: Error code must be a valid TRU decoding error code.

Parameters
errorcodeError code of the TRU decoding error
Returns
Title connected to TRU decoding error

Definition at line 203 of file ReconstructionErrors.cxx.