Belle II Software development
Public Member Functions | Private Member Functions | Private Attributes | List of all members
TOPFrontEndSetting Class Reference
Packages » top

Front-end settings: storage depths, lookback, readout windows etc. More...

#include <TOPFrontEndSetting.h>

Inheritance diagram for TOPFrontEndSetting:

Public Member Functions

 TOPFrontEndSetting ()
 Default constructor.
 
void setWriteDepths (const std::vector< int > &depths)
 Sets write depths.
 
void setLookbackWindows (int lookback)
 Sets the number of lookback windows.
 
void setReadoutWindows (int readoutWindows)
 Sets the number of readout windows.
 
void setExtraWindows (int extra)
 Sets the number of extra windows between the one determined from lookback and the first readout window.
 
void setWindowShifts (std::vector< int > shifts)
 Sets window shifts.
 
void setOffset (int offset)
 Sets the offset of a photon peak within the readout window region.
 
const std::vector< int > & getWriteDepths () const
 Returns write depths.
 
int getLookbackWindows () const
 Returns the number of lookback windows.
 
int getReadoutWindows () const
 Returns the number of readout windows.
 
int getExtraWindows () const
 Returns the number of extra windows between the one determined from lookback and the first readout window.
 
int getWindowShift (unsigned revo9count) const
 Returns window shift at a given revo9count.
 
int getOffset () const
 Returns the offset of a photon peak within the readout window region.
 

Private Member Functions

 ClassDef (TOPFrontEndSetting, 1)
 ClassDef.
 

Private Attributes

std::vector< int > m_writeDepths
 write depths
 
int m_lookbackWindows = 0
 number of lookback windows
 
int m_readoutWindows = 0
 number of readout windows
 
int m_extraWindows = 0
 number of extra windows
 
int m_windowShifts [6] = {0}
 window shifts as a function of revo9count%6
 
int m_offset = 0
 position of photon peak within readout region [RF clocks]
 

Detailed Description

Front-end settings: storage depths, lookback, readout windows etc.

Definition at line 23 of file TOPFrontEndSetting.h.

Constructor & Destructor Documentation

◆ TOPFrontEndSetting()

TOPFrontEndSetting ( )
inline

Default constructor.

Definition at line 30 of file TOPFrontEndSetting.h.

31 {}

Member Function Documentation

◆ getExtraWindows()

int getExtraWindows ( ) const
inline

Returns the number of extra windows between the one determined from lookback and the first readout window.

These are 64-sample wide storage windows.

Returns
the number of extra windows

Definition at line 103 of file TOPFrontEndSetting.h.

103{return m_extraWindows;}
Belle2::TOPFrontEndSetting::m_extraWindows
int m_extraWindows
number of extra windows
Definition: TOPFrontEndSetting.h:124

◆ getLookbackWindows()

int getLookbackWindows ( ) const
inline

Returns the number of lookback windows.

Lookback is given as the number of 64-sample wide storage windows.

Returns
the number of lookback windows

Definition at line 88 of file TOPFrontEndSetting.h.

88{return m_lookbackWindows;}
Belle2::TOPFrontEndSetting::m_lookbackWindows
int m_lookbackWindows
number of lookback windows
Definition: TOPFrontEndSetting.h:122

◆ getOffset()

int getOffset ( ) const
inline

Returns the offset of a photon peak within the readout window region.

Returns
the offset [RF clocks]

Definition at line 116 of file TOPFrontEndSetting.h.

116{return m_offset;}
Belle2::TOPFrontEndSetting::m_offset
int m_offset
position of photon peak within readout region [RF clocks]
Definition: TOPFrontEndSetting.h:126

◆ getReadoutWindows()

int getReadoutWindows ( ) const
inline

Returns the number of readout windows.

These are 64-sample wide storage windows.

Returns
the number of readout windows

Definition at line 95 of file TOPFrontEndSetting.h.

95{return m_readoutWindows;}
Belle2::TOPFrontEndSetting::m_readoutWindows
int m_readoutWindows
number of readout windows
Definition: TOPFrontEndSetting.h:123

◆ getWindowShift()

int getWindowShift ( unsigned  revo9count) const
inline

Returns window shift at a given revo9count.

Parameters
revo9countrevo9 count
Returns
window shift

Definition at line 110 of file TOPFrontEndSetting.h.

110{return m_windowShifts[revo9count % 6];}
Belle2::TOPFrontEndSetting::m_windowShifts
int m_windowShifts[6]
window shifts as a function of revo9count%6
Definition: TOPFrontEndSetting.h:125

◆ getWriteDepths()

const std::vector< int > & getWriteDepths ( ) const
inline

Returns write depths.

Write depths are given as the number 128-sample wide write windows.

Returns
write depths

Definition at line 81 of file TOPFrontEndSetting.h.

81{return m_writeDepths;}
Belle2::TOPFrontEndSetting::m_writeDepths
std::vector< int > m_writeDepths
write depths
Definition: TOPFrontEndSetting.h:121

◆ setExtraWindows()

void setExtraWindows ( int  extra)
inline

Sets the number of extra windows between the one determined from lookback and the first readout window.

These are 64-sample wide storage windows.

Parameters
extrathe number of extra windows

Definition at line 60 of file TOPFrontEndSetting.h.

60{m_extraWindows = extra;}

◆ setLookbackWindows()

void setLookbackWindows ( int  lookback)
inline

Sets the number of lookback windows.

Lookback is given as the number of 64-sample wide storage windows.

Parameters
lookbackthe number of lookback windows

Definition at line 45 of file TOPFrontEndSetting.h.

45{m_lookbackWindows = lookback;}

◆ setOffset()

void setOffset ( int  offset)
inline

Sets the offset of a photon peak within the readout window region.

This has to be calibrated with data in a such way that the reconstructed bunch distribution peaks at zero.

Parameters
offsetoffset given in RF clocks

Definition at line 74 of file TOPFrontEndSetting.h.

74{m_offset = offset;}

◆ setReadoutWindows()

void setReadoutWindows ( int  readoutWindows)
inline

Sets the number of readout windows.

These are 64-sample wide storage windows.

Parameters
readoutWindowsthe number of readout windows

Definition at line 52 of file TOPFrontEndSetting.h.

52{m_readoutWindows = readoutWindows;}

◆ setWriteDepths()

void setWriteDepths ( const std::vector< int > &  depths)
inline

Sets write depths.

Write depths are given as the number 128-sample wide write windows.

Parameters
depthsa vector of write depths

Definition at line 38 of file TOPFrontEndSetting.h.

38{m_writeDepths = depths;}

Member Data Documentation

◆ m_extraWindows

int m_extraWindows = 0
private

number of extra windows

Definition at line 124 of file TOPFrontEndSetting.h.

◆ m_lookbackWindows

int m_lookbackWindows = 0
private

number of lookback windows

Definition at line 122 of file TOPFrontEndSetting.h.

◆ m_offset

int m_offset = 0
private

position of photon peak within readout region [RF clocks]

Definition at line 126 of file TOPFrontEndSetting.h.

◆ m_readoutWindows

int m_readoutWindows = 0
private

number of readout windows

Definition at line 123 of file TOPFrontEndSetting.h.

◆ m_windowShifts

int m_windowShifts[6] = {0}
private

window shifts as a function of revo9count%6

Definition at line 125 of file TOPFrontEndSetting.h.

◆ m_writeDepths

std::vector<int> m_writeDepths
private

write depths

Definition at line 121 of file TOPFrontEndSetting.h.

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