Inheritance diagram for CDCTriggerHoughETFModule:

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
	CDCTriggerHoughETFModule ()
	Constructor.

virtual void	initialize () override
	Initialize the module and check module parameters.

virtual void	event () override
	Run tracking.

virtual void	terminate () override
	Clean up.

int	fastInterceptFinder (cdcMap &hits, double x1_s, double x2_s, double y1_s, double y2_s, unsigned iterations, unsigned ix_s, unsigned iy_s)
	Fast intercept finder Divide Hough plane recursively to find cells with enough crossing lines.

unsigned short	countSL (bool *superLayers)
	count the number of super layers with hits

bool	shortTrack (bool *superLayers)
	check the short track condition (= hits in the inner super layers rather than any super layers)

void	connectedRegions ()
	Combine Hough candidates to tracks by merging connected cells.

void	addNeighbors (const CDCTriggerHoughCand &center, const std::vector< CDCTriggerHoughCand > &candidates, std::vector< CDCTriggerHoughCand > &merged, std::vector< CDCTriggerHoughCand > &rejected, unsigned short nSLmax) const
	Recursive function to add combine connected cells.

bool	inList (const CDCTriggerHoughCand &a, const std::vector< CDCTriggerHoughCand > &list) const
	Check if candidate is in list.

bool	connected (const CDCTriggerHoughCand &a, const CDCTriggerHoughCand &b) const
	Check if candidates are connected.

void	mergeIdList (std::vector< unsigned > &merged, std::vector< unsigned > &a, std::vector< unsigned > &b)
	Merge lists a and b and put the result in merged.

bool	patternClustering (const cdcMap &inputMap)
	Combine Hough candidates to tracks by a fixed pattern algorithm.

bool	connectedLR (unsigned patternL, unsigned patternR)
	Check for left/right connection of patterns in 2 x 2 squares.

bool	connectedUD (unsigned patternD, unsigned patternU)
	Check for up/down connection of patterns in 2 x 2 squares.

bool	connectedDiag (unsigned patternLD, unsigned patternRU)
	Check for diagonal connected of patterns in 2 x 2 squares.

unsigned	topRightSquare (std::vector< unsigned > &pattern)
	Find the top right square within a cluster of 2 x 2 squares In case of ambiguity, top is favored over right @ return index of corner within pattern vector.

unsigned	topRightCorner (unsigned pattern)
	Find the top right corner within 2 x 2 square.

unsigned	bottomLeftCorner (unsigned pattern)
	Find the bottom left corner within 2 x 2 square.

void	findAllCrossingHits (std::vector< unsigned > &list, double x1, double x2, double y1, double y2, const cdcMap &inputMap)
	Find all hits in inputMap whose Hough curve crosses the rectangle with corners (x1, y1) and (x2, y2) and add the hit indices to list.

void	selectHits (std::vector< unsigned > &list, std::vector< unsigned > &selected, std::vector< unsigned > &unselected)
	Select one hit per super layer.

int	getSector (int id, int sl)

std::vector< int >	sectorTimingList ()

std::vector< int >	highPassTimingList ()

int	calcEventTiming ()

int	median (std::vector< int > v)

int	medianInTimeWindow (std::vector< int > v)

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.

Protected Member Functions
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
StoreObjPtr< BinnedEventT0 >	m_eventTime
	StoreObjPtr holding the event time.

std::string	m_EventTimeName
	Name of the StoreObject containing the trigger event time.

bool	m_storeTracks
	Switch to save the 2D Hough track reconstructed in this module.

StoreArray< CDCTriggerSegmentHit >	m_hits
	list of input track segment hits

std::vector< std::vector< CDCTriggerSegmentHit * > >	associatedTSHitsList
	list of fastest timing of TS associated with Track

bool	m_usePriorityTiming
	Switch to use priority timing instead of fastest timing.

bool	m_useHighPassTimingList
	Use associated fastest timings track-by-track.

unsigned	m_t0CalcMethod
	Switch method to determine the event timing.

unsigned	m_arrivalOrder
	arrival order of fastest timing used as t0 (effective when t0CalcMEthod == 0)

short	m_timeWindowBegin
	Start time of time window relative to median.

short	m_timeWindowEnd
	End time of time window relative to median.

std::string	m_hitCollectionName
	Name of the StoreArray containing the input track segment hits.

std::string	m_outputCollectionName
	Name of the StoreArray containing the tracks found by the Hough tracking.

std::string	m_clusterCollectionName
	Name of the StoreArray containing the clusters formed in the Hough plane.

unsigned	m_nCellsPhi
	number of Hough cells in phi

unsigned	m_nCellsR
	number of Hough cells in 1/r

double	m_minPt
	Hough plane limit in Pt [GeV].

int	m_shiftPt
	shift the Hough plane in 1/r to avoid curvature 0 tracks < 0: shift in negative direction (negative half is larger) 0: no shift (same limits for negative and positive half) ‍0: shift in positive direction (positive half is larger)

double	maxR = 0.
	Hough plane limit in 1/r [1/cm].

double	shiftR = 0.
	Hough plane shift in 1/r [1/cm].

unsigned	maxIterations = 0
	number of iterations for the fast peak finder, smallest n such that 2^(n+1) > max(nCellsPhi, nCellsR).

unsigned	nCells = 0
	number of cells for the fast peak finder: 2^(maxIterations + 1).

unsigned	m_minHits
	minimum number of hits from different super layers in a Hough cell to form a candidate

unsigned	m_minHitsShort
	short tracks require hits in the first minHitsShort super layers to form a candidate

unsigned	m_minCells
	minimum number of cells in a cluster to form a track

bool	m_onlyLocalMax
	switch to ignore candidates connected to cells with higher super layer count

unsigned	m_connect
	number of neighbors to check for connection (4: direct, 6: direct + upper right and lower left corner, 8: direct + all corners)

bool	m_ignore2nd
	switch to skip second priority hits

bool	m_usePriority
	switch between priority position and center position of track segment

bool	m_requireSL0
	switch to check separately for a hit in the innermost super layer

bool	m_suppressClone
	switch to send only the first found track and suppress the subsequent clones

unsigned	m_storePlane
	switch to save the Hough plane in DataStore (0: don't save, 1: save only peaks, 2: save full plane)

bool	m_clusterPattern
	switch for clustering algorithm (if true use nested patterns)

unsigned	m_clusterSizeX
	maximum cluster size for pattern algorithm

unsigned	m_clusterSizeY
	maximum cluster size for pattern algorithm

bool	m_hitRelationsFromCorners
	switch for creating relations to hits in the pattern clustering algorithm.

int	m_offset = 0
	offset for ETF simulation

std::string	m_testFilename
	filename for test output for firmware debugging

std::ofstream	testFile
	filestream for test output for firmware debugging

cdcMap	hitMap
	map of TS hits containing <iHit, <iSL, (x, y)>> with iHit: hit index in StoreArray iSL: super layer index

std::vector< CDCTriggerHoughCand >	houghCand
	Hough Candidates.

double	radius [9][2] = {{0.}}
	Radius of the CDC layers with priority wires (2 per super layer).

unsigned	TSoffset [10] = {0}
	Number of track segments up to super layer.

const int	NTS [9] = {160, 160, 192, 224, 256, 288, 320, 352, 384}
	Number of track segments in each super layers.

const int	NSEC [9] = {16, 0, 16, 0, 16, 0, 8, 0, 8}
	Number of sector in each super layer.

int	NSecOffset [9] = {0}
	Number of sector offset of each super layer.

StoreArray< CDCTriggerSegmentHit >	m_segmentHits
	list of track segment hits

StoreArray< CDCTriggerTrack >	m_tracks
	list of found tracks

StoreArray< CDCTriggerHoughCluster >	m_clusters
	list of clusters in the Hough map

StoreObjPtr< TMatrix >	m_houghPlane
	matrix containing the Hough plane

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

Definition at line 84 of file CDCTriggerHoughETFModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.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

◆ CDCTriggerHoughETFModule()

CDCTriggerHoughETFModule ( )

Constructor.

Definition at line 37 of file CDCTriggerHoughETFModule.cc.

                                                   : Module()
{
  //Set module properties
  setDescription("Hough tracking algorithm for CDC trigger.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // Define module parameters
  // 2D ETF specified parameters
  // ----- PARAMETERS : GRL t0 finder with fastest priority timing (current at 2020.2.7)-----
  // t0CalcMethod = 0
  // usePriorityPosition = true
  // arrivalOrder = 0
  //
  addParam("outputEventTimeName", m_EventTimeName,
           "Name of the output StoreObjPtr.",
           string(""));
  addParam("storeTracks", m_storeTracks,
           "store tracks",
           false);
  addParam("usePriorityTiming", m_usePriorityTiming,
           "Use priority timing instead of fastest timing.",
           true);
  addParam("useHighPassTimingList", m_useHighPassTimingList,
           "Use associated fastest timings track-by-track",
           true);
  addParam("t0CalcMethod", m_t0CalcMethod,
           "0: Nth fastest fastest time."
           "1: median of all timings."
           "2: median of timings in timing window.",
           (unsigned)(0));
  addParam("arrivalOrder", m_arrivalOrder,
           "When t0CalcMethod == 0: Nth fastest ft is used as T0. (i.e. 0 is fastest)",
           (unsigned)(0));
  addParam("timeWindowBegin", m_timeWindowBegin,
           "When t0CalcMethod == 2: start time of time window relative to median. (in ns)",
           (short)(40));
  addParam("timeWindowEnd", m_timeWindowEnd,
           "When t0CalcMethod == 2: end time of time window relative to median. (in ns)",
           (short)(0));
 
  //common as CDCTrigger2DFinderModule
  addParam("hitCollectionName", m_hitCollectionName,
           "Name of the input StoreArray of CDCTriggerSegmentHits.",
           string(""));
  addParam("outputCollectionName", m_outputCollectionName,
           "Name of the StoreArray holding the tracks found in the Hough tracking.",
           string("TRGCDCETFTracks"));
  addParam("clusterCollectionName", m_clusterCollectionName,
           "Name of the StoreArray holding the clusters formed in the Hough plane.",
           string(""));
  addParam("nCellsPhi", m_nCellsPhi,
           "Number of Hough cells in phi (limits: [-180, 180]). Must be an even number.",
           (unsigned)(160));
  addParam("nCellsR", m_nCellsR,
           "Number of Hough cells in 1/r. Must be an even number.",
           (unsigned)(34));
  addParam("minPt", m_minPt,
           "Minimum Pt [GeV]. "
           "Hough plane limits in 1/r are [-1/r(minPt), 1/r(minPt)]", (double)(0.3));
  addParam("shiftPt", m_shiftPt,
           "Shift the Hough plane by 1/4 cell size in 1/r to avoid "
           "curvature 0 tracks (<0: shift in negative direction, "
           "0: no shift, >0: shift in positive direction).", 0);
 
  addParam("minHits", m_minHits,
           "Minimum hits from different super layers required in a peak cell.",
           (unsigned)(4));
  addParam("minHitsShort", m_minHitsShort,
           "Minimum hits required required in a peak cell for a short track"
           " (must be in the first minHitsShort super layers).",
           (unsigned)(4));
  addParam("minCells", m_minCells,
           "Peaks with less than minCells connected cells are ignored.",
           (unsigned)(2));
  addParam("onlyLocalMax", m_onlyLocalMax,
           "Switch to remove cells connected to a cell with higher super layer count.",
           false);
  addParam("connect", m_connect,
           "Definition for connected cells. 4: direct (left/right/top/bottom), "
           "6: direct + 2 diagonal (top right/bottom left), "
           "8: direct + all diagonal (top right/top left/bottom right/bottom left)",
           (unsigned)(6));
  addParam("ignore2ndPriority", m_ignore2nd,
           "Switch to skip second priority hits.", false);
  addParam("usePriorityPosition", m_usePriority,
           "If true, use wire position of priority cell in track segment, "
           "otherwise use wire position of center cell.", true);
  addParam("requireSL0", m_requireSL0,
           "Switch to check separately for a hit in the innermost superlayer.", false);
  addParam("storeHoughPlane", m_storePlane,
           "Switch for saving Hough plane as TMatrix in DataStore. "
           "0: don't store anything, 1: store only peaks, 2: store full plane "
           "(will increase runtime).", (unsigned)(0));
  addParam("clusterPattern", m_clusterPattern,
           "use nested pattern algorithm to find clusters", true);
  addParam("clusterSizeX", m_clusterSizeX,
           "maximum number of 2 x 2 squares in cluster for pattern algorithm",
           (unsigned)(3));
  addParam("clusterSizeY", m_clusterSizeY,
           "maximum number of 2 x 2 squares in cluster for pattern algorithm",
           (unsigned)(3));
  addParam("hitRelationsFromCorners", m_hitRelationsFromCorners,
           "Switch for creating relations to hits in the pattern algorithm. "
           "If true, create relations from cluster corners, otherwise "
           "from estimated cluster center (might not have relations).", false);
 
  addParam("testFilename", m_testFilename,
           "If not empty, a file with input (hits) and output (tracks) "
           "for each event is written (for firmware debugging).", string(""));
 
  addParam("suppressClone", m_suppressClone,
           "Switch to send only the first found track and suppress the "
           "subsequent clones.", false);
 
  addParam("offset", m_offset,
           "Set certain time offset for ETFHough simulation"
           "Default as -10", -10);
}

Member Function Documentation

◆ addNeighbors()

void addNeighbors	(	const CDCTriggerHoughCand &	center,
		const std::vector< CDCTriggerHoughCand > &	candidates,
		std::vector< CDCTriggerHoughCand > &	merged,
		std::vector< CDCTriggerHoughCand > &	rejected,
		unsigned short	nSLmax
	)		const

Recursive function to add combine connected cells.

All candidates are compared to center. Connected candidates are added to the merged list. If the module option onlyLocalMax is on, connected cells with SLcount lower than the cluster maximum are added to the rejected list instead. The function is called recursively for all connected candidates.

Parameters

center	starting candidate
candidates	list of candidates compared to center
merged	list for storing all candidates belonging to the cluster
rejected	list for storing rejected candidates (connected, but lower SLcount, not in any other cluster either)
nSLmax	highest SLcount for this cluster

Definition at line 292 of file CDCTriggerHoughtrafoForETF.cc.

{
  for (unsigned icand = 0; icand < candidates.size(); ++icand) {
    B2DEBUG(120, "compare center " << center.getID()
            << " to " << candidates[icand].getID());
    if (inList(candidates[icand], merged) || inList(candidates[icand], rejected)) {
      B2DEBUG(120, "  " << candidates[icand].getID() << " already in list");
      continue;
    }
    bool reject = inList(center, rejected);
    if (connected(center, candidates[icand])) {
      if (m_onlyLocalMax && candidates[icand].getSLcount() < nSLmax) {
        B2DEBUG(100, "  lower than highest SLcount, rejected");
        rejected.push_back(candidates[icand]);
      } else if (m_onlyLocalMax && !reject && candidates[icand].getSLcount() > nSLmax) {
        B2DEBUG(100, "  new highest SLcount, clearing list");
        nSLmax = candidates[icand].getSLcount();
        for (unsigned imerged = 0; imerged < merged.size(); ++imerged) {
          rejected.push_back(merged[imerged]);
        }
        merged.clear();
        merged.push_back(candidates[icand]);
      } else if (m_onlyLocalMax && candidates[icand].getSLcount() > center.getSLcount()) {
        B2DEBUG(100, "  connected to rejected cell, skip");
        continue;
      } else if (m_onlyLocalMax && reject) {
        B2DEBUG(100, "  connected to rejected cell, rejected");
        rejected.push_back(candidates[icand]);
      } else {
        B2DEBUG(100, "  connected");
        merged.push_back(candidates[icand]);
      }
      vector<CDCTriggerHoughCand> cpyCand = candidates;
      cpyCand.erase(cpyCand.begin() + icand);
      addNeighbors(candidates[icand], cpyCand, merged, rejected, nSLmax);
    }
  }
}

◆ 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{};

◆ bottomLeftCorner()

unsigned bottomLeftCorner ( unsigned pattern )

Find the bottom left corner within 2 x 2 square.

In case of ambiguity left corner is returned. x . -> return this one . x @ return index of corner within pattern

Definition at line 808 of file CDCTriggerHoughtrafoForETF.cc.

{
  // scan pattern from left to right:
  // 2 3
  // 0 1
  if (pattern & 1) return 0;
  if ((pattern >> 2) & 1) {
    if ((pattern >> 1) & 1) {
      setReturnValue(false);
      B2DEBUG(100, "bottomLeftCorner not unique");
    }
    return 2;
  }
  if ((pattern >> 1) & 1) return 1;
  return 3;
}

◆ calcEventTiming()

int calcEventTiming ( )

Definition at line 883 of file CDCTriggerHoughtrafoForETF.cc.

{
  std::vector<int> ftlists;
  if (m_useHighPassTimingList) {
    ftlists = highPassTimingList();
  } else {
    ftlists = sectorTimingList();
  }
 
  if (m_t0CalcMethod == 0) {
    std::sort(ftlists.begin(), ftlists.end());
    return ftlists[m_arrivalOrder];
  } else if (m_t0CalcMethod == 1) {
    return median(ftlists);
  } else {
    return medianInTimeWindow(ftlists);
  }
}

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

◆ connected()

bool connected	(	const CDCTriggerHoughCand &	a,
		const CDCTriggerHoughCand &	b
	)		const

Check if candidates are connected.

Definition at line 346 of file CDCTriggerHoughtrafoForETF.cc.

{
  double ax1 = a.getCoord().first.X();
  double ax2 = a.getCoord().second.X();
  double ay1 = a.getCoord().first.Y();
  double ay2 = a.getCoord().second.Y();
  double bx1 = b.getCoord().first.X();
  double bx2 = b.getCoord().second.X();
  double by1 = b.getCoord().first.Y();
  double by2 = b.getCoord().second.Y();
  // direct neighbors
  bool direct = ((ax2 == bx1 && ay1 == by1) || // right
                 (ax1 == bx2 && ay1 == by1) || // left
                 (ax1 == bx1 && ay2 == by1) || // above
                 (ax1 == bx1 && ay1 == by2) || // below
                 (ax1 + 2. * M_PI == bx2 && ay1 == by1) ||
                 (ax2 == bx1 + 2. * M_PI && ay1 == by1));
  // diagonal connections
  bool diagRise = ((ax2 == bx1 && ay2 == by1) || // right above
                   (ax1 == bx2 && ay1 == by2) || // left below
                   (ax1 + 2. * M_PI == bx2 && ay1 == by2) ||
                   (ax2 == bx1 + 2. * M_PI && ay2 == by1));
  bool diagFall = ((ax1 == bx2 && ay2 == by1) || // left above
                   (ax2 == bx1 && ay1 == by2) || // right below
                   (ax2 == bx1 + 2. * M_PI && ay1 == by2) ||
                   (ax1 + 2. * M_PI == bx2 && ay2 == by1));
  if (m_connect == 4) return direct;
  else if (m_connect == 6) return (direct || diagRise);
  else if (m_connect == 8) return (direct || diagRise || diagFall);
  else B2WARNING("Unknown option for connect " << m_connect << ", using default.");
  return (direct || diagRise);
}

◆ connectedDiag()

bool connectedDiag	(	unsigned	patternLD,
		unsigned	patternRU
	)

Check for diagonal connected of patterns in 2 x 2 squares.

Definition at line 747 of file CDCTriggerHoughtrafoForETF.cc.

{
  if (m_connect == 4) return false;
 
  // connected if
  //     . .
  //     x .
  // . x
  // . .
  return (((patternRU >> 0) & 1) && ((patternLD >> 3) & 1));
}

◆ connectedLR()

bool connectedLR	(	unsigned	patternL,
		unsigned	patternR
	)

Check for left/right connection of patterns in 2 x 2 squares.

Definition at line 690 of file CDCTriggerHoughtrafoForETF.cc.

{
  // connected if
  // . x | x .  or  . . | . .
  // . . | . .      . x | x .
  bool connectDirect = (((patternL >> 3) & 1) && ((patternR >> 2) & 1)) ||
                       (((patternL >> 1) & 1) && ((patternR >> 0) & 1));
  // connected if
  // . . | x .
  // . x | . .
  bool connectRise = ((patternL >> 1) & 1) && ((patternR >> 2) & 1);
  // connected if
  // . x | . .
  // . . | x .
  bool connectFall = ((patternL >> 3) & 1) && ((patternR >> 0) & 1);
 
  if (m_connect == 4) return connectDirect;
  else if (m_connect == 6) return (connectDirect || connectRise);
  else if (m_connect == 8) return (connectDirect || connectRise || connectFall);
  else B2WARNING("Unknown option for connect " << m_connect << ", using default.");
  return (connectDirect || connectRise);
}

◆ connectedRegions()

void connectedRegions ( )

Combine Hough candidates to tracks by merging connected cells.

The track coordinate is the center of gravity of the resulting cell cluster.

Definition at line 181 of file CDCTriggerHoughtrafoForETF.cc.

{
  vector<vector<CDCTriggerHoughCand>> regions;
  vector<CDCTriggerHoughCand> cpyCand = houghCand;
 
  // debug: print candidate list
  B2DEBUG(50, "houghCand number " << cpyCand.size());
  for (unsigned icand = 0; icand < houghCand.size(); ++icand) {
    coord2dPair coord = houghCand[icand].getCoord();
    B2DEBUG(100, houghCand[icand].getID()
            << " nSL " << houghCand[icand].getSLcount()
            << " x1 " << coord.first.X() << " x2 " << coord.second.X()
            << " y1 " << coord.first.Y() << " y2 " << coord.second.Y());
  }
 
  // combine connected cells to regions
  while (cpyCand.size() > 0) {
    B2DEBUG(100, "make new region");
    vector<CDCTriggerHoughCand> region;
    vector<CDCTriggerHoughCand> rejected;
    CDCTriggerHoughCand start = cpyCand[0];
    cpyCand.erase(cpyCand.begin());
    region.push_back(start);
    addNeighbors(start, cpyCand, region, rejected, start.getSLcount());
    regions.push_back(region);
    for (auto cand = cpyCand.begin(); cand != cpyCand.end();) {
      if (inList(*cand, region) || inList(*cand, rejected))
        cpyCand.erase(cand);
      else
        ++cand;
    }
  }
 
  // find center of gravity for each region
  for (unsigned ir = 0; ir < regions.size(); ++ir) {
    B2DEBUG(50, "region " << ir << " (" << regions[ir].size() << " cells).");
    // skip regions with size below cut
    if (regions[ir].size() < m_minCells) {
      B2DEBUG(50, "Skipping region with " << regions[ir].size() << " cells.");
      continue;
    }
    double xfirst = regions[ir][0].getCoord().first.X();
    double x = 0;
    double y = 0;
    int n = 0;
    vector<unsigned> mergedList;
    int xmin = m_nCellsPhi;
    int xmax = 0;
    int ymin = m_nCellsR;
    int ymax = 0;
    vector<ROOT::Math::XYVector> cellIds = {};
    for (unsigned ir2 = 0; ir2 < regions[ir].size(); ++ir2) {
      coord2dPair hc = regions[ir][ir2].getCoord();
      B2DEBUG(100, "  " << regions[ir][ir2].getID()
              << " nSL " << regions[ir][ir2].getSLcount()
              << " x1 " << hc.first.X() << " x2 " << hc.second.X()
              << " y1 " << hc.first.Y() << " y2 " << hc.second.Y());
      int ix = floor((hc.first.X() + M_PI) / 2. / M_PI * m_nCellsPhi + 0.5);
      int iy = floor((hc.first.Y() + maxR - shiftR) / 2. / maxR * m_nCellsR + 0.5);
      x += (hc.first.X() + hc.second.X());
      if (xfirst - hc.first.X() > M_PI) {
        x += 4 * M_PI;
        ix += m_nCellsPhi;
      } else if (hc.first.X() - xfirst > M_PI) {
        x -= 4 * M_PI;
        ix -= m_nCellsPhi;
      }
      y += (hc.first.Y() + hc.second.Y());
      n += 1;
      vector<unsigned> idList = regions[ir][ir2].getIdList();
      mergeIdList(mergedList, mergedList, idList);
      xmin = min(xmin, ix);
      xmax = max(xmax, ix);
      ymin = min(ymin, iy);
      ymax = max(ymax, iy);
      cellIds.push_back(ROOT::Math::XYVector(ix, iy));
    }
    x *= 0.5 / n;
    if (x > M_PI)
      x -= 2 * M_PI;
    else if (x <= -M_PI)
      x += 2 * M_PI;
    y *= 0.5 / n;
    B2DEBUG(50, "x " << x << " y " << y);
 
    // select 1 hit per super layer
    vector<unsigned> selectedList = {};
    vector<unsigned> unselectedList = {};
    selectHits(mergedList, selectedList, unselectedList);
 
    // save track
    const CDCTriggerTrack* track =
      m_tracks.appendNew(x, 2. * y, 0.);
    // relations to selected hits
    for (unsigned i = 0; i < selectedList.size(); ++i) {
      unsigned its = selectedList[i];
      if (m_storeTracks) track->addRelationTo(m_segmentHits[its]);
    }
    // relations to additional hits get a negative weight
    for (unsigned i = 0; i < unselectedList.size(); ++i) {
      unsigned its = unselectedList[i];
      if (m_storeTracks) track->addRelationTo(m_segmentHits[its], -1.);
    }
    // save detail information about the cluster
    const CDCTriggerHoughCluster* cluster =
      m_clusters.appendNew(xmin, xmax, ymin, ymax, cellIds);
    if (m_storeTracks) track->addRelationTo(cluster);
  }
}

◆ connectedUD()

bool connectedUD	(	unsigned	patternD,
		unsigned	patternU
	)

Check for up/down connection of patterns in 2 x 2 squares.

Definition at line 714 of file CDCTriggerHoughtrafoForETF.cc.

{
  // connected if
  // . .      . .
  // x .      . x
  // ---  or  ---
  // x .      . x
  // . .      . .
  bool connectDirect = (((patternU >> 0) & 1) && ((patternD >> 2) & 1)) ||
                       (((patternU >> 1) & 1) && ((patternD >> 3) & 1));
  // connected if
  // . .
  // . x
  // ---
  // x .
  // . .
  bool connectRise = ((patternU >> 1) & 1) && ((patternD >> 2) & 1);
  // connected if
  // . .
  // x .
  // ---
  // . x
  // . .
  bool connectFall = ((patternU >> 0) & 1) && ((patternD >> 3) & 1);
 
  if (m_connect == 4) return connectDirect;
  else if (m_connect == 6) return (connectDirect || connectRise);
  else if (m_connect == 8) return (connectDirect || connectRise || connectFall);
  else B2WARNING("Unknown option for connect " << m_connect << ", using default.");
  return (connectDirect || connectRise);
}

◆ countSL()

unsigned short countSL ( bool * superLayers )

count the number of super layers with hits

Parameters

superLayers array of hit/no hit for all super layers

Definition at line 31 of file CDCTriggerHoughtrafoForETF.cc.

{
  if (m_requireSL0 && !layer[0]) return 0;
  unsigned short lcnt = 0;
  for (int i = 0; i < CDC_SUPER_LAYERS; ++i) {
    if (layer[i] == true) ++lcnt;
  }
  return lcnt;
}

◆ 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

Run tracking.

Pair of <counter, cdcPair>, for hits with indices

Reimplemented from Module.

Definition at line 202 of file CDCTriggerHoughETFModule.cc.

{
  /* Clean hits */
  hitMap.clear();
  houghCand.clear();
  associatedTSHitsList.clear();
 
  if (!m_eventTime.isValid()) m_eventTime.create();
  /* set default return value */
  setReturnValue(true);
 
  if (m_testFilename != "") {
    testFile << StoreObjPtr<EventMetaData>()->getEvent() << " "
             << m_segmentHits.getEntries() << endl;
  }
 
  if (m_segmentHits.getEntries() == 0) {
    //B2WARNING("CDCTracking: tsHitsCollection is empty!");
    return;
  }
 
  /* get CDCHits coordinates in conformal space */
  for (int iHit = 0; iHit < m_segmentHits.getEntries(); iHit++) {
    unsigned short iSL = m_segmentHits[iHit]->getISuperLayer();
    if (m_testFilename != "") {
      testFile << iSL << " " << m_segmentHits[iHit]->getSegmentID() - TSoffset[iSL] << " "
               << m_segmentHits[iHit]->getPriorityPosition() << endl;
    }
    if (iSL % 2) continue;
    if (m_ignore2nd && m_segmentHits[iHit]->getPriorityPosition() < 3) continue;
    double phi = m_segmentHits[iHit]->getSegmentID() - TSoffset[iSL];
    if (m_usePriority) {
      phi += 0.5 * (((m_segmentHits[iHit]->getPriorityPosition() >> 1) & 1)
                    - (m_segmentHits[iHit]->getPriorityPosition() & 1));
    }
    phi = phi * 2. * M_PI / (TSoffset[iSL + 1] - TSoffset[iSL]);
    double r = radius[iSL][int(m_usePriority &&
                               m_segmentHits[iHit]->getPriorityPosition() < 3)];
    ROOT::Math::XYVector pos(cos(phi) / r, sin(phi) / r);
    hitMap.insert(std::make_pair(iHit, std::make_pair(iSL, pos)));
  }
 
  /* Extent the Hough plane such that the cell number is a power of 2 (same for x and y).
   * This is for the fast peak finder, which divides the Hough plane in half in each step.
   * Peaks found outside of the actual limits are ignored. */
  maxIterations = ceil(log2(max(m_nCellsPhi, m_nCellsR))) - 1;
  nCells = pow(2, maxIterations + 1);
  /* limits in phi: [-pi, pi] + extra cells */
  double rectX = M_PI * nCells / m_nCellsPhi;
  /* limits in R: [-R(minPt), R(minPt)] + extra cells + shift */
  maxR = 0.5 * Const::speedOfLight * 1.5e-4 / m_minPt;
  double rectY = maxR * nCells / m_nCellsR;
  shiftR = 0;
  if (m_shiftPt < 0) {
    shiftR = -maxR / 2. / m_nCellsR;
  } else if (m_shiftPt > 0) {
    shiftR = maxR / 2. / m_nCellsR;
  }
 
  B2DEBUG(50, "extending Hough plane to " << maxIterations << " iterations, "
          << nCells << " cells: phi in ["
          << -rectX * 180. / M_PI << ", " << rectX * 180. / M_PI
          << "] deg, 1/r in [" << -rectY + shiftR << ", " << rectY + shiftR << "] /cm");
 
  /* prepare matrix for storing the Hough plane */
  if (m_storePlane > 0) {
    m_houghPlane.create();
    m_houghPlane->ResizeTo(m_nCellsPhi, m_nCellsR);
  }
 
  // hit map containing only the early hits
  cdcMap fastHitMap;
  if (m_suppressClone && !hitMap.empty()) {
    // find the first track candidates in Hough plane
    // only for z0 resolution study with single-track events
    // This will surely fail with multi-track ones,
    // in which case we really need tick-by-tick simulation for all hits.
 
    typedef pair<int, cdcPair> cdcHitPair;
    // sequential hit map, ordered by TS found time
    typedef vector<cdcHitPair> cdcSeqMap;
    cdcSeqMap seqHitMap;
    // copy hit map to sequential hit map and sort it by TS found time
    for (auto hit : hitMap) {
      seqHitMap.push_back(hit);
    }
    sort(seqHitMap.begin(), seqHitMap.end(), [this](cdcHitPair i, cdcHitPair j) {
      return m_segmentHits[i.first]->foundTime() < m_segmentHits[j.first]->foundTime();
    });
    auto seqHitItr = seqHitMap.begin();
    /* layer filter */
    vector<bool> layerHit(CDC_SUPER_LAYERS, false);
    // data clock cycle in unit of 2ns
    short period = 16;
    short firstTick = m_segmentHits[(*seqHitMap.begin()).first]->foundTime() / period + 1;
    short lastTick = m_segmentHits[(*(seqHitMap.end() - 1)).first]->foundTime() / period + 1;
    // add TS hits in every clock cycle until a track candidate is found
    for (auto tick = firstTick * period; tick < lastTick * period; tick += period) {
      int nHitInCycle = 0;
      for (auto itr = seqHitItr; itr < seqHitMap.end(); ++itr) {
        cdcHitPair currentHit = *itr;
        // start from the first hit over SL threshold
        if (count(layerHit.begin(), layerHit.end(), true) >= m_minHits &&
            m_segmentHits[currentHit.first]->foundTime() > tick) {
          break;
        }
        nHitInCycle++;
        layerHit[m_segmentHits[currentHit.first]->getISuperLayer()] = true;
      }
      copy_n(seqHitItr, nHitInCycle, inserter(fastHitMap, fastHitMap.end()));
      fastInterceptFinder(fastHitMap, -rectX, rectX, -rectY + shiftR, rectY + shiftR, 0, 0, 0);
      B2DEBUG(20, "at tick " << tick << ", number of candidates: " << houghCand.size());
      if (!houghCand.empty()) {
        B2DEBUG(10, "found a track at clock " << tick << " with "
                << fastHitMap.size() << "hits");
        break;
      }
      advance(seqHitItr, nHitInCycle);
    }
  } else {
    /* find track candidates in Hough plane using all TS hits */
    fastInterceptFinder(hitMap, -rectX, rectX, -rectY + shiftR, rectY + shiftR, 0, 0, 0);
    if (!houghCand.empty()) {
      B2DEBUG(10, "found a track with " << hitMap.size() << "hits");
    }
  }
 
  /* merge track candidates */
  if (m_clusterPattern) {
    if (patternClustering(fastHitMap))
      m_eventTime->addBinnedEventT0(calcEventTiming() + m_offset, Const::CDC);
  } else {
    connectedRegions();
  }
 
  if (m_testFilename != "") {
    testFile << m_tracks.getEntries() << endl;
    for (int i = 0; i < m_tracks.getEntries(); ++i) {
      float ix = (m_tracks[i]->getPhi0() - M_PI_4) * m_nCellsPhi / 2. / M_PI - 0.5;
      float iy = (m_tracks[i]->getOmega() / 2. + maxR - shiftR) * m_nCellsR / 2. / maxR - 0.5;
      testFile << round(2 * ix) / 2. << " " << round(2 * iy) / 2. << " "
               << m_tracks[i]->getChargeSign() << endl;
      RelationVector<CDCTriggerSegmentHit> hits =
        m_tracks[i]->getRelationsTo<CDCTriggerSegmentHit>(m_hitCollectionName);
      testFile << hits.size() << endl;
      for (unsigned ihit = 0; ihit < hits.size(); ++ihit) {
        unsigned short iSL = hits[ihit]->getISuperLayer();
        testFile << iSL << " " << hits[ihit]->getSegmentID() - TSoffset[iSL] << " "
                 << hits[ihit]->getPriorityPosition() << " "
                 << hits.weight(ihit) << endl;
      }
    }
  }
}

◆ 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://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  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)

◆ fastInterceptFinder()

int fastInterceptFinder	(	cdcMap &	hits,
		double	x1_s,
		double	x2_s,
		double	y1_s,
		double	y2_s,
		unsigned	iterations,
		unsigned	ix_s,
		unsigned	iy_s
	)

Fast intercept finder Divide Hough plane recursively to find cells with enough crossing lines.

Parameters

hits	map of hit coordinates in conformal space
x1_s,x2_s,y1_s,y2_s	limits of starting rectangle
iterations	current iteration index
ix_s,iy_s	indices of starting rectangle

Definition at line 64 of file CDCTriggerHoughtrafoForETF.cc.

{
  string indent = "";
  for (unsigned i = 0; i < iterations; ++i) indent += " ";
  B2DEBUG(150, indent << "intercept finder iteration " << iterations
          << " x1 " << x1_s * 180 / M_PI << " x2 " << x2_s * 180 / M_PI
          << " y1 " << y1_s << " y2 " << y2_s
          << " ix " << ix_s << " iy " << iy_s);
 
  int i, j, iHit;
  double unitx, unity;
  double y1, y2;
  double m, a;
  cdcPair hp;
  unsigned short iSL;
  // list of hit indices crossing the current rectangle
  vector<unsigned> idx_list;
 
  // limits of divided rectangles
  double x1_d, x2_d, y1_d, y2_d;
 
  // cell indices in full plane
  unsigned ix, iy;
 
  unitx = ((x2_s - x1_s) / 2.0);
  unity = ((y2_s - y1_s) / 2.0);
 
  // divide x axis in half
  for (i = 0; i < 2 ; ++i) {
    // divide y axis in half
    for (j = 0; j < 2; ++j) {
      x1_d = x1_s + i * unitx;
      x2_d = x1_s + (i + 1) * unitx;
      y1_d = y1_s + j * unity;
      y2_d = y1_s + (j + 1) * unity;
 
      ix = 2 * ix_s + i;
      iy = 2 * iy_s + j;
 
      // skip extra cells outside of the Hough plane
      if (x2_d <= -M_PI || x1_d >= M_PI || y2_d <= -maxR + shiftR || y1_d >= maxR + shiftR) {
        B2DEBUG(150, indent << "skip Hough cell outside of plane limits");
        continue;
      }
 
      // if the cell size in phi is too large, the hit calculation is not reliable
      // -> continue to next iteration without hit check
      if (iterations != maxIterations && unitx > M_PI / 2.) {
        fastInterceptFinder(hits, x1_d, x2_d, y1_d, y2_d, iterations + 1, ix, iy);
        continue;
      }
 
      idx_list.clear();
      bool layerHit[CDC_SUPER_LAYERS] = {false}; /* For layer filter */
      for (auto it = hits.begin(); it != hits.end(); ++it) {
        iHit = it->first;
        hp = it->second;
        iSL = hp.first;
        m = hp.second.X();
        a = hp.second.Y();
        // calculate Hough curve with slightly enlarged limits to avoid errors due to rounding
        y1 = m * sin(x1_d - 1e-10) - a * cos(x1_d - 1e-10);
        y2 = m * sin(x2_d + 1e-10) - a * cos(x2_d + 1e-10);
        // skip decreasing half of the sine (corresponds to curl back half of the track)
        if (iterations == maxIterations && y1 > y2) continue;
        if (!((y1 > y2_d && y2 > y2_d) || (y1 < y1_d && y2 < y1_d))) {
          if (iterations == maxIterations) {
            idx_list.push_back(iHit);
          }
          layerHit[iSL] = true; /* layer filter */
        }
      }
      unsigned short nSL = countSL(layerHit);
      B2DEBUG(150, indent << "i " << i << " j " << j
              << " layerHit " << int(layerHit[0]) << int(layerHit[2])
              << int(layerHit[4]) << int(layerHit[6]) << int(layerHit[8])
              << " nSL " << nSL);
      if (nSL >= m_minHits || shortTrack(layerHit)) {
        if (iterations != maxIterations) {
          fastInterceptFinder(hits, x1_d, x2_d, y1_d, y2_d, iterations + 1, ix, iy);
        } else {
          ROOT::Math::XYVector v1(x1_d, y1_d);
          ROOT::Math::XYVector v2(x2_d, y2_d);
          houghCand.push_back(CDCTriggerHoughCand(idx_list, make_pair(v1, v2),
                                                  nSL, houghCand.size()));
          if (m_storePlane > 0) {
            (*m_houghPlane)[ix - (nCells - m_nCellsPhi) / 2][iy - (nCells - m_nCellsR) / 2] = nSL;
          }
        }
      } else if (m_storePlane > 1) {
        // to store the full Hough plane, we need to continue the iteration
        // to minimal cell size everywhere
        for (unsigned min = m_minHits - 1; min > 0; --min) {
          if (nSL >= min) {
            if (iterations != maxIterations) {
              fastInterceptFinder(hits, x1_d, x2_d, y1_d, y2_d, iterations + 1, ix, iy);
            } else {
              (*m_houghPlane)[ix - (nCells - m_nCellsPhi) / 2][iy - (nCells - m_nCellsR) / 2] = nSL;
            }
            break;
          }
        }
      }
    }
  }
 
  return 0;
}

◆ findAllCrossingHits()

void findAllCrossingHits	(	std::vector< unsigned > &	list,
		double	x1,
		double	x2,
		double	y1,
		double	y2,
		const cdcMap &	inputMap
	)

Find all hits in inputMap whose Hough curve crosses the rectangle with corners (x1, y1) and (x2, y2) and add the hit indices to list.

Definition at line 418 of file CDCTriggerHoughtrafoForETF.cc.

{
  double m, a, y1_h, y2_h;
  for (int iHit = 0; iHit < m_segmentHits.getEntries(); iHit++) {
    unsigned short iSL = m_segmentHits[iHit]->getISuperLayer();
    if (iSL % 2) continue;
    // associate only the hits actually used to form the cluster
    if (m_suppressClone && inputMap.find(iHit) == inputMap.end()) continue;
    //TODO: add options: center cell / active priority cell / all priority cells
    vector<double> phi = {0, 0, 0};
    phi[0] = m_segmentHits[iHit]->getSegmentID() - TSoffset[iSL];
    phi[1] = phi[0] + 0.5;
    phi[2] = phi[0] - 0.5;
    vector<double> r = {radius[iSL][0], radius[iSL][1], radius[iSL][1]};
    for (unsigned i = 0; i < 3; ++i) {
      phi[i] *= 2. * M_PI / (TSoffset[iSL + 1] - TSoffset[iSL]);
      m = cos(phi[i]) / r[i];
      a = sin(phi[i]) / r[i];
      // calculate Hough curve with slightly enlarged limits to avoid errors due to rounding
      y1_h = m * sin(x1 - 1e-10) - a * cos(x1 - 1e-10);
      y2_h = m * sin(x2 + 1e-10) - a * cos(x2 + 1e-10);
      // skip decreasing half of the sine (corresponds to curl back half of the track)
      if (y1_h > y2_h) continue;
      if (!((y1_h > y2 && y2_h > y2) || (y1_h < y1 && y2_h < y1))) {
        list.push_back(iHit);
        break;
      }
    }
  }
}

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

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

◆ getSector()

int getSector	(	int	id,
		int	sl
	)

Definition at line 840 of file CDCTriggerHoughtrafoForETF.cc.

{
  unsigned int localid = id - TSoffset[sl];
  unsigned int base = NTS[sl] / NSEC[sl];
  return localid / base + NSecOffset[sl];
}

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

◆ highPassTimingList()

std::vector< int > highPassTimingList ( )

Definition at line 825 of file CDCTriggerHoughtrafoForETF.cc.

{
  std::vector<int> ftlists;
 
  for (long unsigned int iTrack = 0; iTrack < associatedTSHitsList.size(); iTrack++) {
    for (long unsigned int iHit = 0; iHit < associatedTSHitsList[iTrack].size(); iHit++) {
      short ft = (!m_usePriorityTiming) ? associatedTSHitsList[iTrack][iHit]->fastestTime()
                 : associatedTSHitsList[iTrack][iHit]->priorityTime();
      ftlists.push_back(ft * 2);
    }
  }
  return ftlists;
}

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

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

◆ initialize()

void initialize ( void )

overridevirtual

Initialize the module and check module parameters.

Reimplemented from Module.

Definition at line 157 of file CDCTriggerHoughETFModule.cc.

{
  // register DataStore elements
  m_eventTime.registerInDataStore(m_EventTimeName);
  m_segmentHits.isRequired(m_hitCollectionName);
 
  if (m_storeTracks) {
    m_tracks.registerInDataStore(m_outputCollectionName);
    m_clusters.registerInDataStore(m_clusterCollectionName);
 
    m_tracks.registerRelationTo(m_segmentHits);
    m_tracks.registerRelationTo(m_clusters);
  }
 
  if (m_storePlane > 0) m_houghPlane.registerInDataStore("HoughPlane");
 
  const CDCGeometryPar& cdc = CDCGeometryPar::Instance();
  int layerId = 3;
  int nTS = 0;
  for (int iSL = 0; iSL < 9; ++iSL) {
    TSoffset[iSL] = nTS;
    nTS += cdc.nWiresInLayer(layerId);
    TSoffset[iSL + 1] = nTS;
    for (int priority = 0; priority < 2; ++ priority) {
      radius[iSL][priority] = cdc.senseWireR(layerId + priority);
    }
    layerId += (iSL > 0 ? 6 : 7);
  }
 
  for (int sl = 1; sl < 9; sl++) {
    NSecOffset[sl] = NSEC[sl - 1] + NSecOffset[sl - 1];
  }
 
  if (m_testFilename != "") {
    testFile.open(m_testFilename);
  }
 
  if (m_suppressClone) {
    B2INFO("2D finder will exit with the first track candidate in time.");
  }
 
  if (m_t0CalcMethod != 0 && m_t0CalcMethod != 1) B2WARNING("t0CalcMethod is invalid. calculate as default.");
}

◆ inList()

bool inList	(	const CDCTriggerHoughCand &	a,
		const std::vector< CDCTriggerHoughCand > &	list
	)		const

Check if candidate is in list.

Definition at line 336 of file CDCTriggerHoughtrafoForETF.cc.

{
  for (unsigned i = 0; i < list.size(); ++i) {
    if (a == list[i]) return true;
  }
  return false;
}

◆ median()

int median ( std::vector< int > v )

Definition at line 903 of file CDCTriggerHoughtrafoForETF.cc.

{
  int size = v.size();
  std::vector<int> _v;
  copy(v.begin(), v.end(), back_inserter(_v));
  std::sort(_v.begin(), _v.end());
  if (size % 2) {
    return _v[(size - 1) / 2];
  } else {
    return (_v[(size / 2) - 1] + _v[size / 2]) / 2;
  }
}

◆ medianInTimeWindow()

int medianInTimeWindow ( std::vector< int > v )

Definition at line 917 of file CDCTriggerHoughtrafoForETF.cc.

{
  int med = median(v);
  int tbegin = med - abs(m_timeWindowBegin);
  int tend   = med + abs(m_timeWindowEnd);
 
  std::vector<int> _inWindow;
 
  for (auto& t : v)  if (t > tbegin && t < tend) _inWindow.push_back(t);
 
  if (_inWindow.size()) {
    return median(_inWindow);
  } else {
    return med;
  }
}

◆ mergeIdList()

void mergeIdList	(	std::vector< unsigned > &	merged,
		std::vector< unsigned > &	a,
		std::vector< unsigned > &	b
	)

Merge lists a and b and put the result in merged.

Definition at line 384 of file CDCTriggerHoughtrafoForETF.cc.

{
  bool found;
 
  for (auto it = a.begin(); it != a.end(); ++it) {
    found = false;
    for (auto it_in = merged.begin(); it_in != merged.end(); ++it_in) {
      if (*it_in == *it) {
        found = true;
        break;
      }
    }
    if (!found) {
      merged.push_back(*it);
    }
  }
 
  for (auto it = b.begin(); it != b.end(); ++it) {
    found = false;
    for (auto it_in = merged.begin(); it_in != merged.end(); ++it_in) {
      if (*it_in == *it) {
        found = true;
        break;
      }
    }
    if (!found) {
      merged.push_back(*it);
    }
  }
}

◆ patternClustering()

bool patternClustering ( const cdcMap & inputMap )

Combine Hough candidates to tracks by a fixed pattern algorithm.

The Hough plane is first divided in 2 x 2 squares, then squares are combined.

Definition at line 490 of file CDCTriggerHoughtrafoForETF.cc.

{
  bool foundTrack = false;
  std::vector<CDCTriggerSegmentHit*> associatedTSHits;
 
  // fill a matrix of 2 x 2 squares
  TMatrix plane2(m_nCellsPhi / 2, m_nCellsR / 2);
  TMatrix planeIcand(m_nCellsPhi, m_nCellsR);
  for (unsigned icand = 0; icand < houghCand.size(); ++icand) {
    double x = (houghCand[icand].getCoord().first.X() +
                houghCand[icand].getCoord().second.X()) / 2.;
    unsigned ix = floor((x + M_PI) / 2. / M_PI * m_nCellsPhi);
    double y = (houghCand[icand].getCoord().first.Y() +
                houghCand[icand].getCoord().second.Y()) / 2.;
    unsigned iy = floor((y + maxR - shiftR) / 2. / maxR * m_nCellsR);
    plane2[ix / 2][iy / 2] += 1 << ((ix % 2) + 2 * (iy % 2));
    planeIcand[ix][iy] = icand;
    B2DEBUG(100, "candidate " << icand << " at ix " << ix << " iy " << iy);
  }
  // look for clusters of 2 x 2 squares in a (rX x rY) region
  unsigned nX = m_nCellsPhi / 2;
  unsigned nY = m_nCellsR / 2;
  unsigned rX = m_clusterSizeX;
  unsigned rY = m_clusterSizeY;
  for (unsigned ix = 0; ix < nX; ++ix) {
    for (unsigned iy = 0; iy < nY; ++iy) {
      if (!plane2[ix][iy]) continue;
      // check if we are in a lower left corner
      unsigned ileft = (ix - 1 + nX) % nX;
      B2DEBUG(100, "ix " << ix << " iy " << iy);
      if (connectedLR(plane2[ileft][iy], plane2[ix][iy]) ||
          (iy > 0 && connectedUD(plane2[ix][iy - 1], plane2[ix][iy])) ||
          (iy > 0 && connectedDiag(plane2[ileft][iy - 1], plane2[ix][iy]))) {
        B2DEBUG(100, "skip connected square");
        continue;
      }
      // form cluster
      vector<unsigned> pattern(rX * rY, 0);
      pattern[0] = plane2[ix][iy];
      vector<ROOT::Math::XYVector> cellIds = {ROOT::Math::XYVector(2 * ix, 2 * iy)};
      for (unsigned ix2 = 0; ix2 < rX; ++ix2) {
        for (unsigned iy2 = 0; iy2 < rY; ++iy2) {
          if (iy + iy2 >= nY) continue;
          unsigned ip = ix2 + rX * iy2;
          unsigned iright = (ix + ix2 + nX) % nX;
          ileft = (iright - 1 + nX) % nX;
          B2DEBUG(100, "ix2 " << ix2 << " ileft " << ileft << " iright " << iright);
          if ((ix2 > 0 && // check left/right connection
               pattern[ip - 1] &&
               connectedLR(plane2[ileft][iy + iy2], plane2[iright][iy + iy2])) ||
              (iy2 > 0 && // check up/down connection
               pattern[ip - rX] &&
               connectedUD(plane2[iright][iy + iy2 - 1], plane2[iright][iy + iy2])) ||
              (ix2 > 0 && iy2 > 0 && // check diagonal connection
               pattern[ip - rX - 1] &&
               connectedDiag(plane2[ileft][iy + iy2 - 1], plane2[iright][iy + iy2]))) {
            pattern[ip] = plane2[iright][iy + iy2];
            B2DEBUG(100, "connect cell " << iright << " " << iy + iy2);
            cellIds.push_back(ROOT::Math::XYVector(2 * (ix + ix2), 2 * (iy + iy2)));
          }
        }
      }
      B2DEBUG(100, "cluster starting at " << ix << " " << iy);
      // check if cluster continues beyond defined area
      bool overflowRight = false;
      bool overflowTop = false;
      for (unsigned iy2 = 0; iy2 < rY; ++iy2) {
        unsigned ip = rX - 1 + rX * iy2;
        if (!pattern[ip]) continue;
        unsigned iright = (ix + rX + nX) % nX;
        ileft = (iright - 1 + nX) % nX;
        if (connectedLR(plane2[ileft][iy + iy2], plane2[iright][iy + iy2]) ||
            ((iy + iy2 + 1 < nY) &&
             connectedDiag(plane2[ileft][iy + iy2], plane2[iright][iy + iy2 + 1]))) {
          setReturnValue(false);
          overflowRight = true;
        }
      }
      if (iy + rY < nY) {
        for (unsigned ix2 = 0; ix2 < rX; ++ix2) {
          unsigned ip = ix2 + rX * (rY - 1);
          if (!pattern[ip]) continue;
          unsigned iright = (ix + ix2 + 1 + nX) % nX;
          ileft = (iright - 1 + nX) % nX;
          if (connectedUD(plane2[ileft][iy + rY - 1], plane2[ileft][iy + rY]) ||
              connectedDiag(plane2[ileft][iy + rY - 1], plane2[iright][iy + rY])) {
            setReturnValue(false);
            overflowTop = true;
          }
        }
      }
      if (overflowRight && !overflowTop) {
        B2DEBUG(100, "cluster extends right of " << rX << " x " << rY << " area");
      } else if (overflowTop && !overflowRight) {
        B2DEBUG(100, "cluster extends above " << rX << " x " << rY << " area");
      } else if (overflowRight && overflowTop) {
        B2DEBUG(100, "cluster extends right and above " << rX << " x " << rY << " area");
      }
      // find corners of cluster
      unsigned topRight2 = topRightSquare(pattern);
      unsigned topRight = topRightCorner(pattern[topRight2]);
      unsigned bottomLeft = bottomLeftCorner(pattern[0]);
      B2DEBUG(100, "topRight2 " << topRight2 << " topRight " << topRight << " bottomLeft " << bottomLeft);
      // average over corners to find cluster center
      unsigned ixTR = 2 * (topRight2 % m_clusterSizeX) + (topRight % 2);
      unsigned ixBL = bottomLeft % 2;
      unsigned iyTR = 2 * (topRight2 / m_clusterSizeX) + (topRight / 2);
      unsigned iyBL = bottomLeft / 2;
      B2DEBUG(100, "ixTR " << ixTR << " ixBL " << ixBL << " iyTR " << iyTR << " iyBL " << iyBL);
      // skip size 1 clusters
      if (m_minCells > 1 && ixTR == ixBL && iyTR == iyBL) {
        B2DEBUG(100, "skipping cluster of size 1");
        continue;
      }
      float centerX = 2 * ix + (ixTR + ixBL) / 2.;
      if (centerX >= m_nCellsPhi) centerX -= m_nCellsPhi;
      float centerY = 2 * iy + (iyTR + iyBL) / 2.;
      B2DEBUG(100, "center at cell (" << centerX << ", " << centerY << ")");
      // convert to coordinates
      double x = -M_PI + (centerX + 0.5) * 2. * M_PI / m_nCellsPhi;
      double y = -maxR + shiftR + (centerY + 0.5) * 2. * maxR / m_nCellsR;
      B2DEBUG(100, "center coordinates (" << x << ", " << y << ")");
      // get list of related hits
      vector <unsigned> idList = {};
      if (m_hitRelationsFromCorners) {
        unsigned icandTR = planeIcand[(ixTR + 2 * ix) % m_nCellsPhi][iyTR + 2 * iy];
        unsigned icandBL = planeIcand[ixBL + 2 * ix][iyBL + 2 * iy];
        vector<unsigned> candIdListTR = houghCand[icandTR].getIdList();
        vector<unsigned> candIdListBL = houghCand[icandBL].getIdList();
        mergeIdList(idList, candIdListTR, candIdListBL);
        B2DEBUG(100, "merge id lists from candidates " << icandTR << " and " << icandBL);
      } else {
        double dx = M_PI / m_nCellsPhi;
        double dy = maxR / m_nCellsR;
        double x1 = (round(centerX) == centerX) ? x - dx : x - 2 * dx;
        double x2 = (round(centerX) == centerX) ? x + dx : x + 2 * dx;
        double y1 = (round(centerY) == centerY) ? y - dy : y - 2 * dy;
        double y2 = (round(centerY) == centerY) ? y + dy : y + 2 * dy;
        findAllCrossingHits(idList, x1, x2, y1, y2, inputMap);
      }
      if (idList.size() == 0) {
        setReturnValue(false);
        B2DEBUG(100, "id list empty");
      }
 
      foundTrack = true;
 
      // select 1 hit per super layer
      vector<unsigned> selectedList = {};
      vector<unsigned> unselectedList = {};
      selectHits(idList, selectedList, unselectedList);
 
      associatedTSHits.clear();
      if (m_useHighPassTimingList) {
        for (unsigned i = 0; i < selectedList.size(); ++i)
          associatedTSHits.push_back(m_segmentHits[selectedList[i]]);
        associatedTSHitsList.push_back(associatedTSHits);
      } else {
        for (unsigned i = 0; i < idList.size(); ++i)
          associatedTSHits.push_back(m_segmentHits[idList[i]]);
        associatedTSHitsList.push_back(associatedTSHits);
      }
 
      // save track
      if (m_storeTracks) {
        const CDCTriggerTrack* track =
          m_tracks.appendNew(x, 2. * y, 0.);
        if (m_useHighPassTimingList) {
          // relations to selected hits
          for (unsigned i = 0; i < selectedList.size(); ++i) {
            unsigned its = selectedList[i];
            track->addRelationTo(m_segmentHits[its]);
          }
          // relations to additional hits get a negative weight
          for (unsigned i = 0; i < unselectedList.size(); ++i) {
            unsigned its = unselectedList[i];
            track->addRelationTo(m_segmentHits[its], -1.);
          }
        } else {
          for (unsigned i = 0; i < idList.size(); ++i) {
            unsigned its = idList[i];
            track->addRelationTo(m_segmentHits[its], -1.);
          }
        }
        // save detail information about the cluster
        const CDCTriggerHoughCluster* cluster =
          m_clusters.appendNew(2 * ix, 2 * (ix + m_clusterSizeX) - 1,
                               2 * iy, 2 * (iy + m_clusterSizeY) - 1,
                               cellIds);
        track->addRelationTo(cluster);
      }
    }
  }
  return foundTrack;
}

◆ sectorTimingList()

std::vector< int > sectorTimingList ( )

Definition at line 848 of file CDCTriggerHoughtrafoForETF.cc.

{
  std::vector<int> ftlists;
  std::array<std::vector<std::pair<int, int>>, CDC_ETF_SECTOR> arr_sector;
 
  // distribute into each sector
  for (long unsigned int iTrack = 0; iTrack < associatedTSHitsList.size(); iTrack++) {
    for (long unsigned int iHit = 0; iHit < associatedTSHitsList[iTrack].size(); iHit++) {
      int sl   = associatedTSHitsList[iTrack][iHit]->getISuperLayer();
      int id   = associatedTSHitsList[iTrack][iHit]->getSegmentID();
      int pp   = associatedTSHitsList[iTrack][iHit]->getPriorityPosition();
      int ft   = associatedTSHitsList[iTrack][iHit]->fastestTime() * 2; // 2ns -> 1ns
 
      arr_sector [getSector(id, sl)].push_back(make_pair(ft, pp));
    }
  }
 
  //fastest && 1st pp in each sector
  for (int sec = 0; sec < CDC_ETF_SECTOR; sec++) {
    if (!arr_sector[sec].size()) continue;
    int minft = 1e9;
    int pp = 0;
    for (auto& ift : arr_sector[sec]) {
      if ((minft > ift.first) && (pp <= ift.second)) {
        minft = ift.first;
        pp = ift.second;
      }
    }
    ftlists.push_back(minft);
  }
 
  return ftlists;
}

◆ selectHits()

void selectHits	(	std::vector< unsigned > &	list,
		std::vector< unsigned > &	selected,
		std::vector< unsigned > &	unselected
	)

Select one hit per super layer.

Parameters

list	input list of hit Ids
selected	selected hit Ids are added to selected
unselected	the rest of the hit Ids are added to unselected

Definition at line 456 of file CDCTriggerHoughtrafoForETF.cc.

{
  std::vector<int> bestPerSL(5, -1);
  for (unsigned i = 0; i < list.size(); ++i) {
    unsigned iax = m_segmentHits[list[i]]->getISuperLayer() / 2;
    bool firstPriority = (m_segmentHits[list[i]]->getPriorityPosition() == 3);
    if (bestPerSL[iax] < 0) {
      bestPerSL[iax] = i;
    } else {
      unsigned itsBest = list[bestPerSL[iax]];
      bool firstBest = (m_segmentHits[itsBest]->getPriorityPosition() == 3);
      // selection rules:
      // first priority, higher ID
      if ((firstPriority && !firstBest) ||
          (firstPriority == firstBest &&
           m_segmentHits[list[i]]->getSegmentID() > m_segmentHits[itsBest]->getSegmentID())) {
        bestPerSL[iax] = i;
      }
    }
  }
 
  for (unsigned i = 0; i < list.size(); ++i) {
    unsigned iax = m_segmentHits[list[i]]->getISuperLayer() / 2;
    if (int(i) == bestPerSL[iax]) selected.push_back(list[i]);
    else unselected.push_back(list[i]);
  }
}

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

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

◆ shortTrack()

bool shortTrack ( bool * superLayers )

check the short track condition (= hits in the inner super layers rather than any super layers)

Parameters

superLayers array of hit/no hit for all super layers

Definition at line 42 of file CDCTriggerHoughtrafoForETF.cc.

{
  unsigned short lcnt = 0;
  // check axial super layers (even layer number),
  // break at first layer without hit
  for (int i = 0; i < CDC_SUPER_LAYERS; i += 2) {
    if (layer[i] == true) ++lcnt;
    else break;
  }
  return (lcnt >= m_minHitsShort);
}

◆ terminate()

void terminate ( void )

overridevirtual

Clean up.

Reimplemented from Module.

Definition at line 359 of file CDCTriggerHoughETFModule.cc.

{
  if (m_testFilename != "") testFile.close();
}

◆ topRightCorner()

unsigned topRightCorner ( unsigned pattern )

Find the top right corner within 2 x 2 square.

In case of ambiguity right corner is returned. x . . x -> return this one @ return index of corner within pattern

Definition at line 790 of file CDCTriggerHoughtrafoForETF.cc.

{
  // scan pattern from right to left:
  // 2 3
  // 0 1
  if ((pattern >> 3) & 1) return 3;
  if ((pattern >> 1) & 1) {
    if ((pattern >> 2) & 1) {
      setReturnValue(false);
      B2DEBUG(100, "topRightCorner not unique");
    }
    return 1;
  }
  if ((pattern >> 2) & 1) return 2;
  return 0;
}

◆ topRightSquare()

unsigned topRightSquare ( std::vector< unsigned > & pattern )

Find the top right square within a cluster of 2 x 2 squares In case of ambiguity, top is favored over right @ return index of corner within pattern vector.

Definition at line 760 of file CDCTriggerHoughtrafoForETF.cc.

{
  // scan from top right corner until an active square is found
  for (unsigned index = pattern.size() - 1; index > 0; --index) {
    if (!pattern[index]) continue;
    // check for ambiguity
    unsigned ix = index % m_clusterSizeX;
    unsigned iy = index / m_clusterSizeX;
    if (ix < m_clusterSizeX - 1 && iy > 0) {
      bool unique = true;
      for (unsigned index2 = index - 1; index2 > 0; --index2) {
        if (!pattern[index2]) continue;
        unsigned ix2 = index2 % m_clusterSizeX;
        unsigned iy2 = index2 / m_clusterSizeX;
        if (iy2 < iy && ix2 > ix) {
          unique = false;
          break;
        }
      }
      if (!unique) {
        setReturnValue(false);
        B2DEBUG(100, "topRightSquare not unique");
      }
    }
    return index;
  }
  return 0;
}

Member Data Documentation

◆ associatedTSHitsList

std::vector<std::vector<CDCTriggerSegmentHit*> > associatedTSHitsList

protected

list of fastest timing of TS associated with Track

Definition at line 199 of file CDCTriggerHoughETFModule.h.

◆ hitMap

cdcMap hitMap

protected

map of TS hits containing <iHit, <iSL, (x, y)>> with iHit: hit index in StoreArray iSL: super layer index

(x, y): coordinates in conformal space

Definition at line 298 of file CDCTriggerHoughETFModule.h.

◆ houghCand

std::vector<CDCTriggerHoughCand> houghCand

protected

Hough Candidates.

Definition at line 300 of file CDCTriggerHoughETFModule.h.

◆ m_arrivalOrder

unsigned m_arrivalOrder

protected

arrival order of fastest timing used as t0 (effective when t0CalcMEthod == 0)

Definition at line 208 of file CDCTriggerHoughETFModule.h.

◆ m_clusterCollectionName

std::string m_clusterCollectionName

protected

Name of the StoreArray containing the clusters formed in the Hough plane.

Definition at line 222 of file CDCTriggerHoughETFModule.h.

◆ m_clusterPattern

bool m_clusterPattern

protected

switch for clustering algorithm (if true use nested patterns)

Definition at line 272 of file CDCTriggerHoughETFModule.h.

◆ m_clusters

StoreArray<CDCTriggerHoughCluster> m_clusters

protected

list of clusters in the Hough map

Definition at line 318 of file CDCTriggerHoughETFModule.h.

◆ m_clusterSizeX

unsigned m_clusterSizeX

protected

maximum cluster size for pattern algorithm

Definition at line 274 of file CDCTriggerHoughETFModule.h.

◆ m_clusterSizeY

unsigned m_clusterSizeY

protected

maximum cluster size for pattern algorithm

Definition at line 276 of file CDCTriggerHoughETFModule.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_connect

unsigned m_connect

protected

number of neighbors to check for connection (4: direct, 6: direct + upper right and lower left corner, 8: direct + all corners)

Definition at line 257 of file CDCTriggerHoughETFModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_eventTime

StoreObjPtr<BinnedEventT0> m_eventTime

protected

StoreObjPtr holding the event time.

Definition at line 191 of file CDCTriggerHoughETFModule.h.

◆ m_EventTimeName

std::string m_EventTimeName

protected

Name of the StoreObject containing the trigger event time.

Definition at line 193 of file CDCTriggerHoughETFModule.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 track segment hits.

Definition at line 218 of file CDCTriggerHoughETFModule.h.

◆ m_hitRelationsFromCorners

bool m_hitRelationsFromCorners

protected

switch for creating relations to hits in the pattern clustering algorithm.

true: create relations for all hits passing through the corners of a cluster, false: create relations for all hits passing though the estimated center of the cluster (can be 0 hits if center is not part of the cluster)

Definition at line 283 of file CDCTriggerHoughETFModule.h.

◆ m_hits

StoreArray<CDCTriggerSegmentHit> m_hits

protected

list of input track segment hits

Definition at line 197 of file CDCTriggerHoughETFModule.h.

◆ m_houghPlane

StoreObjPtr<TMatrix> m_houghPlane

protected

matrix containing the Hough plane

Definition at line 320 of file CDCTriggerHoughETFModule.h.

◆ m_ignore2nd

bool m_ignore2nd

protected

switch to skip second priority hits

Definition at line 259 of file CDCTriggerHoughETFModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_minCells

unsigned m_minCells

protected

minimum number of cells in a cluster to form a track

Definition at line 251 of file CDCTriggerHoughETFModule.h.

◆ m_minHits

unsigned m_minHits

protected

minimum number of hits from different super layers in a Hough cell to form a candidate

Definition at line 246 of file CDCTriggerHoughETFModule.h.

◆ m_minHitsShort

unsigned m_minHitsShort

protected

short tracks require hits in the first minHitsShort super layers to form a candidate

Definition at line 249 of file CDCTriggerHoughETFModule.h.

◆ m_minPt

double m_minPt

protected

Hough plane limit in Pt [GeV].

Definition at line 228 of file CDCTriggerHoughETFModule.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_nCellsPhi

unsigned m_nCellsPhi

protected

number of Hough cells in phi

Definition at line 224 of file CDCTriggerHoughETFModule.h.

◆ m_nCellsR

unsigned m_nCellsR

protected

number of Hough cells in 1/r

Definition at line 226 of file CDCTriggerHoughETFModule.h.

◆ m_offset

int m_offset = 0

protected

offset for ETF simulation

Definition at line 286 of file CDCTriggerHoughETFModule.h.

◆ m_onlyLocalMax

bool m_onlyLocalMax

protected

switch to ignore candidates connected to cells with higher super layer count

Definition at line 253 of file CDCTriggerHoughETFModule.h.

◆ m_outputCollectionName

std::string m_outputCollectionName

protected

Name of the StoreArray containing the tracks found by the Hough tracking.

Definition at line 220 of file CDCTriggerHoughETFModule.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_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_requireSL0

bool m_requireSL0

protected

switch to check separately for a hit in the innermost super layer

Definition at line 263 of file CDCTriggerHoughETFModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_segmentHits

StoreArray<CDCTriggerSegmentHit> m_segmentHits

protected

list of track segment hits

Definition at line 314 of file CDCTriggerHoughETFModule.h.

◆ m_shiftPt

int m_shiftPt

protected

shift the Hough plane in 1/r to avoid curvature 0 tracks < 0: shift in negative direction (negative half is larger) 0: no shift (same limits for negative and positive half)

‍0: shift in positive direction (positive half is larger)

Definition at line 233 of file CDCTriggerHoughETFModule.h.

◆ m_storePlane

unsigned m_storePlane

protected

switch to save the Hough plane in DataStore (0: don't save, 1: save only peaks, 2: save full plane)

Definition at line 270 of file CDCTriggerHoughETFModule.h.

◆ m_storeTracks

bool m_storeTracks

protected

Switch to save the 2D Hough track reconstructed in this module.

Definition at line 195 of file CDCTriggerHoughETFModule.h.

◆ m_suppressClone

bool m_suppressClone

protected

switch to send only the first found track and suppress the subsequent clones

Definition at line 266 of file CDCTriggerHoughETFModule.h.

◆ m_t0CalcMethod

unsigned m_t0CalcMethod

protected

Switch method to determine the event timing.

Definition at line 205 of file CDCTriggerHoughETFModule.h.

◆ m_testFilename

std::string m_testFilename

protected

filename for test output for firmware debugging

Definition at line 289 of file CDCTriggerHoughETFModule.h.

◆ m_timeWindowBegin

short m_timeWindowBegin

protected

Start time of time window relative to median.

(in ns) (effective when t0CalcMEthod == 2)

Definition at line 211 of file CDCTriggerHoughETFModule.h.

◆ m_timeWindowEnd

short m_timeWindowEnd

protected

End time of time window relative to median.

(in ns) (effective when t0CalcMEthod == 2)

Definition at line 214 of file CDCTriggerHoughETFModule.h.

◆ m_tracks

StoreArray<CDCTriggerTrack> m_tracks

protected

list of found tracks

Definition at line 316 of file CDCTriggerHoughETFModule.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.

◆ m_useHighPassTimingList

bool m_useHighPassTimingList

protected

Use associated fastest timings track-by-track.

Definition at line 203 of file CDCTriggerHoughETFModule.h.

◆ m_usePriority

bool m_usePriority

protected

switch between priority position and center position of track segment

Definition at line 261 of file CDCTriggerHoughETFModule.h.

◆ m_usePriorityTiming

bool m_usePriorityTiming

protected

Switch to use priority timing instead of fastest timing.

Definition at line 201 of file CDCTriggerHoughETFModule.h.

◆ maxIterations

unsigned maxIterations = 0

protected

number of iterations for the fast peak finder, smallest n such that 2^(n+1) > max(nCellsPhi, nCellsR).

Initialized at 0 by the SW shifter

Definition at line 240 of file CDCTriggerHoughETFModule.h.

◆ maxR

double maxR = 0.

protected

Hough plane limit in 1/r [1/cm].

Initialized at 0 by the SW shifter

Definition at line 235 of file CDCTriggerHoughETFModule.h.

◆ nCells

unsigned nCells = 0

protected

number of cells for the fast peak finder: 2^(maxIterations + 1).

Initialized at 0 by the SW shifter

Definition at line 242 of file CDCTriggerHoughETFModule.h.

◆ NSEC

const int NSEC[9] = {16, 0, 16, 0, 16, 0, 8, 0, 8}

protected

Number of sector in each super layer.

Definition at line 309 of file CDCTriggerHoughETFModule.h.

◆ NSecOffset

int NSecOffset[9] = {0}

protected

Number of sector offset of each super layer.

Definition at line 311 of file CDCTriggerHoughETFModule.h.

◆ NTS

const int NTS[9] = {160, 160, 192, 224, 256, 288, 320, 352, 384}

protected

Number of track segments in each super layers.

Definition at line 307 of file CDCTriggerHoughETFModule.h.

◆ radius

double radius[9][2] = {{0.}}

protected

Radius of the CDC layers with priority wires (2 per super layer).

Initialized at 0 by the SW shifter

Definition at line 303 of file CDCTriggerHoughETFModule.h.

◆ shiftR

double shiftR = 0.

protected

Hough plane shift in 1/r [1/cm].

Initialized at 0 by the SW shifter

Definition at line 237 of file CDCTriggerHoughETFModule.h.

◆ testFile

std::ofstream testFile

protected

filestream for test output for firmware debugging

Definition at line 291 of file CDCTriggerHoughETFModule.h.

◆ TSoffset

unsigned TSoffset[10] = {0}

protected

Number of track segments up to super layer.

Initialized at 0 by the SW shifter

Definition at line 305 of file CDCTriggerHoughETFModule.h.

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

trg/cdc/modules/houghETF/include/CDCTriggerHoughETFModule.h
trg/cdc/modules/houghETF/src/CDCTriggerHoughETFModule.cc
trg/cdc/modules/houghETF/src/CDCTriggerHoughtrafoForETF.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ CDCTriggerHoughETFModule()

Member Function Documentation

◆ addNeighbors()

◆ beginRun()

◆ bottomLeftCorner()

◆ calcEventTiming()

◆ clone()

◆ connected()

◆ connectedDiag()

◆ connectedLR()

◆ connectedRegions()

◆ connectedUD()

◆ countSL()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ fastInterceptFinder()

◆ findAllCrossingHits()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getSector()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ highPassTimingList()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ inList()

◆ median()

◆ medianInTimeWindow()

◆ mergeIdList()

◆ patternClustering()

◆ sectorTimingList()

◆ selectHits()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()