#include <CbmPsdSimpleDigitizer.h>

Inheritance diagram for CbmPsdSimpleDigitizer:

Collaboration diagram for CbmPsdSimpleDigitizer:

Public Types
typedef std::pair< std::unique_ptr< CbmPsdDigi >, std::unique_ptr< CbmMatch > >	Data
	Short for data to be handled (pair of digi and match)

Public Member Functions
	CbmPsdSimpleDigitizer ()

virtual	~CbmPsdSimpleDigitizer ()

ECbmModuleId	GetSystemId () const
	Detector system ID.

virtual InitStatus	Init ()

virtual void	Exec (Option_t *opt)

virtual void	Finish ()
	End-of-run action.

Bool_t	CheckOutput ()
	Check the output for being time-sorted.

Double_t	GetLatency () const
	Return the detector specific latency @value latency.

void	ClearOutput ()
	Clear the output arrays.

ULong64_t	FillTimeSlice (CbmTimeSlice *timeSlice)
	Move data from the DaqBuffer into the current time slice.

ULong64_t	FillTimeSlice (CbmTimeSlice *timeSlice, Double_t fillTime)
	Move data from the DaqBuffer into the current time slice.

ULong64_t	GetDaqBufferSize () const
	Size of DAQ buffer @value Number of data in the DAQ buffer.

std::string	GetDaqBufferStatus () const
	Debug output of DAQ buffer status @value String with status of DAQ buffer.

Double_t	GetDaqBufferTimeFirst () const
	Time stamp of first data in the DAQ buffer @value Time stamp of first data in the DAQ buffer.

Double_t	GetDaqBufferTimeLast () const
	Time stamp of last data in the DAQ buffer @value Time stamp of last data in the DAQ buffer.

void	RegisterOutput ()
	Register the output arrays.

void	SendData (Double_t time, CbmPsdDigi digi, CbmMatch match=nullptr)
	Send a digi and the corresponding match object to the DAQ.

virtual void	FillCustomData (Double_t, Bool_t=kTRUE)
	Fill custom data into time slice.

void	GetEventInfo ()
	Get event information.

Double_t	GetEventTime () const
	Current event time @value Start time of current event [ns].

void	SetCreateMatches (Bool_t choice=kTRUE)
	Set creation of links to MC.

void	SetEventMode (Bool_t choice=kTRUE)
	Set event-by-event mode.

void	SetInactiveChannelFile (const char *fileName)
	Set the file containing the list of inactive channels.

void	SetProduceNoise (Bool_t choice=kTRUE)
	Set production of inter-event noise.

void	SetRunStartTime (Double_t time)
	Set the run start time.

Protected Member Functions
virtual std::pair< size_t, bool >	ReadInactiveChannels ()
	Set of inactive channels, indicated by CbmAddress.

Protected Attributes
Bool_t	fEventMode

Bool_t	fProduceNoise
	Flag for event-by-event mode.

Bool_t	fCreateMatches
	Flag for production of inter-event noise.

Double_t	fRunStartTime
	Flag for creation of links to MC.

Int_t	fCurrentInput
	Start time of run [ns].

Int_t	fCurrentEvent
	Number of current input.

Int_t	fCurrentMCEntry
	Number of current MC event.

Double_t	fCurrentEventTime
	Number of current MC entry.

TString	fInactiveChannelFileName
	Time of current MC event [ns].

std::set< uint32_t >	fInactiveChannels
	Name of file with inactive channels.

Private Member Functions
	CbmPsdSimpleDigitizer (const CbmPsdSimpleDigitizer &)

CbmPsdSimpleDigitizer	operator= (const CbmPsdSimpleDigitizer &)

	ClassDef (CbmPsdSimpleDigitizer, 1)

ULong64_t	FillTimeSlice (CbmTimeSlice *timeSlice, Bool_t checkLimit, Double_t fillTime)
	Move data from the DaqBuffer into the current time slice.

bool	IsChannelActive (const CbmPsdDigi &digi)
	Test if the channel of a digi object is set active.

Private Attributes
Int_t	fNofEvents

Double_t	fNofPoints

Double_t	fNofDigis

Double_t	fTimeTot

TClonesArray *	fPointArray

TString	fBranchName
	Output branch name.

std::vector< CbmPsdDigi > *	fDigis

std::vector< CbmMatch > *	fMatches
	Output array (Digi)

std::multimap< double, Data >	fDaqBuffer
	Output array (CbmMatch)

Detailed Description

Definition at line 28 of file CbmPsdSimpleDigitizer.h.

Member Typedef Documentation

◆ Data

typedef std::pair<std::unique_ptr<CbmPsdDigi>, std::unique_ptr<CbmMatch> > CbmDigitize< CbmPsdDigi >::Data

inherited

Short for data to be handled (pair of digi and match)

Definition at line 48 of file CbmDigitize.h.

Constructor & Destructor Documentation

◆ CbmPsdSimpleDigitizer() [1/2]

CbmPsdSimpleDigitizer::CbmPsdSimpleDigitizer ( )

Default constructor

Definition at line 40 of file CbmPsdSimpleDigitizer.cxx.

References CbmDigitize< CbmPsdDigi >::CbmDigitize(), fNofDigis, fNofEvents, fNofPoints, fPointArray, and fTimeTot.

Referenced by CbmPsdSimpleDigitizer(), ClassDef(), and operator=().

◆ ~CbmPsdSimpleDigitizer()

CbmPsdSimpleDigitizer::~CbmPsdSimpleDigitizer ( )

virtual

Destructor

Definition at line 53 of file CbmPsdSimpleDigitizer.cxx.

◆ CbmPsdSimpleDigitizer() [2/2]

CbmPsdSimpleDigitizer::CbmPsdSimpleDigitizer ( const CbmPsdSimpleDigitizer & )

private

References CbmPsdSimpleDigitizer().

Member Function Documentation

◆ CheckOutput()

Bool_t CbmDigitize< CbmPsdDigi >::CheckOutput ( )

inlinevirtualinherited

Check the output for being time-sorted.

Implements CbmDigitizeBase.

Definition at line 67 of file CbmDigitize.h.

◆ ClassDef()

CbmPsdSimpleDigitizer::ClassDef	(	CbmPsdSimpleDigitizer	,
		1	)

private

References CbmPsdSimpleDigitizer().

◆ ClearOutput()

void CbmDigitize< CbmPsdDigi >::ClearOutput ( )

inlinevirtualinherited

Clear the output arrays.

Implements CbmDigitizeBase.

Definition at line 96 of file CbmDigitize.h.

◆ Exec()

void CbmPsdSimpleDigitizer::Exec ( Option_t * opt )

virtual

Virtual method Exec

Definition at line 97 of file CbmPsdSimpleDigitizer.cxx.

References CbmMatch::AddLink(), CbmDigitize< CbmPsdDigi >::fCreateMatches, CbmDigitize< CbmPsdDigi >::fCurrentEvent, CbmDigitize< CbmPsdDigi >::fCurrentEventTime, CbmDigitize< CbmPsdDigi >::fCurrentInput, CbmDigitize< CbmPsdDigi >::fCurrentMCEntry, fNofDigis, fNofEvents, fNofPoints, fPointArray, fTimeTot, CbmPsdAddress::GetAddress(), CbmDigitize< CbmPsdDigi >::GetEventInfo(), CbmPsdPoint::GetModuleID(), CbmPsdDigi::GetTime(), CbmDigitize< CbmPsdDigi >::SendData(), and sqrt().

◆ FillCustomData()

virtual void CbmDigitizeBase::FillCustomData	(	Double_t	,
		Bool_t	= kTRUE )

inlinevirtualinherited

Fill custom data into time slice.

Parameters

fillTime	Time until data can be filled
limit	If kTRUE, only data up to fillTime will be treated; otherwise, all.

This method allows the digitizer to implement additional functionality than writing digis and match objects. It will be called from CbmDaq.

Definition at line 75 of file CbmDigitizeBase.h.

◆ FillTimeSlice() [1/3]

ULong64_t CbmDigitize< CbmPsdDigi >::FillTimeSlice ( CbmTimeSlice * timeSlice )

inlinevirtualinherited

Move data from the DaqBuffer into the current time slice.

Parameters

timeSlice Pointer to current time slice object @value Number of digi objects filled into the time slice.

For regular time slices, all data with time stamp within the interval of the current time slice are moved from the buffer to the time slice. For time slices of type kFlexible or kEvent, all data will be moved.

Implements CbmDigitizeBase.

Definition at line 114 of file CbmDigitize.h.

◆ FillTimeSlice() [2/3]

ULong64_t CbmDigitize< CbmPsdDigi >::FillTimeSlice	(	CbmTimeSlice *	timeSlice,
		Bool_t	checkLimit,
		Double_t	fillTime )

inlineprivateinherited

Move data from the DaqBuffer into the current time slice.

Parameters

timeSlice	Pointer to current time slice object
fillTime	Time up to which data will be moved [ns] @value Number of digi objects filled into the time slice.

For regular time slices, all data with time stamp within the interval of the current time slice are moved from the buffer to the time slice. For time slices of type kFlexible or kEvent, all data will be moved.

If checkLimit is selected, only data with time stamp less than fillTime are moved.

Definition at line 273 of file CbmDigitize.h.

◆ FillTimeSlice() [3/3]

ULong64_t CbmDigitize< CbmPsdDigi >::FillTimeSlice	(	CbmTimeSlice *	timeSlice,
		Double_t	fillTime )

inlinevirtualinherited

Move data from the DaqBuffer into the current time slice.

Parameters

timeSlice	Pointer to current time slice object
fillTime	Time up to which data will be moved [ns] @value Number of digi objects filled into the time slice.

Move data with time stamp up to fillTime from the buffer to the time slice. For regular time slices, only data with time stamp within the time slice interval will be moved. For time slices of type kFlexible or kEvent, all data up to fillTime will be moved.

Implements CbmDigitizeBase.

Definition at line 129 of file CbmDigitize.h.

◆ Finish()

void CbmPsdSimpleDigitizer::Finish ( )

virtual

End-of-run action.

Definition at line 184 of file CbmPsdSimpleDigitizer.cxx.

References fNofDigis, fNofEvents, fNofPoints, and fTimeTot.

◆ GetDaqBufferSize()

ULong64_t CbmDigitize< CbmPsdDigi >::GetDaqBufferSize ( ) const

inlinevirtualinherited

Size of DAQ buffer @value Number of data in the DAQ buffer.

Implements CbmDigitizeBase.

Definition at line 140 of file CbmDigitize.h.

◆ GetDaqBufferStatus()

std::string CbmDigitize< CbmPsdDigi >::GetDaqBufferStatus ( ) const

inlinevirtualinherited

Debug output of DAQ buffer status @value String with status of DAQ buffer.

Implements CbmDigitizeBase.

Definition at line 148 of file CbmDigitize.h.

◆ GetDaqBufferTimeFirst()

Double_t CbmDigitize< CbmPsdDigi >::GetDaqBufferTimeFirst ( ) const

inlinevirtualinherited

Time stamp of first data in the DAQ buffer @value Time stamp of first data in the DAQ buffer.

Implements CbmDigitizeBase.

Definition at line 162 of file CbmDigitize.h.

◆ GetDaqBufferTimeLast()

Double_t CbmDigitize< CbmPsdDigi >::GetDaqBufferTimeLast ( ) const

inlinevirtualinherited

Time stamp of last data in the DAQ buffer @value Time stamp of last data in the DAQ buffer.

Implements CbmDigitizeBase.

Definition at line 174 of file CbmDigitize.h.

◆ GetEventInfo()

void CbmDigitizeBase::GetEventInfo ( )

inherited

Get event information.

MC input number, entry number and event time are taken from FairEventHeader and stored in the private data members for convenience. Note that the MC entry number need not coincide with the event number, for instance if the run does not start with the first MC entry, or in the case of mixed MC inputs to digitization.

Definition at line 107 of file CbmDigitizeBase.cxx.

Referenced by CbmPsdSimpleDigitizer::Exec().

◆ GetEventTime()

Double_t CbmDigitizeBase::GetEventTime ( ) const

inlineinherited

Current event time @value Start time of current event [ns].

Definition at line 113 of file CbmDigitizeBase.h.

◆ GetLatency()

Double_t CbmDigitize< CbmPsdDigi >::GetLatency ( ) const

inlinevirtualinherited

Return the detector specific latency @value latency.

If there is no detector sopecific implementation the return value is 0. which does not change the default value set in CbmDaq.

Implements CbmDigitizeBase.

Definition at line 92 of file CbmDigitize.h.

◆ GetSystemId()

ECbmModuleId CbmPsdSimpleDigitizer::GetSystemId ( ) const

inlinevirtual

Detector system ID.

Returns: Detector system ID [ECbmModuleId]

Implements CbmDigitizeBase.

Definition at line 38 of file CbmPsdSimpleDigitizer.h.

References kPsd.

◆ Init()

InitStatus CbmPsdSimpleDigitizer::Init ( )

virtual

Virtual method Init

Definition at line 58 of file CbmPsdSimpleDigitizer.cxx.

References CbmDigitize< CbmPsdDigi >::fInactiveChannelFileName, CbmDigitize< CbmPsdDigi >::fInactiveChannels, fNofDigis, fNofEvents, fNofPoints, fPointArray, fTimeTot, CbmDigitize< CbmPsdDigi >::ReadInactiveChannels(), and CbmDigitize< CbmPsdDigi >::RegisterOutput().

◆ IsChannelActive()

bool CbmDigitize< CbmPsdDigi >::IsChannelActive ( const CbmPsdDigi & digi )

inlineprivateinherited

Test if the channel of a digi object is set active.

Parameters

digi object

Returns: .true. if the respective channel is active

Definition at line 355 of file CbmDigitize.h.

◆ operator=()

CbmPsdSimpleDigitizer CbmPsdSimpleDigitizer::operator= ( const CbmPsdSimpleDigitizer & )

private

References CbmPsdSimpleDigitizer().

◆ ReadInactiveChannels()

std::pair< size_t, bool > CbmDigitizeBase::ReadInactiveChannels ( )

protectedvirtualinherited

Set of inactive channels, indicated by CbmAddress.

Read the list of inactive channels from file

Parameters

fileName File name

Returns: Number of channels read from file, success of file reading

Reading from the file will stop when a read error occurs. In that case, or when the file could not be opened at all, the success flag will be .false.

Definition at line 203 of file CbmDigitizeBase.cxx.

Referenced by CbmPsdSimpleDigitizer::Init().

◆ RegisterOutput()

void CbmDigitize< CbmPsdDigi >::RegisterOutput ( )

inlineinherited

Register the output arrays.

Arrays for the digis and the match objects will be created and registered as output to the ROOT tree. The current implementation uses std::vector as container.

Definition at line 189 of file CbmDigitize.h.

Referenced by CbmPsdSimpleDigitizer::Init().

◆ SendData()

void CbmDigitize< CbmPsdDigi >::SendData	(	Double_t	time,
		CbmPsdDigi *	digi,
		CbmMatch *	match = nullptr )

inlineinherited

Send a digi and the corresponding match object to the DAQ.

Parameters

time	Global time of the digi
digi	Pointer to digi object (template parameter)
match	Pointer to match object

Time is passed as a seperate parameter because the global time might be too large for some digi classes to store internally. So digis are not required to have a valid timestamp at this point. Later on when the time slices are known, the timestamp is overwritten with the relative time to the beginning of the time slice.

TODO: The interface should be unique pointers, meaning that the digitisers have to create objects by unique pointers from the start.

Definition at line 237 of file CbmDigitize.h.

Referenced by CbmPsdSimpleDigitizer::Exec().

◆ SetCreateMatches()

void CbmDigitizeBase::SetCreateMatches ( Bool_t choice = kTRUE )

inlineinherited

Set creation of links to MC.

Parameters

Choice If kTRUE, the match objects will be created

Definition at line 154 of file CbmDigitizeBase.h.

◆ SetEventMode()

void CbmDigitizeBase::SetEventMode ( Bool_t choice = kTRUE )

inlineinherited

Set event-by-event mode.

Parameters

Choice If kTRUE, the digitizer will run in event-by-event mode

Definition at line 160 of file CbmDigitizeBase.h.

◆ SetInactiveChannelFile()

void CbmDigitizeBase::SetInactiveChannelFile ( const char * fileName )

inlineinherited

Set the file containing the list of inactive channels.

Parameters

fileName Name of file

Channels are identified by their CbmAddress. The file must contain a list of addresses, one per line. Comments after the address are allowed if separated by a blank.

Definition at line 169 of file CbmDigitizeBase.h.

◆ SetProduceNoise()

void CbmDigitizeBase::SetProduceNoise ( Bool_t choice = kTRUE )

inlineinherited

Set production of inter-event noise.

Parameters

Choice If kTRUE, the digitizer will produce noise

Definition at line 175 of file CbmDigitizeBase.h.

◆ SetRunStartTime()

void CbmDigitizeBase::SetRunStartTime ( Double_t time )

inlineinherited

Set the run start time.

Parameters

Run	start time [ns]

Definition at line 181 of file CbmDigitizeBase.h.

Member Data Documentation

◆ fBranchName

TString CbmDigitize< CbmPsdDigi >::fBranchName

privateinherited

Output branch name.

Definition at line 248 of file CbmDigitize.h.

◆ fCreateMatches

Bool_t CbmDigitizeBase::fCreateMatches

protectedinherited

Flag for production of inter-event noise.

Definition at line 187 of file CbmDigitizeBase.h.

Referenced by CbmPsdSimpleDigitizer::Exec().

◆ fCurrentEvent

Int_t CbmDigitizeBase::fCurrentEvent

protectedinherited

Number of current input.

Definition at line 190 of file CbmDigitizeBase.h.

Referenced by CbmPsdSimpleDigitizer::Exec().

◆ fCurrentEventTime

Double_t CbmDigitizeBase::fCurrentEventTime

protectedinherited

Number of current MC entry.

Definition at line 192 of file CbmDigitizeBase.h.

Referenced by CbmPsdSimpleDigitizer::Exec().

◆ fCurrentInput

Int_t CbmDigitizeBase::fCurrentInput

protectedinherited

Start time of run [ns].

Definition at line 189 of file CbmDigitizeBase.h.

Referenced by CbmPsdSimpleDigitizer::Exec().

◆ fCurrentMCEntry

Int_t CbmDigitizeBase::fCurrentMCEntry

protectedinherited

Number of current MC event.

Definition at line 191 of file CbmDigitizeBase.h.

Referenced by CbmPsdSimpleDigitizer::Exec().

◆ fDaqBuffer

std::multimap<double, Data> CbmDigitize< CbmPsdDigi >::fDaqBuffer

privateinherited

Output array (CbmMatch)

DAQ buffer. Here, the digis and matches are buffered until they are filled into the time slice output (ROOT branch). The map key is the digi time.

Definition at line 257 of file CbmDigitize.h.

◆ fDigis

std::vector<CbmPsdDigi>* CbmDigitize< CbmPsdDigi >::fDigis

privateinherited

Definition at line 249 of file CbmDigitize.h.

◆ fEventMode

Bool_t CbmDigitizeBase::fEventMode

protectedinherited

Definition at line 185 of file CbmDigitizeBase.h.

◆ fInactiveChannelFileName

TString CbmDigitizeBase::fInactiveChannelFileName

protectedinherited

Time of current MC event [ns].

Definition at line 193 of file CbmDigitizeBase.h.

Referenced by CbmPsdSimpleDigitizer::Init().

◆ fInactiveChannels

std::set<uint32_t> CbmDigitizeBase::fInactiveChannels

protectedinherited

Name of file with inactive channels.

Definition at line 194 of file CbmDigitizeBase.h.

Referenced by CbmPsdSimpleDigitizer::Init().

◆ fMatches

std::vector<CbmMatch>* CbmDigitize< CbmPsdDigi >::fMatches

privateinherited

Output array (Digi)

Definition at line 250 of file CbmDigitize.h.

◆ fNofDigis

Double_t CbmPsdSimpleDigitizer::fNofDigis

private

Definition at line 56 of file CbmPsdSimpleDigitizer.h.

Referenced by CbmPsdSimpleDigitizer(), Exec(), Finish(), and Init().

◆ fNofEvents

Int_t CbmPsdSimpleDigitizer::fNofEvents

private

Definition at line 54 of file CbmPsdSimpleDigitizer.h.

Referenced by CbmPsdSimpleDigitizer(), Exec(), Finish(), and Init().

◆ fNofPoints

Double_t CbmPsdSimpleDigitizer::fNofPoints

private

Definition at line 55 of file CbmPsdSimpleDigitizer.h.

Referenced by CbmPsdSimpleDigitizer(), Exec(), Finish(), and Init().

◆ fPointArray

TClonesArray* CbmPsdSimpleDigitizer::fPointArray

private

Input array of CbmPsdPoints

Definition at line 60 of file CbmPsdSimpleDigitizer.h.

Referenced by CbmPsdSimpleDigitizer(), Exec(), and Init().

◆ fProduceNoise

Bool_t CbmDigitizeBase::fProduceNoise

protectedinherited

Flag for event-by-event mode.

Definition at line 186 of file CbmDigitizeBase.h.

◆ fRunStartTime

Double_t CbmDigitizeBase::fRunStartTime

protectedinherited

Flag for creation of links to MC.

Definition at line 188 of file CbmDigitizeBase.h.

◆ fTimeTot

Double_t CbmPsdSimpleDigitizer::fTimeTot

private

Definition at line 57 of file CbmPsdSimpleDigitizer.h.

Referenced by CbmPsdSimpleDigitizer(), Exec(), Finish(), and Init().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Data

Constructor & Destructor Documentation

◆ CbmPsdSimpleDigitizer() [1/2]

◆ ~CbmPsdSimpleDigitizer()

◆ CbmPsdSimpleDigitizer() [2/2]

Member Function Documentation

◆ CheckOutput()

◆ ClassDef()

◆ ClearOutput()

◆ Exec()

◆ FillCustomData()

◆ FillTimeSlice() [1/3]

◆ FillTimeSlice() [2/3]

◆ FillTimeSlice() [3/3]

◆ Finish()

◆ GetDaqBufferSize()

◆ GetDaqBufferStatus()

◆ GetDaqBufferTimeFirst()

◆ GetDaqBufferTimeLast()

◆ GetEventInfo()

◆ GetEventTime()

◆ GetLatency()

◆ GetSystemId()

◆ Init()

◆ IsChannelActive()

◆ operator=()

◆ ReadInactiveChannels()

◆ RegisterOutput()

◆ SendData()

◆ SetCreateMatches()

◆ SetEventMode()

◆ SetInactiveChannelFile()

◆ SetProduceNoise()

◆ SetRunStartTime()

Member Data Documentation

◆ fBranchName

◆ fCreateMatches

◆ fCurrentEvent

◆ fCurrentEventTime

◆ fCurrentInput

◆ fCurrentMCEntry

◆ fDaqBuffer

◆ fDigis

◆ fEventMode

◆ fInactiveChannelFileName

◆ fInactiveChannels

◆ fMatches

◆ fNofDigis

◆ fNofEvents

◆ fNofPoints

◆ fPointArray

◆ fProduceNoise

◆ fRunStartTime

◆ fTimeTot