CbmRoot
Loading...
Searching...
No Matches
CbmSeedFinderSlidingWindow Class Reference

#include <CbmSeedFinderSlidingWindow.h>

Collaboration diagram for CbmSeedFinderSlidingWindow:
[legend]

Public Member Functions

 CbmSeedFinderSlidingWindow (std::vector< double > *vSeedTimes, int32_t minDigis, double dWindDur, double dDeadT)
 Create the CbmSeedFinderSlidingWindow object.
 
 CbmSeedFinderSlidingWindow ()=delete
 
 CbmSeedFinderSlidingWindow (const CbmSeedFinderSlidingWindow &)=delete
 
CbmSeedFinderSlidingWindow operator= (const CbmSeedFinderSlidingWindow &)=delete
 
void SetQa (bool doQA=true)
 Enable or disable the generation of QA information.
 
void OutputQa ()
 Output QA Information.
 
 ~CbmSeedFinderSlidingWindow ()
 Destructor.
 
template<class inType>
void FillSeedTimes (const std::vector< inType > *vIn, const std::vector< CbmMatch > *vDigiMatch=nullptr)
 Function which builds event seeds @params Vector of input data (either digis or digi times). @params Optional vector of digi matches (should match input data to MC events, used for QA).
 
void FillSeedTimes ()
 Function which builds event seeds without digi input. Can only be used in ideal mode.
 
void SetOffset (double offset)
 Sets a global constant offset which is applied to each trigger time @params Value of offset.
 
void SetIdealMode (const int32_t fileId=-1)
 Switches to `‘ideal mode’' in which event times from MC data are used as triggers (no algorithm is run in this case)
 
bool IsIdealMode ()
 Is `‘ideal mode’' switched on?
 
size_t GetNofSeeds ()
 Returns number of seed times currently stored in buffer.
 
void Init ()
 Initializes QA object if set.
 
template<>
double GetTime (const std::vector< double > *vIn, int32_t i)
 
template<>
double GetTime (const std::vector< double > *vIn, int32_t i)
 

Private Member Functions

template<class inType>
double GetTime (const std::vector< inType > *vIn, int32_t i)
 Fetches time at position i of either a digi vector or vector of times.
 

Private Attributes

CbmSeedFinderQafQa = nullptr
 Processes QA info.
 
std::vector< double > * fvSeedTimes = nullptr
 Output of the algorithm. Stores seed times for current time slice.
 
int32_t fminDigis = 0
 Minimum number of digis which must be found in the seed window.
 
double fdWindDur = 0.
 Size of sliding window.
 
double fdDeadT = 0.
 `‘Dead time’' i.e. time interval which is discarded after a seed is found.
 
double fdOffset = 0.
 Global time offset which is applied to each trigger time.
 
bool fbIdealMode = false
 `‘ideal mode’' uses MC truth as trigger times.
 
int32_t fIdealModeFileId = -1
 If only a single file is to be used in `‘ideal mode’' (-1 = all files).
 
CbmMCEventListfEventList = nullptr
 To access MC truth in `‘ideal mode’'.
 
CbmTimeSlicefTimeSlice = nullptr
 

Detailed Description

Definition at line 34 of file CbmSeedFinderSlidingWindow.h.

Constructor & Destructor Documentation

◆ CbmSeedFinderSlidingWindow() [1/3]

CbmSeedFinderSlidingWindow::CbmSeedFinderSlidingWindow ( std::vector< double > * vSeedTimes,
int32_t minDigis,
double dWindDur,
double dDeadT )
inline

Create the CbmSeedFinderSlidingWindow object.

Parameters
vSeedTimesOutput vector for the constructed seed times
minDigisMinimum number of digis which must be found in the seed window
dWindDurSize of sliding window
dDeadT`‘Dead time’' i.e. time interval which is discarded after a seed is found

Definition at line 43 of file CbmSeedFinderSlidingWindow.h.

References fdDeadT, fdWindDur, fminDigis, and fvSeedTimes.

Referenced by CbmSeedFinderSlidingWindow(), and operator=().

◆ CbmSeedFinderSlidingWindow() [2/3]

CbmSeedFinderSlidingWindow::CbmSeedFinderSlidingWindow ( )
delete

◆ CbmSeedFinderSlidingWindow() [3/3]

CbmSeedFinderSlidingWindow::CbmSeedFinderSlidingWindow ( const CbmSeedFinderSlidingWindow & )
delete

◆ ~CbmSeedFinderSlidingWindow()

CbmSeedFinderSlidingWindow::~CbmSeedFinderSlidingWindow ( )

Destructor.

Definition at line 24 of file CbmSeedFinderSlidingWindow.cxx.

References fQa.

Member Function Documentation

◆ FillSeedTimes() [1/2]

void CbmSeedFinderSlidingWindow::FillSeedTimes ( )

Function which builds event seeds without digi input. Can only be used in ideal mode.

Definition at line 161 of file CbmSeedFinderSlidingWindow.cxx.

References fbIdealMode, and FillSeedTimes().

Referenced by FillSeedTimes().

◆ FillSeedTimes() [2/2]

template<class inType>
void CbmSeedFinderSlidingWindow::FillSeedTimes ( const std::vector< inType > * vIn,
const std::vector< CbmMatch > * vDigiMatch = nullptr )

Function which builds event seeds @params Vector of input data (either digis or digi times). @params Optional vector of digi matches (should match input data to MC events, used for QA).

Definition at line 35 of file CbmSeedFinderSlidingWindow.cxx.

References CbmMatch::AddLink(), fbIdealMode, fdDeadT, fdOffset, fdWindDur, fEventList, fIdealModeFileId, fminDigis, fQa, fTimeSlice, fvSeedTimes, and GetTime().

◆ GetNofSeeds()

size_t CbmSeedFinderSlidingWindow::GetNofSeeds ( )
inline

Returns number of seed times currently stored in buffer.

Definition at line 90 of file CbmSeedFinderSlidingWindow.h.

References fvSeedTimes.

◆ GetTime() [1/3]

template<>
double CbmSeedFinderSlidingWindow::GetTime ( const std::vector< double > * vIn,
int32_t i )

◆ GetTime() [2/3]

template<>
double CbmSeedFinderSlidingWindow::GetTime ( const std::vector< double > * vIn,
int32_t i )

Definition at line 183 of file CbmSeedFinderSlidingWindow.cxx.

◆ GetTime() [3/3]

template<class inType>
double CbmSeedFinderSlidingWindow::GetTime ( const std::vector< inType > * vIn,
int32_t i )
private

Fetches time at position i of either a digi vector or vector of times.

Definition at line 172 of file CbmSeedFinderSlidingWindow.cxx.

Referenced by FillSeedTimes().

◆ Init()

void CbmSeedFinderSlidingWindow::Init ( )

Initializes QA object if set.

Definition at line 202 of file CbmSeedFinderSlidingWindow.cxx.

References fbIdealMode, fEventList, and fQa.

◆ IsIdealMode()

bool CbmSeedFinderSlidingWindow::IsIdealMode ( )
inline

Is `‘ideal mode’' switched on?

Definition at line 87 of file CbmSeedFinderSlidingWindow.h.

References fbIdealMode.

◆ operator=()

CbmSeedFinderSlidingWindow CbmSeedFinderSlidingWindow::operator= ( const CbmSeedFinderSlidingWindow & )
delete

◆ OutputQa()

void CbmSeedFinderSlidingWindow::OutputQa ( )

Output QA Information.

Definition at line 217 of file CbmSeedFinderSlidingWindow.cxx.

References fQa.

◆ SetIdealMode()

void CbmSeedFinderSlidingWindow::SetIdealMode ( const int32_t fileId = -1)
inline

Switches to `‘ideal mode’' in which event times from MC data are used as triggers (no algorithm is run in this case)

Definition at line 80 of file CbmSeedFinderSlidingWindow.h.

References fbIdealMode, and fIdealModeFileId.

◆ SetOffset()

void CbmSeedFinderSlidingWindow::SetOffset ( double offset)
inline

Sets a global constant offset which is applied to each trigger time @params Value of offset.

Definition at line 75 of file CbmSeedFinderSlidingWindow.h.

References fdOffset.

◆ SetQa()

void CbmSeedFinderSlidingWindow::SetQa ( bool doQA = true)

Enable or disable the generation of QA information.

Definition at line 188 of file CbmSeedFinderSlidingWindow.cxx.

References fQa.

Member Data Documentation

◆ fbIdealMode

bool CbmSeedFinderSlidingWindow::fbIdealMode = false
private

`‘ideal mode’' uses MC truth as trigger times.

Definition at line 113 of file CbmSeedFinderSlidingWindow.h.

Referenced by FillSeedTimes(), FillSeedTimes(), Init(), IsIdealMode(), and SetIdealMode().

◆ fdDeadT

double CbmSeedFinderSlidingWindow::fdDeadT = 0.
private

`‘Dead time’' i.e. time interval which is discarded after a seed is found.

Definition at line 107 of file CbmSeedFinderSlidingWindow.h.

Referenced by CbmSeedFinderSlidingWindow(), and FillSeedTimes().

◆ fdOffset

double CbmSeedFinderSlidingWindow::fdOffset = 0.
private

Global time offset which is applied to each trigger time.

Definition at line 110 of file CbmSeedFinderSlidingWindow.h.

Referenced by FillSeedTimes(), and SetOffset().

◆ fdWindDur

double CbmSeedFinderSlidingWindow::fdWindDur = 0.
private

Size of sliding window.

Definition at line 105 of file CbmSeedFinderSlidingWindow.h.

Referenced by CbmSeedFinderSlidingWindow(), and FillSeedTimes().

◆ fEventList

CbmMCEventList* CbmSeedFinderSlidingWindow::fEventList = nullptr
private

To access MC truth in `‘ideal mode’'.

Definition at line 119 of file CbmSeedFinderSlidingWindow.h.

Referenced by FillSeedTimes(), and Init().

◆ fIdealModeFileId

int32_t CbmSeedFinderSlidingWindow::fIdealModeFileId = -1
private

If only a single file is to be used in `‘ideal mode’' (-1 = all files).

Definition at line 116 of file CbmSeedFinderSlidingWindow.h.

Referenced by FillSeedTimes(), and SetIdealMode().

◆ fminDigis

int32_t CbmSeedFinderSlidingWindow::fminDigis = 0
private

Minimum number of digis which must be found in the seed window.

Definition at line 103 of file CbmSeedFinderSlidingWindow.h.

Referenced by CbmSeedFinderSlidingWindow(), and FillSeedTimes().

◆ fQa

CbmSeedFinderQa* CbmSeedFinderSlidingWindow::fQa = nullptr
private

Processes QA info.

Definition at line 97 of file CbmSeedFinderSlidingWindow.h.

Referenced by FillSeedTimes(), Init(), OutputQa(), SetQa(), and ~CbmSeedFinderSlidingWindow().

◆ fTimeSlice

CbmTimeSlice* CbmSeedFinderSlidingWindow::fTimeSlice = nullptr
private

Definition at line 122 of file CbmSeedFinderSlidingWindow.h.

Referenced by FillSeedTimes().

◆ fvSeedTimes

std::vector<double>* CbmSeedFinderSlidingWindow::fvSeedTimes = nullptr
private

Output of the algorithm. Stores seed times for current time slice.

Definition at line 100 of file CbmSeedFinderSlidingWindow.h.

Referenced by CbmSeedFinderSlidingWindow(), FillSeedTimes(), and GetNofSeeds().


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