This class is the interface between TSim/basf2 TSF module and the firmware simulation core of XSim/ISim. More...

#include <CDCTriggerTSFFirmwareModule.h>

Inheritance diagram for CDCTriggerTSFFirmwareModule:

Public Types
enum	EModulePropFlags { c_Input = 1 , c_Output = 2 , c_ParallelProcessingCertified = 4 , c_HistogramManager = 8 , c_InternalSerializer = 16 , c_TerminateInAllProcesses = 32 , c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...

typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	CDCTriggerTSFFirmwareModule ()
	Constructor.

void	initialize () override
	spawn child process for workers, open pipes to pass data

void	terminate () override
	close the pipes and wait for children to die.

void	event () override
	Things to do for each event.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.

virtual void	beginRun ()
	Called when entering a new run.

virtual void	endRun ()
	This method is called if the current run ends.

const std::string &	getName () const
	Returns the name of the module.

const std::string &	getType () const
	Returns the type of the module (i.e.

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module.

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.

bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module.

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Static Public Attributes
static constexpr int	m_nSubModules = 5
	number of TSF to simulate

static constexpr std::array< int, 9 >	nMergers = {10, 10, 12, 14, 16, 18, 20, 22, 24}
	number of mergers in each super layer

static constexpr std::array< int, m_nSubModules >	nAxialMergers = {10, 12, 16, 20, 24}
	number of mergers in axial super layers

static constexpr int	nTrackers = 4
	number of trackers

static constexpr int	mergerWidth = 256
	merger output data width

static constexpr int	width_out = 429
	width of output data width

static constexpr int	nWiresInMerger = 80
	number of wire/cell in a single merger unit

static constexpr int	nCellsInLayer = 16
	Number of wire/cells in a single layer per merger unit.

static constexpr int	nSegmentsInMerger = 16
	number of track segments in a single merger unit

static constexpr size_t	timeWidth = 4
	bit width for priority time and fast time

static constexpr int	m_nClockPerEvent = 44
	how many clocks to simulate per event

static constexpr int	clockPeriod = 16
	data clock period (32ns) in unit of 2ns

Protected Types
using	outputVector = std::array< char, width_out >
	output vector

using	outputArray = std::array< outputVector, nTrackers >
	output array

using	signalBus = std::array< outputArray, m_nSubModules >
	signal bus

using	signalBitStream = Bitstream< signalBus >
	signal bit stream

using	mergerVector = std::bitset< mergerWidth >
	Merger vector.

using	mergerOutput = std::vector< mergerVector >
	Merger output.

using	mergerOutArray = std::array< mergerOutput, m_nSubModules >
	Merger output array.

using	inputVector = std::array< char, mergerWidth >
	input array

using	inputFromMerger = std::vector< inputVector >
	input array from Merger

using	inputToTSFArray = std::array< inputFromMerger, m_nSubModules >
	input array to TSF

using	streamPair = std::array< FILE *, 2 >
	file handlers of pipes

using	timeVec = std::bitset< timeWidth >
	element of data structure to hold merger output

template<size_t nEdges>
using	mergerStructElement = std::tuple< std::array< timeVec, nSegmentsInMerger >, std::array< timeVec, nSegmentsInMerger >, std::array< timeVec, nEdges >, std::array< std::bitset< nWiresInMerger >, 1 >, std::array< std::bitset< nSegmentsInMerger >, 1 > >
	data structure to hold merger output <priority time (4 bits x 16), fast time (4 bits x 16), edge timing (4 bits x 3 or 5), hitmap (80 bits x 1), 2nd priority hit (16 bit x 1)>

template<size_t nEdges>
using	mergerStruct = std::vector< mergerStructElement< nEdges > >
	data structure to hold merger output

using	registeredStructElement = std::array< std::bitset< nCellsInLayer >, 3 >
	record when a time slow has been registered by a hit <priority time, fast time, edge timing>

using	registeredStruct = std::vector< registeredStructElement >
	vector of registeredStructElement

using	priorityHitInMerger = std::map< unsigned, int >
	priority hits map in Merger

using	priorityHitStructInSL = std::vector< priorityHitInMerger >
	priority hits map in Merger for a SL

using	priorityHitStructInClock = std::map< unsigned, priorityHitStructInSL >
	priority hits map in Merger for a clock

using	priorityHitStruct = std::array< priorityHitStructInClock, m_nClockPerEvent >
	all priority hits map in Merger

using	WireSet = std::vector< short >
	Wire set.

using	TSMap = std::unordered_map< short, WireSet >
	TS map.

using	edgeMap = std::unordered_map< unsigned short, timeVec * >
	edge wire list

using	cellList = std::vector< unsigned short >
	cell list

using	edgeList = std::unordered_map< unsigned short, std::vector< unsigned short > >
	edge wire list

Protected Member Functions
template<int iSL>
char *	getData (inputToTSFArray)
	get the XSI compliant format from the bits format TSF input

void	write (const char message, FILE outstream)
	write TSF input signals to the worker

outputArray	read (FILE *instream)
	write TSF output signals from the worker

CDCTrigger::Priority	priority (int index)
	write TSF input signals to the worker

unsigned short	trgTime (int index, int iFirstHit)
	Get the trigger time of the CDC hit.

unsigned short	mergerCellID (int index)
	Get the cell ID in the merger.

unsigned short	mergerNumber (int index)
	Get the merger unit ID in a super layer.

WireSet	segmentID (int iHit)
	Get the list of associated track segments with a hit.

std::bitset< 4 >	timeStamp (int index, int iFirstHit)
	Get the trigger time stamp of a hit.

void	computeEdges ()
	Compute the map from merger cell ID to all its related edge fields.

void	initializeMerger ()
	Get CDC hits from the DataStore and distribute them to clocks.

void	simulateMerger (unsigned iclock)
	Simulate 1 clock of merger.

template<CDCTrigger::MergerOut field, size_t width>
void	pack (inputVector::reverse_iterator &rInput, unsigned number, mergerStructElement< 5 > &output)
	Pack the merger output data structure to TSF input vector.

bool	notHit (CDCTrigger::MergerOut field, unsigned iTS, registeredStructElement &reg)
	Whether a time field in a merger has been hit in the clock cycle.

void	registerHit (CDCTrigger::MergerOut field, unsigned iTS, registeredStructElement &reg)
	Register the timing field so that later hits won't overwrite it.

void	saveFirmwareOutput ()
	save firmware output

void	saveFastOutput (short iclock)
	save fast TSIM output

void	setSecondPriority (unsigned priTS, unsigned iHit, timeVec hitTime, unsigned lr, mergerStructElement< 5 > &mergerData, registeredStructElement &registeredCell, priorityHitInMerger &priorityHit)
	set 2nd priority info

virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.

virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.

virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

void	setDescription (const std::string &description)
	Sets the description of the module.

void	setType (const std::string &type)
	Set the module type.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.

void	setReturnValue (int value)
	Sets the return value for this module as integer.

void	setReturnValue (bool value)
	Sets the return value for this module as bool.

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Protected Attributes
std::string	m_hitCollectionName
	Name of the StoreArray containing the input CDC hits.

std::string	m_outputCollectionName
	Name of the StoreArray holding the found TS hits.

std::string	m_outputBitstreamNameTo2D
	Name of the StoreArray holding the raw bit content to 2D trackers.

std::string	m_outputBitstreamNameToETF
	Name of the StoreArray holding the raw bit content to ETF.

Belle2::StoreArray< CDCHit >	m_cdcHits
	CDCHit array.

StoreArray< signalBitStream >	m_bitsTo2D
	bitstream of TSF output to 2D tracker

StoreArray< CDCTriggerSegmentHit >	m_tsHits
	unpacked track segment hit

bool	m_mergerOnly
	flag to only simulation merger and not TSF

bool	m_simulateCC
	flag to simulate front-end clock counter

std::vector< bool >	m_stubLUT
	list of flags to run a TSF firmware simulation with dummy L/R LUT (to speed up loading)

int	m_debugLevel = 0
	debug level specified in the steering file

int	m_TDCCountForT0 = 4988
	TDC count value from T0.

bool	m_allPositiveTime = true
	switch If true, the trigger time of the hit with largest TDC count becomes 0.

std::string	lib_extension = ".so"
	extension of lib

std::string	cwd = getcurrentdir()
	current diretory

std::string	design_libname_pre = cwd + "/xsim.dir/tsf"
	path to the simulation snapshot

std::string	design_libname_post = "/xsimk" + lib_extension
	path to the simulation snapshot

std::string	simengine_libname = "librdi_simulator_kernel" + lib_extension
	path to the simulation engine

std::string	wdbName_pre = "tsf"
	wdb name prefix

std::string	wdbName_post = ".wdb"
	wdb name extension

std::array< pid_t, m_nSubModules >	m_pid
	'1' in XSI VHDL simulation

mergerOutArray	outputFromMerger
	bits format of merger output / TSF input

inputToTSFArray	inputToTSF
	XSI compliant format of input to TSF.

std::array< outputArray, m_nSubModules >	outputToTracker
	array holding TSF output data

std::array< streamPair, m_nSubModules >	stream
	array holding file handlers of pipes

std::array< std::array< int, 2 >, m_nSubModules >	inputFileDescriptor
	array holding file descriptors of pipes

std::array< std::array< int, 2 >, m_nSubModules >	outputFileDescriptor
	array holding file descriptors of pipes

std::istream *	ins = nullptr
	data stream

std::map< unsigned, mergerStruct< 5 > >	dataAcrossClocks
	data structure to hold merger output

priorityHitStruct	m_priorityHit
	list keeping the index of priority hit of a TS for making fastsim ts hit object

std::vector< std::vector< int > >	iAxialHitInClock
	CDC hit ID in each clock.

std::array< TSMap, 2 >	m_tsMap
	map from cell ID to TS ID, for inner and outer Merger

std::array< cellList, 5 >	innerInvEdge
	list of cell ID related to edge timing

std::array< cellList, 3 >	outerInvEdge
	list of cell ID related to edge timing

std::array< edgeList, 2 >	m_edge
	map from cell ID to related edge ID

int	m_iFirstHit = std::numeric_limits<int>::quiet_NaN()
	ID of the earlist CDC hit in an event.

Private Member Functions
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list

std::string	getPathString () const override
	return the module name.

void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
std::string	m_name
	The name of the module, saved as a string (user-modifiable)

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

This class is the interface between TSim/basf2 TSF module and the firmware simulation core of XSim/ISim.

Definition at line 52 of file CDCTriggerTSFFirmwareModule.h.

Member Typedef Documentation

◆ cellList

using cellList = std::vector<unsigned short>

protected

cell list

Definition at line 299 of file CDCTriggerTSFFirmwareModule.h.

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

◆ edgeList

using edgeList = std::unordered_map<unsigned short, std::vector<unsigned short> >

protected

edge wire list

Definition at line 314 of file CDCTriggerTSFFirmwareModule.h.

◆ edgeMap

using edgeMap = std::unordered_map<unsigned short, timeVec*>

protected

edge wire list

Definition at line 297 of file CDCTriggerTSFFirmwareModule.h.

◆ inputFromMerger

using inputFromMerger = std::vector<inputVector>

protected

input array from Merger

Definition at line 201 of file CDCTriggerTSFFirmwareModule.h.

◆ inputToTSFArray

using inputToTSFArray = std::array<inputFromMerger, m_nSubModules>

protected

input array to TSF

Definition at line 203 of file CDCTriggerTSFFirmwareModule.h.

◆ inputVector

using inputVector = std::array<char, mergerWidth>

protected

input array

Definition at line 199 of file CDCTriggerTSFFirmwareModule.h.

◆ mergerOutArray

using mergerOutArray = std::array<mergerOutput, m_nSubModules>

protected

Merger output array.

Definition at line 194 of file CDCTriggerTSFFirmwareModule.h.

◆ mergerOutput

using mergerOutput = std::vector<mergerVector>

protected

Merger output.

Definition at line 192 of file CDCTriggerTSFFirmwareModule.h.

◆ mergerStruct

using mergerStruct = std::vector<mergerStructElement<nEdges> >

protected

data structure to hold merger output

Definition at line 266 of file CDCTriggerTSFFirmwareModule.h.

◆ mergerStructElement

using mergerStructElement = std::tuple < std::array<timeVec, nSegmentsInMerger>, std::array<timeVec, nSegmentsInMerger>, std::array<timeVec, nEdges>, std::array<std::bitset<nWiresInMerger>, 1>, std::array<std::bitset<nSegmentsInMerger>, 1> >

protected

data structure to hold merger output <priority time (4 bits x 16), fast time (4 bits x 16), edge timing (4 bits x 3 or 5), hitmap (80 bits x 1), 2nd priority hit (16 bit x 1)>

Definition at line 258 of file CDCTriggerTSFFirmwareModule.h.

◆ mergerVector

using mergerVector = std::bitset<mergerWidth>

protected

Merger vector.

Definition at line 190 of file CDCTriggerTSFFirmwareModule.h.

◆ outputArray

using outputArray = std::array<outputVector, nTrackers>

protected

output array

Definition at line 132 of file CDCTriggerTSFFirmwareModule.h.

◆ outputVector

using outputVector = std::array<char, width_out>

protected

output vector

Definition at line 130 of file CDCTriggerTSFFirmwareModule.h.

◆ priorityHitInMerger

using priorityHitInMerger = std::map<unsigned, int>

protected

priority hits map in Merger

Definition at line 277 of file CDCTriggerTSFFirmwareModule.h.

◆ priorityHitStruct

using priorityHitStruct = std::array<priorityHitStructInClock, m_nClockPerEvent>

protected

all priority hits map in Merger

Definition at line 283 of file CDCTriggerTSFFirmwareModule.h.

◆ priorityHitStructInClock

using priorityHitStructInClock = std::map<unsigned, priorityHitStructInSL>

protected

priority hits map in Merger for a clock

Definition at line 281 of file CDCTriggerTSFFirmwareModule.h.

◆ priorityHitStructInSL

using priorityHitStructInSL = std::vector<priorityHitInMerger>

protected

priority hits map in Merger for a SL

Definition at line 279 of file CDCTriggerTSFFirmwareModule.h.

◆ registeredStruct

using registeredStruct = std::vector<registeredStructElement>

protected

vector of registeredStructElement

Definition at line 274 of file CDCTriggerTSFFirmwareModule.h.

◆ registeredStructElement

using registeredStructElement = std::array<std::bitset<nCellsInLayer>, 3>

protected

record when a time slow has been registered by a hit <priority time, fast time, edge timing>

Definition at line 272 of file CDCTriggerTSFFirmwareModule.h.

◆ signalBitStream

using signalBitStream = Bitstream<signalBus>

protected

signal bit stream

Definition at line 137 of file CDCTriggerTSFFirmwareModule.h.

◆ signalBus

using signalBus = std::array<outputArray, m_nSubModules>

protected

signal bus

Definition at line 135 of file CDCTriggerTSFFirmwareModule.h.

◆ streamPair

using streamPair = std::array<FILE*, 2>

protected

file handlers of pipes

Definition at line 215 of file CDCTriggerTSFFirmwareModule.h.

◆ timeVec

using timeVec = std::bitset<timeWidth>

protected

element of data structure to hold merger output

Definition at line 250 of file CDCTriggerTSFFirmwareModule.h.

◆ TSMap

using TSMap = std::unordered_map<short, WireSet>

protected

TS map.

Definition at line 292 of file CDCTriggerTSFFirmwareModule.h.

◆ WireSet

using WireSet = std::vector<short>

protected

Wire set.

Definition at line 290 of file CDCTriggerTSFFirmwareModule.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

◆ CDCTriggerTSFFirmwareModule()

CDCTriggerTSFFirmwareModule ( )

Constructor.

Definition at line 40 of file CDCTriggerTSFFirmwareModule.cc.

                                 :
  Module(), m_cdcHits{""}
 
{
  for (unsigned iAx = 0; iAx < m_nSubModules; ++iAx) {
    inputToTSF[iAx].resize(nAxialMergers[iAx]);
    for (auto& clock : m_priorityHit) {
      clock.insert({2 * iAx, priorityHitStructInSL(nAxialMergers[iAx])});
    }
    dataAcrossClocks.insert({2 * iAx, mergerStruct<5> (nAxialMergers[iAx])});
  }
  //Set module properties
  setDescription("Firmware simulation of the Track Segment Finder for CDC trigger.");
 
  // Define module parameters
  addParam("hitCollectionName", m_hitCollectionName,
           "Name of the input StoreArray of CDCHits.",
           string("CDCHits"));
  addParam("outputCollectionName", m_outputCollectionName,
           "Name of the StoreArray holding the found TS hits.",
           string("CDCTriggerFirmwareSegmentHits"));
  addParam("outputBitstreamNameTo2D", m_outputBitstreamNameTo2D,
           "Name of the StoreArray holding the raw bit content to 2D trackers",
           string("BitstreamTSFto2D"));
  addParam("mergerOnly", m_mergerOnly,
           "Flag to only simulate merger and not TSF",
           false);
  addParam("simulateCC", m_simulateCC,
           "Flag to run the front-end clock counter",
           false);
  std::vector<bool> defaultStub(m_nSubModules, false);
  addParam("stubLUT", m_stubLUT,
           "list of flags to run each TSF firmware simulation with dummy L/R LUT (to speed up loading)",
           defaultStub);
}

◆ ~CDCTriggerTSFFirmwareModule()

~CDCTriggerTSFFirmwareModule ( )

virtual

Definition at line 76 of file CDCTriggerTSFFirmwareModule.cc.

77{}

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Definition at line 147 of file Module.h.

147{};

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

◆ computeEdges()

void computeEdges ( )

protected

Compute the map from merger cell ID to all its related edge fields.

Definition at line 192 of file CDCTriggerTSFFirmwareModule.cc.

{
  for (unsigned short iEdge = 0; iEdge < 5; ++iEdge) {
    for (const auto& cell : innerInvEdge[iEdge]) {
      m_edge[0][cell].push_back(iEdge);
    }
  }
  for (unsigned short iEdge = 0; iEdge < 3; ++iEdge) {
    for (const auto& cell : outerInvEdge[iEdge]) {
      m_edge[1][cell].push_back(iEdge);
    }
  }
}

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

This method is called at the end of the event processing.

Definition: Module.h:176

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

166{};

◆ evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns: True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

◆ event()

void event ( void )

overridevirtual

Things to do for each event.

It gets the CDCHits from DataStore, simulate the Merger output, pass them to the firmware simulation process, and collect TSF firmware response.

Reimplemented from Module.

Definition at line 647 of file CDCTriggerTSFFirmwareModule.cc.

{
  // TODO: what if there is 0 CDC hit?
  int status = 0;
  initializeMerger();
  try {
    // clear accumulative merger output
    for (unsigned iAx = 0; iAx < m_nSubModules; ++iAx) {
      dataAcrossClocks[2 * iAx] = mergerStruct<5> (nAxialMergers[iAx]);
    }
    for (int iClock = 0; iClock < m_nClockPerEvent; iClock++) {
      B2INFO(string(15, '=') << " clock #" << iClock << " " << string(15, '='));
      if (iClock == m_nClockPerEvent - 1) {
        cout << "Accumulative hitmap:" << "\n";
      }
      simulateMerger(iClock);
      if (m_mergerOnly) {
        cout << std::hex;
        int iSL = 0;
        for (const auto& sl : inputToTSF) {
          int iMerger = 0;
          for (const auto& mergerOut : sl) {
            if (std::any_of(mergerOut.begin(), mergerOut.end(), [](char i) {
            return i != zero_val;
          })) {
              cout << "Merger " << iSL * 2 << "-" << iMerger / 2 << " u" << iMerger % 2 << ": ";
              display_hex(mergerOut);
            }
            // print accumulative hitmap
            if (iClock == m_nClockPerEvent - 1) {
              auto accuOut = dataAcrossClocks[2 * iSL][iMerger];
              if (get<MergerOut::hitmap>(accuOut)[0].any()) {
                cout << "Merger " << iSL * 2 << "-" << iMerger / 2 << " u" << iMerger % 2 << ": ";
                cout << get<MergerOut::hitmap>(accuOut)[0] << "\n";
                string priTime, fasTime;
                for (int i = 0; i < 16; ++i) {
                  priTime += get<MergerOut::priorityTime>(accuOut)[i].to_string() + ",";
                  fasTime += get<MergerOut::fastestTime>(accuOut)[i].to_string() + ",";
                }
                cout << "pritime: " << priTime << "\n";
                cout << "fastime: " << fasTime << "\n";
              }
            }
            iMerger++;
          }
          iSL++;
        }
        cout << std::dec;
        continue;
      }
 
      auto TSF0 = getData<0>(inputToTSF);
      auto TSF2 = getData<1>(inputToTSF);
      auto TSF4 = getData<2>(inputToTSF);
      auto TSF6 = getData<3>(inputToTSF);
      auto TSF8 = getData<4>(inputToTSF);
      array<char*, m_nSubModules> rawInputToTSF = {TSF0, TSF2, TSF4, TSF6, TSF8};
 
      for (unsigned iSL = 0; iSL < m_nSubModules; ++iSL) {
        B2DEBUG(100, "input to TSF" << iSL * 2 << ": \n" <<
                display_value(rawInputToTSF[iSL], nAxialMergers[iSL] * mergerWidth));
        write(rawInputToTSF[iSL], stream[iSL][0]);
      }
      // don't mess up stdout order with child processes
      if (m_debugLevel >= 50) {
        usleep(2000 * m_debugLevel);
      }
      for (unsigned iSL = 0; iSL < m_nSubModules; ++iSL) {
        B2DEBUG(50, "Reading buffer from TSF " << iSL * 2 << ":");
        outputToTracker[iSL] = read(stream[iSL][1]);
        B2DEBUG(30, "received TSF " << iSL * 2 << ":");
        if (m_debugLevel >= 30) {
          for (const auto& out : outputToTracker[iSL]) {
            display_hex(out);
          }
        }
      }
      saveFirmwareOutput();
      saveFastOutput(iClock);
    }
  } catch (std::exception& e) {
    B2ERROR("ERROR: An exception occurred: " << e.what());
    status = 2;
  } catch (...) {
    B2ERROR("ERROR: An unknown exception occurred.");
    status = 3;
  }
  B2DEBUG(50, "status code:" << status);
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

◆ getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

◆ getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

◆ getData()

char * getData ( inputToTSFArray input )

protected

get the XSI compliant format from the bits format TSF input

Definition at line 207 of file CDCTriggerTSFFirmwareModule.cc.

{
  static array<char, mergerWidth* nAxialMergers[iSL]> data;
  // 2-D array in XSI is totally in LSB, like this
  // ((012), (345), (678))
  auto itr = data.end() - mergerWidth;
  for (const auto& merger : input[iSL]) {
    copy(merger.begin(), merger.end(), itr);
    itr -= mergerWidth;
  }
  return data.data();
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

virtual std::vector< std::string > getFileNames ( bool outputFiles )

inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

    {
      return std::vector<std::string>();
    }

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

506{ return std::list<ModulePtr>(); }

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

The name of the module, saved as a string (user-modifiable)

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const

inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns: A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

Returns true if all specified property flags are available in this module.

Parameters

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

◆ if_false()

void if_false	(	const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

{
  if_value("<1", path, afterConditionPath);
}

◆ if_true()

void if_true	(	const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

{
  if_value(">=1", path, afterConditionPath);
}

◆ if_value()

void if_value	(	const std::string &	expression,
		const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

{
  m_conditions.emplace_back(expression, path, afterConditionPath);
}

◆ initialize()

void initialize ( void )

overridevirtual

spawn child process for workers, open pipes to pass data

Reimplemented from Module.

Definition at line 120 of file CDCTriggerTSFFirmwareModule.cc.

{
  m_cdcHits.isRequired(m_hitCollectionName);
  m_debugLevel = getLogConfig().getDebugLevel();
  if (m_mergerOnly) {
    computeEdges();
    return;
  }
  m_bitsTo2D.registerInDataStore(m_outputBitstreamNameTo2D);
  m_tsHits.registerInDataStore(m_outputCollectionName);
  for (unsigned i = 0; i < m_nSubModules; ++i) {
    // i: input to worker (output from module)
    // o: output from worker (input to module)
    /* Create pipe and place the two-end pipe file descriptors*/
    pipe(inputFileDescriptor[i].data());
    pipe(outputFileDescriptor[i].data());
    string str_fd[] = {to_string(inputFileDescriptor[i][0]), to_string(outputFileDescriptor[i][1])};
    // spawn a child process
    pid_t pid = fork();
    // pid_t pid = 1;
    if (pid < 0) {
      B2FATAL("Fork failed!");
    } else if (pid == (pid_t) 0) {
      /* Child process (worker) */
      // close the unused ends of the file descriptors
      close(inputFileDescriptor[i][1]);
      close(outputFileDescriptor[i][0]);
      if (m_stubLUT[i]) {
        design_libname_post = "_stub" + design_libname_post;
      }
      string design = design_libname_pre + to_string(i * 2) + design_libname_post;
      string waveform = wdbName_pre + to_string(i * 2) + wdbName_post;
      // execute the standalone worker program
      execlp("CDCTriggerTSFFirmwareWorker", "CDCTriggerTSFFirmwareWorker",
             str_fd[0].c_str(), str_fd[1].c_str(), design.c_str(), waveform.c_str(),
             to_string(nAxialMergers[i]).c_str(), nullptr);
      B2FATAL("The firmware simulation program didn't launch!");
    } else {
      /* Parent process (basf2) */
      B2DEBUG(100, "parent " << i);
      m_pid[i] = pid;
      // Close the copy of the fds read/write end
      close(inputFileDescriptor[i][0]);
      close(outputFileDescriptor[i][1]);
      // open the fds
      stream[i][0] = fdopen(inputFileDescriptor[i][1], "w");
      stream[i][1] = fdopen(outputFileDescriptor[i][0], "r");
      // ins = createInStreamFromFD(outputFileDescriptor[i][0]);
      B2DEBUG(20, "pid for TSF" << i * 2 << ": " << m_pid[i]);
    }
  }
  computeEdges();
  B2INFO("It can take a while for TSF0 to load the LUT.");
  for (unsigned i = 0; i < m_nSubModules; ++i) {
    // wait for worker initialization
    read(stream[i][1]);
  }
}

◆ initializeMerger()

void initializeMerger ( )

protected

Get CDC hits from the DataStore and distribute them to clocks.

Within each clock, faster hit has a smaller index

Definition at line 276 of file CDCTriggerTSFFirmwareModule.cc.

{
  /* The CDCHits array in DataStore contains all the hits in an event,
   * regardless of when them at the trigger system. Their real timing behavior
   * is replayed/simulated by looking at the TDC count (timestamp) of each hit.
   */
 
  vector<int> iAxialHit;
  for (int i = 0; i < m_cdcHits.getEntries(); ++i) {
    // discard hits in the layers unused by trigger
    if ((m_cdcHits[i]->getISuperLayer() != 0 && m_cdcHits[i]->getILayer() == 5) ||
        m_cdcHits[i]->getICLayer() < 3) {
      continue;
    }
    if (m_cdcHits[i]->getISuperLayer() % 2 == 0) {
      iAxialHit.push_back(i);
    }
  }
  // sort by TDC count: larger count comes first
  std::sort(iAxialHit.begin(), iAxialHit.end(), [this](int i, int j) {
    return m_cdcHits[i]->getTDCCount() > m_cdcHits[j]->getTDCCount();
  });
 
  // assign the hits to clock edges based on TDC count
  iAxialHitInClock.clear();
  iAxialHitInClock.resize(1 + trgTime(iAxialHit.back(), iAxialHit.front()) / clockPeriod);
  auto itr = iAxialHitInClock.begin();
  int clockEdge = 1;
  for (const auto& ihit : iAxialHit) {
    B2DEBUG(20, "sorted TDC count: " << m_cdcHits[ihit]->getTDCCount() <<
            ", SL" << m_cdcHits[ihit]->getISuperLayer() << ", layer" << m_cdcHits[ihit]->getILayer() <<
            ", wire " << m_cdcHits[ihit]->getIWire() << ", ihit: " << ihit);
    // if (m_cdcHits[ihit]->getTDCCount() >= 4999) {
    //   B2DEBUG(20, "skipping this hit");
    //   continue;
    // }
    // if (trgTime(ihit, iAxialHit.front()) >= clockEdge * clockPeriod) {
    while (trgTime(ihit, iAxialHit.front()) >= clockEdge * clockPeriod) {
      ++clockEdge;
      ++itr;
    }
    itr->push_back(ihit);
  }
  m_iFirstHit = iAxialHit.front();
 
  // In addition, clear the list holding priority hit indices
  for (auto& clock : m_priorityHit) {
    for (auto& sl : clock) {
      for (auto& merger : sl.second) {
        merger.clear();
      }
    }
  }
}

◆ mergerCellID()

unsigned short mergerCellID ( int index )

protected

Get the cell ID in the merger.

Parameters

index index of the CDC hit in question

Returns: the cell ID (0-79)

Definition at line 235 of file CDCTriggerTSFFirmwareModule.cc.

{
  const CDCHit& hit = (*m_cdcHits[index]);
  const unsigned offset = (hit.getISuperLayer() == 0) ? 3 : 0;
  return (hit.getILayer() - offset) * nSegmentsInMerger +
         hit.getIWire() % nSegmentsInMerger;
}

◆ mergerNumber()

unsigned short mergerNumber ( int index )

protected

Get the merger unit ID in a super layer.

Parameters

index index of the CDC hit in question

Returns: the merger unit ID

Definition at line 243 of file CDCTriggerTSFFirmwareModule.cc.

{
  const CDCHit& hit = (*m_cdcHits[index]);
  return hit.getIWire() / nSegmentsInMerger;
}

◆ notHit()

bool notHit	(	CDCTrigger::MergerOut	field,
		unsigned	iTS,
		TSF::registeredStructElement &	reg
	)

protected

Whether a time field in a merger has been hit in the clock cycle.

Parameters

field	one of (priority, fastest, edge) time
iTS	index of the track segment or edge
reg	record of the timing fields in merger

Returns: true if the TS has not been hit

Definition at line 331 of file CDCTriggerTSFFirmwareModule.cc.

{
  return ! reg[field][iTS];
}

◆ pack()

void pack	(	inputVector::reverse_iterator &	rInput,
		unsigned	number,
		mergerStructElement< 5 > &	output
	)

protected

Pack the merger output data structure to TSF input vector.

template with field as the type of output to be packed and width as the bit width of a single output unit

Parameters

rInput	iterator of the TSF input vector
number	total number of the output units in a merger unit
output	merger output data structre

Definition at line 518 of file CDCTriggerTSFFirmwareModule.cc.

{
  std::generate(input, input + number * width, [&, n = 0]() mutable {
    int i = n++;
    if (width == 1)
    {
      return (get<field>(output)[0][i]) ? one_val : zero_val;
    } else
    {
      return (get<field>(output)[i / width][i % width]) ? one_val : zero_val;
    }});
  input += number * width;
}

◆ priority()

Priority priority ( int index )

protected

write TSF input signals to the worker

Parameters

index index of CDC hit

Returns: what type of priority hit it is

Definition at line 79 of file CDCTriggerTSFFirmwareModule.cc.

{
  CDCHit* hit = m_cdcHits[index];
  int offset = (hit->getISuperLayer() == 0) ? 1 : 0;
  switch (hit->getILayer() - 2 - offset) {
    case 0: return Priority::first;
    case 1: return Priority::second;
    default: return Priority::nothing;
  }
}

◆ read()

TSF::outputArray read ( FILE * instream )

protected

write TSF output signals from the worker

Parameters

instream input file descriptor

Returns: array holding TSF output

Definition at line 97 of file CDCTriggerTSFFirmwareModule.cc.

{
  // read output from TSF firmware
  array<char, 2048> buffer;
  outputArray output;
  buffer.fill(one_val);
  if (fgets(buffer.data(), buffer.size(), instream) == NULL) {
    B2ERROR("fgets reached end unexpectedly");
    return output;
  }
  // ins->getline(buffer.data(), buffer.size());
  for (auto i2d = 0; i2d < 4; ++i2d) {
    B2DEBUG(50, display_value(buffer.data() + width_out * i2d, width_out));
  }
  auto bufferItr = buffer.cbegin();
  // for (int iTracker = 0; iTracker < nTrackers; ++iTracker) {
  for (int iTracker = nTrackers - 1; iTracker >= 0; --iTracker) {
    copy(bufferItr, bufferItr + width_out, output[iTracker].begin());
    bufferItr += width_out;
  }
  return output;
}

◆ registerHit()

void registerHit	(	CDCTrigger::MergerOut	field,
		unsigned	iTS,
		TSF::registeredStructElement &	reg
	)

protected

Register the timing field so that later hits won't overwrite it.

Parameters

field	one of (priority, fastest, edge) time
iTS	index of the track segment or edge
reg	record of the timing fields in merger

Definition at line 336 of file CDCTriggerTSFFirmwareModule.cc.

{
  reg[field].set(iTS);
}

◆ saveFastOutput()

void saveFastOutput ( short iclock )

protected

save fast TSIM output

Definition at line 540 of file CDCTriggerTSFFirmwareModule.cc.

{
  const int ccWidth = 9;
  // number of widended clocks in TSF
  const int widenedClocks = 16;
  // TSF latency in unit of data clocks
  const int latency = 3;
  // N.B. widenedClocks and latency might be inaccurate
 
  int iAx = 0;
  for (const auto& sl : outputToTracker) {
    // keep a list of found TS hit in the same SL so that outputs to different
    // trackers won't be recorded twice
    std::map<unsigned, int> foundTS;
    unsigned short iTracker = 0;
    for (auto& tracker : sl) {
      string output = slv_to_bin_string(tracker);
      // loop through all TS hits in the output
      for (int i = ccWidth; i < width_out; i += tsInfoWidth) {
        string ts = output.substr(i, tsInfoWidth);
        tsOut decoded = decodeTSHit(ts);
        // finish if no more TS hit is present
        if (decoded[3] == 0) {
          break;
        }
        const unsigned nCellsInSL = nAxialMergers[iAx] * nCellsInLayer;
        // get global TS ID
        unsigned iTS = decoded[0] + nCellsInSL * iTracker / nTrackers;
        // periodic ID overflow when phi0 > 0 for the 4th tracker
        if (iTS >= nCellsInSL) {
          iTS -= nCellsInSL;
        }
        // ID in SL8 is shifted by 16
        if (iAx == 4) {
          if (iTS < 16) {
            iTS += nCellsInSL;
          }
          iTS -= 16;
        }
        int iHit = -1;
        int firstClock = iclock - widenedClocks - latency;
        if (firstClock < 0) {
          firstClock = 0;
        }
        int lastClock = iclock - latency;
        B2DEBUG(10, "iAx:" << iAx << ", iTS:" << iTS << ", iTracker: " << iTracker);
        // scan through all CDC hits to get the priority hit
        for (int iclkPri = firstClock; iclkPri < lastClock; ++iclkPri) {
          // get the map storing the hit index in the corresponding merger
          auto priMap = m_priorityHit[iclkPri][2 * iAx][iTS / nSegmentsInMerger];
          unsigned itsInMerger = iTS % nSegmentsInMerger;
          // Pick up the first CDCHit which agrees to the priority position
          // of firmware sim output
          if (priMap.find(itsInMerger) != priMap.end() &&
              toPriority(decoded[3]) == priority(priMap[itsInMerger])) {
            iHit = priMap[itsInMerger];
            B2DEBUG(10, "iHit:" << iHit);
            B2DEBUG(10, "TDC: " << m_cdcHits[iHit]->getTDCCount() << ", TSF: " << decoded[1]);
            break;
          }
        }
        // check if the same TS hit to another tracker is already there
        // TODO: some duplicates are from different clocks,
        // so they won't be caught here
        // This mostly likely means the wrong phase of TSF firmware output is used
        if (foundTS.find(iTS) != foundTS.end()) {
          if (iHit != foundTS[iTS]) {
            B2WARNING("Same TS ID exists, but they point to different CDC hit");
          }
          continue;
        }
        foundTS.insert({iTS, iHit});
        if (iHit < 0) {
          B2WARNING("No corresponding priority CDC hit can be found.");
          B2WARNING("Maybe the latency and number of widened clocks are wrong.");
          B2WARNING("In event " << StoreObjPtr<EventMetaData>()->getEvent());
          B2DEBUG(20, "priority " << decoded[3]);
          for (int iclkPri = 0; iclkPri < m_nClockPerEvent; ++iclkPri) {
            auto priMap = m_priorityHit[iclkPri][2 * iAx][iTS / 16];
            for (auto& m : priMap) {
              B2DEBUG(20, "iWire: " << m.first << ", iLayer: " <<
                      m_cdcHits[m.second]->getILayer() << ", iClock: " << iclkPri);
            }
          }
          if (iclock < 15) {
            B2WARNING("It could be the left over TS hits from the last event.\n" <<
                      "Try increasing m_nClockPerEvent");
          }
        }
        CDCHit cdchit = (iHit < 0) ? CDCHit() : *m_cdcHits[iHit];
        m_tsHits.appendNew(cdchit,
                           globalSegmentID(iTS, 2 * iAx),
                           decoded[3], // priority position
                           decoded[2], // L/R
                           // TODO: pri time should be the same as the CDCHit in 1st arg
                           // when the proper clock counter is given to firmware TSF
                           decoded[1],
                           // TODO: fastest time from ETF output
                           0,
                           iclock);
      }
      ++iTracker;
    }
    ++iAx;
  }
}

◆ saveFirmwareOutput()

void saveFirmwareOutput ( )

protected

save firmware output

Definition at line 533 of file CDCTriggerTSFFirmwareModule.cc.

{
  m_bitsTo2D.appendNew(outputToTracker);
}

◆ segmentID()

TSF::WireSet segmentID ( int iHit )

protected

Get the list of associated track segments with a hit.

Parameters

iHit	index of the CDC hit in question

Returns: list of TS ID (0-15) containing the hit

Definition at line 252 of file CDCTriggerTSFFirmwareModule.cc.

{
  const bool innerMost = (m_cdcHits[iHit]->getISuperLayer() == 0);
  const unsigned short iLayer = m_cdcHits[iHit]->getILayer();
  const unsigned short iCell = mergerCellID(iHit);
  TSMap& tsMap = m_tsMap[static_cast<int>(! innerMost)];
  tsMap.reserve(nWiresInMerger);
  if (tsMap.find(iCell) != tsMap.end()) {
    return tsMap[iCell];
  } else {
    WireSet id;
    // distance to the first priority layer: 0-4 (SL0) or 0-2 (outer)
    // The further it is, the more TS it would be involved in.
    const unsigned short distance = (innerMost) ? iLayer - 3 : abs(iLayer - 2);
    id.resize(distance + 1);
    std::iota(id.begin(), id.end(), (iCell - distance / 2) % nCellsInLayer);
    id.erase(std::remove_if(id.begin(), id.end(), [](short i) {
      return (i < 0 || i >= nCellsInLayer);
    }), id.end());
    tsMap.insert({iCell, id});
    return id;
  }
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

Note: The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

void setParamPython	(	const std::string &	name,
		const boost::python::object &	pyObj
	)

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

◆ setParamPythonDict()

void setParamPythonDict ( const boost::python::dict & dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setSecondPriority()

void setSecondPriority	(	unsigned	priTS,
		unsigned	iHit,
		timeVec	hitTime,
		unsigned	lr,
		mergerStructElement< 5 > &	mergerData,
		registeredStructElement &	registeredCell,
		priorityHitInMerger &	priorityHit
	)

protected

set 2nd priority info

Definition at line 341 of file CDCTriggerTSFFirmwareModule.cc.

{
  timeVec& priorityTime = (get<MergerOut::priorityTime>(mergerData))[priTS];
  // when there is not already a (1st or 2nd priority) hit
  if (notHit(MergerOut::priorityTime, priTS, registeredCell)) {
    priorityTime = hitTime;
    registerHit(MergerOut::priorityTime, priTS, registeredCell);
    get<MergerOut::secondPriorityHit>(mergerData)[0].set(priTS, ! lr);
    priorityHit.insert({priTS, iHit});
    // set the 2nd pri bit to right when T_left == T_right
  } else if (priority(priorityHit[priTS]) == Priority::second &&
             hitTime.to_ulong() == priorityTime.to_ulong() && lr == 1) {
    get<MergerOut::secondPriorityHit>(mergerData)[0].reset(priTS);
    priorityHit[priTS] = iHit;
  }
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

{
  if (!m_type.empty())
    B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
  m_type = type;
}

◆ simulateMerger()

void simulateMerger ( unsigned iclock )

protected

Simulate 1 clock of merger.

Parameters

iclock index of data clock

Definition at line 364 of file CDCTriggerTSFFirmwareModule.cc.

{
  // clean up TSF input signals
  for (auto& sl : inputToTSF) {
    for (auto& merger : sl) {
      merger.fill(zero_val);
    }
  }
  // don't do simulation if there are no more CDC hits
  if (iClock >= iAxialHitInClock.size()) {
    return;
  }
  // mergerStruct<5> innerDataInClock(nAxialMergers[0]);
  // map<unsigned, mergerStruct<3> > outerDataInClock;
  // mergers in outer super layer has only 3 edge fields,
  // but for the sake of coding simplicity and consistency,
  // let's declare them as the same type of SL0,
  // at the cost of 2 wasted slots.
  map<unsigned, mergerStruct<5> > dataInClock;
  map<unsigned, registeredStruct> registered;
  for (int iAx = 0; iAx < m_nSubModules; ++iAx) {
    dataInClock.insert({2 * iAx, mergerStruct<5> (nAxialMergers[iAx])});
    registered.insert({2 * iAx, registeredStruct(nAxialMergers[iAx])});
  }
  auto clock = iAxialHitInClock[iClock];
  // move first priority hits forward, so that we can just use the 1st hit
  // but still preserve order in each group
  std::stable_partition(clock.begin(), clock.end(),
  [this](int hit) {return priority(hit) == Priority::first;});
  for (const auto& iHit : clock) {
    const CDCHit& hit = *m_cdcHits[iHit];
    const unsigned short iSL = hit.getISuperLayer();
    const short outer = (iSL == 0) ? 0 : 1;
    const unsigned short iMerger = mergerNumber(iHit);
    const unsigned short iCell = mergerCellID(iHit);
    const WireSet tsList = segmentID(iHit);
    const timeVec hitTime = timeStamp(iHit, m_iFirstHit);
    auto& mergerData = dataInClock[iSL][iMerger];
    auto& registeredCell = registered[iSL][iMerger];
    // register the priority hit in the corresponding merger
    auto& priorityHit = m_priorityHit[iClock][iSL][iMerger];
    B2DEBUG(50, "iHit: " << iHit << ", Merger" << iSL << "-" << iMerger <<
            ", iCell: " << iCell);
    // update hit map
    get<MergerOut::hitmap>(mergerData)[0].set(iCell);
    // update fastest time
    for (const auto& iTS : tsList) {
      timeVec& fastestTime = (get<MergerOut::fastestTime>(mergerData))[iTS];
      // when there is not already a hit
      if (notHit(MergerOut::fastestTime, iTS, registeredCell) ||
          // or when this one is faster
          hitTime.to_ulong() < fastestTime.to_ulong()) {
        // note: if we move this up to before partition, we won't need to
        // compare timing, since they are already sorted. However,
        // leaving it here makes the code a bit cleaner.
        fastestTime = hitTime;
        registerHit(MergerOut::fastestTime, iTS, registeredCell);
      }
    }
    // get edge hit timing or local fastest time
    if (m_edge[outer].find(iCell) != m_edge[outer].end()) {
      for (auto& iEdgeTime : m_edge[outer][iCell]) {
        timeVec& edgeTime = (get<MergerOut::edgeTime>(mergerData))[iEdgeTime];
        if (notHit(MergerOut::edgeTime, iEdgeTime, registeredCell) ||
            hitTime.to_ulong() < edgeTime.to_ulong()) {
          edgeTime = hitTime;
          registerHit(MergerOut::edgeTime, iEdgeTime, registeredCell);
        }
      }
    }
    switch (priority(iHit)) {
      case Priority::first: {
        // update priority time
        unsigned priTS = iCell % nSegmentsInMerger;
        // cppcheck-suppress variableScope
        timeVec& priorityTime = (get<MergerOut::priorityTime>(mergerData))[priTS];
        // when there is not already a (first priority) hit
        if (notHit(MergerOut::priorityTime, priTS, registeredCell)) {
          priorityTime = hitTime;
          registerHit(MergerOut::priorityTime, priTS, registeredCell);
          get<MergerOut::secondPriorityHit>(mergerData)[0].reset(priTS);
          priorityHit.insert({priTS, iHit});
        }
        break;
      }
      case Priority::second: {
        // update the 2 priority times and the sc bits
        for (unsigned i = 0; i < 2; ++i) {
          unsigned priTS = iCell % nSegmentsInMerger + i;
          if (priTS == nSegmentsInMerger) {
            // crossing the left edge
            // set the 2nd priority left of the first TS in the next merger
            priTS = 0;
            const unsigned short iMergerPlus1 = (iMerger == nMergers[iSL] - 1) ? 0 : iMerger + 1;
            auto& nextMergerData = dataInClock[iSL][iMergerPlus1];
            auto& nextRegisteredCell = registered[iSL][iMergerPlus1];
            auto& nextPriorityHit = m_priorityHit[iClock][iSL][iMergerPlus1];
            setSecondPriority(priTS, iHit, hitTime, i, nextMergerData, nextRegisteredCell, nextPriorityHit);
          } else {
            setSecondPriority(priTS, iHit, hitTime, i, mergerData, registeredCell, priorityHit);
          }
        }
        break;
      }
      default:
        break;
    }
  }
  // pack the output from merger into input to TSF
  for (auto iAx = 0; iAx < m_nSubModules; ++iAx) {
    unsigned nEdges = (iAx == 0) ? 5 : 3;
    for (unsigned iMerger = 0; iMerger < inputToTSF[iAx].size(); ++iMerger) {
      auto input = inputToTSF[iAx][iMerger].rbegin();
      auto& output = dataInClock[2 * iAx][iMerger];
      pack<MergerOut::hitmap, 1> (input, nWiresInMerger, output);
      pack<MergerOut::priorityTime, timeWidth> (input, nCellsInLayer, output);
      pack<MergerOut::fastestTime, timeWidth> (input, nCellsInLayer, output);
      pack<MergerOut::secondPriorityHit, 1> (input, nCellsInLayer, output);
      pack<MergerOut::edgeTime, timeWidth> (input, nEdges, output);
      // cppcheck-suppress variableScope
      auto& outputAcrossClocks = dataAcrossClocks[2 * iAx][iMerger];
      if (get<MergerOut::hitmap>(output)[0].any()) {
        string priTime, fasTime, edgTime;
        for (int i = 0; i < nSegmentsInMerger; ++i) {
          priTime += get<MergerOut::priorityTime>(output)[i].to_string() + ",";
          fasTime += get<MergerOut::fastestTime>(output)[i].to_string() + ",";
          edgTime += get<MergerOut::edgeTime>(output)[i].to_string() + ",";
          get<MergerOut::priorityTime>(outputAcrossClocks)[i] |=
            get<MergerOut::priorityTime>(output)[i];
          get<MergerOut::fastestTime>(outputAcrossClocks)[i] |=
            get<MergerOut::fastestTime>(output)[i];
        }
        B2DEBUG(150, "merger " << iAx * 2 << "-" << iMerger <<
                "\nhitmap:       " << get<MergerOut::hitmap>(output)[0] <<
                "\nsecond hit:   " << get<MergerOut::secondPriorityHit>(output)[0] <<
                "\nprioiry Time: " << priTime <<
                "\nfastest Time: " << fasTime <<
                "\nedge    Time: " << edgTime);
        get<MergerOut::hitmap>(outputAcrossClocks)[0] |= get<MergerOut::hitmap>(output)[0];
      }
      // simulate clock counter
      if (m_simulateCC) {
        bitset<9> cc(iClock);
        const int nBitsReserved = (iAx == 0) ? 3 : 4;
        generate(inputToTSF[iAx][iMerger].rend() - 9 - nBitsReserved,
                 inputToTSF[iAx][iMerger].rend() - nBitsReserved,
        [&cc, i = 0]() mutable {
          return (cc[i++]) ? one_val : zero_val;});
      }
    }
  }
}

◆ terminate()

void terminate ( void )

overridevirtual

close the pipes and wait for children to die.

Reimplemented from Module.

Definition at line 179 of file CDCTriggerTSFFirmwareModule.cc.

{
  B2DEBUG(10, "Waiting for TSF firmware termination...");
  for (unsigned i = 0; i < m_nSubModules; ++i) {
    close(inputFileDescriptor[i][1]);
    close(outputFileDescriptor[i][0]);
  }
  // wait for all processes to exit
  for (unsigned i = 0; i < m_nSubModules; ++i) {
    wait(nullptr);
  }
}

◆ timeStamp()

std::bitset< 4 > timeStamp	(	int	index,
		int	iFirstHit
	)

protected

Get the trigger time stamp of a hit.

Parameters

index	index of the CDC hit in question
iFirstHit	index of the first hit

Returns: trigger time stamp (least significant 4 bits)

Definition at line 230 of file CDCTriggerTSFFirmwareModule.cc.

{
  return std::bitset<4> (trgTime(index, iFirstHit) % clockPeriod);
}

◆ trgTime()

unsigned short trgTime	(	int	index,
		int	iFirstHit
	)

protected

Get the trigger time of the CDC hit.

Parameters

index	index of the CDC hit in question
iFirstHit	index of the first hit

Returns: the trigger time of the hit (in unit of about 2ns)

Definition at line 220 of file CDCTriggerTSFFirmwareModule.cc.

{
  if (m_allPositiveTime) {
    return (m_cdcHits[iFirstHit]->getTDCCount() / 2 - m_cdcHits[index]->getTDCCount() / 2);
  } else {
    short time = (m_TDCCountForT0 / 2 - m_cdcHits[index]->getTDCCount() / 2);
    return (time < 0) ? time + (1 << 9) : time;
  }
}

◆ write()

void write	(	const char *	message,
		FILE *	outstream
	)

protected

write TSF input signals to the worker

Parameters

message	words to write
outstream	output file descriptor

Definition at line 90 of file CDCTriggerTSFFirmwareModule.cc.

{
  // write input to TSF firmware
  fprintf(outstream, "%s\n", message);
  fflush(outstream);
}

Member Data Documentation

◆ clockPeriod

constexpr int clockPeriod = 16

staticconstexpr

data clock period (32ns) in unit of 2ns

Definition at line 111 of file CDCTriggerTSFFirmwareModule.h.

◆ cwd

std::string cwd = getcurrentdir()

protected

current diretory

Definition at line 169 of file CDCTriggerTSFFirmwareModule.h.

◆ dataAcrossClocks

std::map<unsigned, mergerStruct<5> > dataAcrossClocks

protected

data structure to hold merger output

Definition at line 268 of file CDCTriggerTSFFirmwareModule.h.

◆ design_libname_post

std::string design_libname_post = "/xsimk" + lib_extension

protected

path to the simulation snapshot

Definition at line 173 of file CDCTriggerTSFFirmwareModule.h.

◆ design_libname_pre

std::string design_libname_pre = cwd + "/xsim.dir/tsf"

protected

path to the simulation snapshot

Definition at line 171 of file CDCTriggerTSFFirmwareModule.h.

◆ iAxialHitInClock

std::vector<std::vector<int> > iAxialHitInClock

protected

CDC hit ID in each clock.

Definition at line 287 of file CDCTriggerTSFFirmwareModule.h.

◆ innerInvEdge

std::array<cellList, 5> innerInvEdge

protected

Initial value:

= {cellList {31},
                                            cellList {64},
                                            cellList {32, 48, 64, 65},
                                            cellList {31, 47, 62, 63, 78},
                                            cellList {63, 79}
                                           }

list of cell ID related to edge timing

Definition at line 301 of file CDCTriggerTSFFirmwareModule.h.

◆ inputFileDescriptor

std::array<std::array<int, 2>, m_nSubModules> inputFileDescriptor

protected

array holding file descriptors of pipes

Definition at line 220 of file CDCTriggerTSFFirmwareModule.h.

◆ inputToTSF

inputToTSFArray inputToTSF

protected

XSI compliant format of input to TSF.

Definition at line 205 of file CDCTriggerTSFFirmwareModule.h.

◆ ins

std::istream* ins = nullptr

protected

data stream

Definition at line 243 of file CDCTriggerTSFFirmwareModule.h.

◆ lib_extension

std::string lib_extension = ".so"

protected

extension of lib

Definition at line 167 of file CDCTriggerTSFFirmwareModule.h.

◆ m_allPositiveTime

bool m_allPositiveTime = true

protected

switch If true, the trigger time of the hit with largest TDC count becomes 0.

Otherwise, m_TDCCountForT0 becomes 0 (as in the fast TSIM).

Definition at line 164 of file CDCTriggerTSFFirmwareModule.h.

◆ m_bitsTo2D

StoreArray<signalBitStream> m_bitsTo2D

protected

bitstream of TSF output to 2D tracker

Definition at line 140 of file CDCTriggerTSFFirmwareModule.h.

◆ m_cdcHits

Belle2::StoreArray<CDCHit> m_cdcHits

protected

CDCHit array.

Definition at line 127 of file CDCTriggerTSFFirmwareModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_debugLevel

int m_debugLevel = 0

protected

debug level specified in the steering file

Definition at line 155 of file CDCTriggerTSFFirmwareModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_edge

std::array<edgeList, 2> m_edge

protected

map from cell ID to related edge ID

Definition at line 316 of file CDCTriggerTSFFirmwareModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_hitCollectionName

std::string m_hitCollectionName

protected

Name of the StoreArray containing the input CDC hits.

Definition at line 115 of file CDCTriggerTSFFirmwareModule.h.

◆ m_iFirstHit

int m_iFirstHit = std::numeric_limits<int>::quiet_NaN()

protected

ID of the earlist CDC hit in an event.

Definition at line 319 of file CDCTriggerTSFFirmwareModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_mergerOnly

bool m_mergerOnly

protected

flag to only simulation merger and not TSF

Definition at line 146 of file CDCTriggerTSFFirmwareModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name

privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

◆ m_nClockPerEvent

constexpr int m_nClockPerEvent = 44

staticconstexpr

how many clocks to simulate per event

Definition at line 108 of file CDCTriggerTSFFirmwareModule.h.

◆ m_nSubModules

constexpr int m_nSubModules = 5

staticconstexpr

number of TSF to simulate

Definition at line 78 of file CDCTriggerTSFFirmwareModule.h.

◆ m_outputBitstreamNameTo2D

std::string m_outputBitstreamNameTo2D

protected

Name of the StoreArray holding the raw bit content to 2D trackers.

Definition at line 121 of file CDCTriggerTSFFirmwareModule.h.

◆ m_outputBitstreamNameToETF

std::string m_outputBitstreamNameToETF

protected

Name of the StoreArray holding the raw bit content to ETF.

Definition at line 124 of file CDCTriggerTSFFirmwareModule.h.

◆ m_outputCollectionName

std::string m_outputCollectionName

protected

Name of the StoreArray holding the found TS hits.

Definition at line 118 of file CDCTriggerTSFFirmwareModule.h.

◆ m_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

◆ m_pid

std::array<pid_t, m_nSubModules> m_pid

protected

'1' in XSI VHDL simulation

'0' in XSI VHDL simulation array holding child process ID

Definition at line 187 of file CDCTriggerTSFFirmwareModule.h.

◆ m_priorityHit

priorityHitStruct m_priorityHit

protected

list keeping the index of priority hit of a TS for making fastsim ts hit object

Definition at line 285 of file CDCTriggerTSFFirmwareModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_simulateCC

bool m_simulateCC

protected

flag to simulate front-end clock counter

Definition at line 149 of file CDCTriggerTSFFirmwareModule.h.

◆ m_stubLUT

std::vector<bool> m_stubLUT

protected

list of flags to run a TSF firmware simulation with dummy L/R LUT (to speed up loading)

Definition at line 152 of file CDCTriggerTSFFirmwareModule.h.

◆ m_TDCCountForT0

int m_TDCCountForT0 = 4988

protected

TDC count value from T0.

Definition at line 158 of file CDCTriggerTSFFirmwareModule.h.

◆ m_tsHits

StoreArray<CDCTriggerSegmentHit> m_tsHits

protected

unpacked track segment hit

Definition at line 143 of file CDCTriggerTSFFirmwareModule.h.

◆ m_tsMap

std::array<TSMap, 2> m_tsMap

protected

map from cell ID to TS ID, for inner and outer Merger

Definition at line 294 of file CDCTriggerTSFFirmwareModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ mergerWidth

constexpr int mergerWidth = 256

staticconstexpr

merger output data width

Definition at line 90 of file CDCTriggerTSFFirmwareModule.h.

◆ nAxialMergers

constexpr std::array< int, TSF::m_nSubModules > nAxialMergers = {10, 12, 16, 20, 24}

staticconstexpr

number of mergers in axial super layers

Definition at line 84 of file CDCTriggerTSFFirmwareModule.h.

◆ nCellsInLayer

constexpr int nCellsInLayer = 16

staticconstexpr

Number of wire/cells in a single layer per merger unit.

Definition at line 99 of file CDCTriggerTSFFirmwareModule.h.

◆ nMergers

constexpr std::array< int, 9 > nMergers = {10, 10, 12, 14, 16, 18, 20, 22, 24}

staticconstexpr

number of mergers in each super layer

Definition at line 81 of file CDCTriggerTSFFirmwareModule.h.

◆ nSegmentsInMerger

constexpr int nSegmentsInMerger = 16

staticconstexpr

number of track segments in a single merger unit

Definition at line 102 of file CDCTriggerTSFFirmwareModule.h.

◆ nTrackers

constexpr int nTrackers = 4

staticconstexpr

number of trackers

Definition at line 87 of file CDCTriggerTSFFirmwareModule.h.

◆ nWiresInMerger

constexpr int nWiresInMerger = 80

staticconstexpr

number of wire/cell in a single merger unit

Definition at line 96 of file CDCTriggerTSFFirmwareModule.h.

◆ outerInvEdge

std::array<cellList, 3> outerInvEdge

protected

Initial value:

= {cellList {63},
                                            cellList {0, 64},
                                            cellList {15, 31, 63, 79}
                                           }

list of cell ID related to edge timing

Definition at line 309 of file CDCTriggerTSFFirmwareModule.h.

◆ outputFileDescriptor

std::array<std::array<int, 2>, m_nSubModules> outputFileDescriptor

protected

array holding file descriptors of pipes

Definition at line 222 of file CDCTriggerTSFFirmwareModule.h.

◆ outputFromMerger

mergerOutArray outputFromMerger

protected

bits format of merger output / TSF input

Definition at line 196 of file CDCTriggerTSFFirmwareModule.h.

◆ outputToTracker

std::array<outputArray, m_nSubModules> outputToTracker

protected

array holding TSF output data

Definition at line 208 of file CDCTriggerTSFFirmwareModule.h.

◆ simengine_libname

std::string simengine_libname = "librdi_simulator_kernel" + lib_extension

protected

path to the simulation engine

Definition at line 175 of file CDCTriggerTSFFirmwareModule.h.

◆ stream

std::array<streamPair, m_nSubModules> stream

protected

array holding file handlers of pipes

Definition at line 217 of file CDCTriggerTSFFirmwareModule.h.

◆ timeWidth

constexpr size_t timeWidth = 4

staticconstexpr

bit width for priority time and fast time

Definition at line 105 of file CDCTriggerTSFFirmwareModule.h.

◆ wdbName_post

std::string wdbName_post = ".wdb"

protected

wdb name extension

Definition at line 179 of file CDCTriggerTSFFirmwareModule.h.

◆ wdbName_pre

std::string wdbName_pre = "tsf"

protected

wdb name prefix

Definition at line 177 of file CDCTriggerTSFFirmwareModule.h.

◆ width_out

constexpr int width_out = 429

staticconstexpr

width of output data width

Definition at line 93 of file CDCTriggerTSFFirmwareModule.h.

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

trg/cdc/modules/trgcdc/include/CDCTriggerTSFFirmwareModule.h
trg/cdc/modules/trgcdc/src/CDCTriggerTSFFirmwareModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ cellList

◆ EAfterConditionPath

◆ edgeList

◆ edgeMap

◆ inputFromMerger

◆ inputToTSFArray

◆ inputVector

◆ mergerOutArray

◆ mergerOutput

◆ mergerStruct

◆ mergerStructElement

◆ mergerVector

◆ outputArray

◆ outputVector

◆ priorityHitInMerger

◆ priorityHitStruct

◆ priorityHitStructInClock

◆ priorityHitStructInSL

◆ registeredStruct

◆ registeredStructElement

◆ signalBitStream

◆ signalBus

◆ streamPair

◆ timeVec

◆ TSMap

◆ WireSet

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ CDCTriggerTSFFirmwareModule()

◆ ~CDCTriggerTSFFirmwareModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ computeEdges()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getData()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()