Unpack algorithm for STS. More...

#include <UnpackMS.h>

Inheritance diagram for cbm::algo::sts::UnpackMS:

Collaboration diagram for cbm::algo::sts::UnpackMS:

Classes
struct	TimeSpec
	Structure to hold the current time information for the current microslice. More...

Public Types
using	Digi_t

using	Monitor_t

using	Aux_t

using	Result_t

Public Member Functions
	UnpackMS (const UnpackPar &pars)
	Default constructor.

	~UnpackMS () override
	Destructor.

Result_t	operator() (const uint8_t *msContent, const fles::MicrosliceDescriptor &msDescr, const uint64_t tTimeslice) const override
	Algorithm execution.

void	SetParams (std::unique_ptr< UnpackPar > params)
	Set the parameter container.

Private Member Functions
void	ProcessHitMessage (const stsxyter::Message &message, const TimeSpec &time, std::vector< CbmStsDigi > &digiVec, UnpackMonitorData &monitor, UnpackAuxData &aux) const
	Process a hit message.

void	ProcessTsmsbMessage (const stsxyter::Message &message, TimeSpec &time) const
	Process an epoch message (TS_MSB)

Private Attributes
UnpackPar	fParams = {}
	Parameter container.

Static Private Attributes
static constexpr uint64_t	fkEpochsPerCycle = stsxyter::kuTsMsbNbTsBinsBinning

static constexpr uint64_t	fkEpochLength = stsxyter::kuHitNbTsBinsBinning

static constexpr uint32_t	fkClockCycleNom = stsxyter::kulClockCycleNom

static constexpr uint32_t	fkClockCycleDen = stsxyter::kulClockCycleDen

static constexpr uint64_t	fkCycleLength = (fkEpochsPerCycle * fkEpochLength * fkClockCycleNom) / fkClockCycleDen

Detailed Description

Unpack algorithm for STS.

Author: Pierre-Alain Loizeau p.-a..nosp@m.loiz.nosp@m.eau@g.nosp@m.si.d.nosp@m.e; Volker Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e

Since: 25 November 2021

Definition at line 128 of file sts/UnpackMS.h.

Member Typedef Documentation

◆ Aux_t

using cbm::algo::UnpackMSBase< CbmStsDigi, UnpackMonitorData, UnpackAuxData >::Aux_t

inherited

Definition at line 23 of file UnpackMSBase.h.

◆ Digi_t

using cbm::algo::UnpackMSBase< CbmStsDigi, UnpackMonitorData, UnpackAuxData >::Digi_t

inherited

Definition at line 21 of file UnpackMSBase.h.

◆ Monitor_t

using cbm::algo::UnpackMSBase< CbmStsDigi, UnpackMonitorData, UnpackAuxData >::Monitor_t

inherited

Definition at line 22 of file UnpackMSBase.h.

◆ Result_t

using cbm::algo::UnpackMSBase< CbmStsDigi, UnpackMonitorData, UnpackAuxData >::Result_t

inherited

Definition at line 25 of file UnpackMSBase.h.

Constructor & Destructor Documentation

◆ UnpackMS()

cbm::algo::sts::UnpackMS::UnpackMS ( const UnpackPar & pars )

Default constructor.

Definition at line 23 of file sts/UnpackMS.cxx.

References fParams.

◆ ~UnpackMS()

cbm::algo::sts::UnpackMS::~UnpackMS ( )

overridedefault

Destructor.

Member Function Documentation

◆ operator()()

UnpackMS::Result_t cbm::algo::sts::UnpackMS::operator()	(	const uint8_t *	msContent,
		const fles::MicrosliceDescriptor &	msDescr,
		const uint64_t	tTimeslice ) const

overridevirtual

Algorithm execution.

Parameters

msContent	Microslice payload
msDescr	Microslice descriptor
tTimeslice	Unix start time of timeslice [ns]

Returns: STS digi data

Implements cbm::algo::UnpackMSBase< CbmStsDigi, UnpackMonitorData, UnpackAuxData >.

Definition at line 27 of file sts/UnpackMS.cxx.

References cbm::algo::sts::UnpackMS::TimeSpec::currentCycle, cbm::algo::sts::UnpackMS::TimeSpec::currentTsTime, stsxyter::Epoch, fkClockCycleDen, fkClockCycleNom, fkCycleLength, fkEpochLength, stsxyter::Hit, L_, ProcessHitMessage(), ProcessTsmsbMessage(), and stsxyter::TsMsb.

◆ ProcessHitMessage()

void cbm::algo::sts::UnpackMS::ProcessHitMessage	(	const stsxyter::Message &	message,
		const TimeSpec &	time,
		std::vector< CbmStsDigi > &	digiVec,
		UnpackMonitorData &	monitor,
		UnpackAuxData &	aux ) const

private

Process a hit message.

Parameters

message	SMX message (32-bit word)
digiVec	Vector to append the created digi to
monitor	Reference to monitor object
aux	Reference to auxiliary data object

Referenced by operator()().

◆ ProcessTsmsbMessage()

void cbm::algo::sts::UnpackMS::ProcessTsmsbMessage	(	const stsxyter::Message &	message,
		TimeSpec &	time ) const

inlineprivate

Process an epoch message (TS_MSB)

Parameters

message SMX message (32-bit word)

Definition at line 174 of file sts/UnpackMS.cxx.

References cbm::algo::sts::UnpackMS::TimeSpec::currentCycle, cbm::algo::sts::UnpackMS::TimeSpec::currentEpoch, cbm::algo::sts::UnpackMS::TimeSpec::currentEpochTime, cbm::algo::sts::UnpackMS::TimeSpec::currentTsTime, fkEpochLength, fkEpochsPerCycle, and stsxyter::Message::GetTsMsbValBinning().

Referenced by operator()().

◆ SetParams()

void cbm::algo::sts::UnpackMS::SetParams ( std::unique_ptr< UnpackPar > params )

inline

Set the parameter container.

Parameters

params Pointer to parameter container

Definition at line 151 of file sts/UnpackMS.h.

References fParams.

Member Data Documentation

◆ fkClockCycleDen

uint32_t cbm::algo::sts::UnpackMS::fkClockCycleDen = stsxyter::kulClockCycleDen

staticconstexprprivate

Definition at line 191 of file sts/UnpackMS.h.

Referenced by operator()().

◆ fkClockCycleNom

uint32_t cbm::algo::sts::UnpackMS::fkClockCycleNom = stsxyter::kulClockCycleNom

staticconstexprprivate

Clock cycle nominator [ns] and denominator. The clock cycle in ns is nominator / denominator.

Definition at line 190 of file sts/UnpackMS.h.

Referenced by operator()().

◆ fkCycleLength

uint64_t cbm::algo::sts::UnpackMS::fkCycleLength = (fkEpochsPerCycle * fkEpochLength * fkClockCycleNom) / fkClockCycleDen

staticconstexprprivate

Epoch cycle length in ns

Definition at line 194 of file sts/UnpackMS.h.

Referenced by operator()().

◆ fkEpochLength

uint64_t cbm::algo::sts::UnpackMS::fkEpochLength = stsxyter::kuHitNbTsBinsBinning

staticconstexprprivate

Length of TS_MSB epoch in clock cycles

Definition at line 187 of file sts/UnpackMS.h.

Referenced by operator()(), and ProcessTsmsbMessage().

◆ fkEpochsPerCycle

uint64_t cbm::algo::sts::UnpackMS::fkEpochsPerCycle = stsxyter::kuTsMsbNbTsBinsBinning

staticconstexprprivate

Number of TS_MSB epochs per cycle

Definition at line 184 of file sts/UnpackMS.h.

Referenced by ProcessTsmsbMessage().

◆ fParams

UnpackPar cbm::algo::sts::UnpackMS::fParams = {}

private

Parameter container.

Definition at line 181 of file sts/UnpackMS.h.

Referenced by SetParams(), and UnpackMS().

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Aux_t

◆ Digi_t

◆ Monitor_t

◆ Result_t

Constructor & Destructor Documentation

◆ UnpackMS()

◆ ~UnpackMS()

Member Function Documentation

◆ operator()()

◆ ProcessHitMessage()

◆ ProcessTsmsbMessage()

◆ SetParams()

Member Data Documentation

◆ fkClockCycleDen

◆ fkClockCycleNom

◆ fkCycleLength

◆ fkEpochLength

◆ fkEpochsPerCycle

◆ fParams