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:

Collaboration diagram for CDCTriggerTSFFirmwareModule:

[legend]

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. More...

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. More...

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

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

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

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

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

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. More...

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

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. More...

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

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

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

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. More...

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). More...

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

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. More...

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. More...

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. More...

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

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

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 More...

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

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

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

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

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

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

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

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. More...

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

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. More...

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

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

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. More...

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. More...

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. More...

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

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. More...

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

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

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

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. More...

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 More...

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 More...

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

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. More...

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

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 55 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.

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);
 }

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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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 RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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_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()

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://confluence.desy.de/display/BI/Software+ModCondTut 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ pack()

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

protected

Pack the merger output data structure to TSF input vector.

Parameters

field	type of output to be packed
width	bit width of a single output unit
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.

◆ 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.

◆ 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.

◆ 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.

◆ segmentID()

TSF::WireSet segmentID ( int iHit )

protected

Get the list of associated track segments with a hit.

Parameters

index 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

Member Data Documentation

◆ 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 304 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 167 of file CDCTriggerTSFFirmwareModule.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 190 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 312 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 Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ CDCTriggerTSFFirmwareModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ event()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initializeMerger()

◆ mergerCellID()

◆ mergerNumber()

◆ notHit()

◆ pack()

◆ priority()

◆ read()

◆ registerHit()

◆ segmentID()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ simulateMerger()

◆ timeStamp()

◆ trgTime()

◆ write()

Member Data Documentation

◆ innerInvEdge

◆ m_allPositiveTime

◆ m_pid

◆ outerInvEdge