Module that does some sanity checks on SpacePointTrackCands that have been created by conversion from genfit::TrackCands by the TrackFinderMCTruth (or any other for that matter) More...

#include <SPTCRefereeModule.h>

Inheritance diagram for SPTCRefereeModule:

[legend]

Collaboration diagram for SPTCRefereeModule:

[legend]

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

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

Public Member Functions
	SPTCRefereeModule ()
	Constructor.

void	initialize () override
	initialize: check StoreArrays, initialize counters, ...

void	event () override
	event: check SpacePointTrackCands

void	terminate () override
	terminate: print some summary information

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

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

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

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

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

void	setLogLevel (int logLevel)
	Configure the log level.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Types
typedef std::tuple< std::vector< int >, std::vector< int > >	CheckInfo
	typedef for storing the outcome of previously done checks to have them available later. More...

Protected Member Functions
void	initializeCounters ()
	initialize all counters to 0

const std::vector< int >	checkSameSensor (Belle2::SpacePointTrackCand *trackCand)
	Check if two subsequent SpacePoints are on the same sensor. More...

const std::vector< int >	checkMinDistance (Belle2::SpacePointTrackCand *trackCand, double minDistance)
	Check if two subsequent SpacePoints are seperated by at least the provided minDistance. More...

const std::vector< int >	checkCurling (Belle2::SpacePointTrackCand *trackCand, bool useMCInfo)
	Check if the SpacePointTrackCand shows curling behavior. More...

const std::vector< bool >	getDirectionsOfFlight (const std::vector< const Belle2::SpacePoint * > &spacePoints, bool useMCInfo)
	get the directions of Flight for every SpacePoint in the passed vector. More...

std::vector< Belle2::SpacePointTrackCand >	splitTrackCand (const Belle2::SpacePointTrackCand *trackCand, const std::vector< int > &splitIndices, bool onlyFirstPart, const CheckInfo &prevChecksInfo, bool removedHits)
	split a curling SpacePointTrackCand into TrackStubs. More...

template<typename TrueHitType >
bool	getDirOfFlightTrueHit (const Belle2::SpacePoint *spacePoint, B2Vector3F origin)
	get the direction of flight for a SpacePoint by using information from the underlying TrueHit NOTE: this method assumes that there are already registered relations to a TrueHit for each SpacePoint (if there are more only the first in the RelationVector will be used!) More...

std::vector< bool >	getDirsOfFlightSpacePoints (const std::vector< const Belle2::SpacePoint * > &spacePoints, B2Vector3F origin)
	get the directions of flight for a vector of SpacePoints using only information from SpacePoints (i.e. More...

bool	getDirOfFlightPosMom (B2Vector3F position, B2Vector3F momentum, B2Vector3F origin)
	get the direction of flight provided the global position and momentum of a SpacePoint/TrueHit for the TrueHit the momentum can be obtained from information stored in it. More...

void	copyToNewStoreArray (const Belle2::SpacePointTrackCand *trackCand, Belle2::StoreArray< Belle2::SpacePointTrackCand > newStoreArray)
	copy the SpacePointTrackCand to a new StoreArray and register a relation to the original trackCand More...

void	addToStoreArray (const Belle2::SpacePointTrackCand &trackCand, Belle2::StoreArray< Belle2::SpacePointTrackCand > storeArray, const Belle2::SpacePointTrackCand *origTrackCand)
	register the SpacePointTrackCand (i.e. More...

unsigned short int	getCheckStatus (const Belle2::SpacePointTrackCand *trackCand)
	get the checked referee status of a SPTC (i.e. More...

const std::vector< int >	removeSpacePoints (Belle2::SpacePointTrackCand *trackCand, const std::vector< int > &indsToRemove)
	remove the SpacePoint passed to this function from the SpacePointTrackCand More...

template<typename T >
bool	vectorHasValueBetween (std::vector< T > V, std::pair< T, T > P)
	function to determine if any of the values in vector V are between the values of P (i.e. More...

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
std::string	m_PARAMsptcName = ""
	Name of input container of SpacePointTrackCands.

std::string	m_PARAMnewArrayName = ""
	Name of the output container of SpacePointTrackCands if 'storeNewArray' is set to true.

std::string	m_PARAMcurlingSuffix = "_curlParts"
	Suffix that will be used to get a name for the StoreArray that holds the trackStubs that were obtained by splitting a curling SPTC. More...

bool	m_PARAMcheckSameSensor = true
	parameter for indicating if the check for subsequent SpacePoints being on the same sensor should be done

bool	m_PARAMcheckIfFitted = true
	if true it is looked for any related RecoTrack and if that RecoTrack has a valid fit.

bool	m_PARAMcheckMinDistance = true
	parameter for indicating if the check for the minimal distance between two subsequent SpacePoints should be done

bool	m_PARAMcheckCurling = true
	parameter for indicating if the SpacePointTrackCand should be checked for curling

bool	m_PARAMsplitCurlers = false
	parameter for switching on/off the splitting of curling SpacePointTrackCands

bool	m_PARAMkeepOnlyFirstPart = false
	parameter for keeping only the first part of a curling SpacePointTrackCand

bool	m_PARAMuseMCInfo = true
	parameter for indicating if MC information should be used or not

bool	m_PARAMkickSpacePoint = false
	parameter for indicating if only the 'problematic' SpacePoint shall be removed from the SPTC or if the whole SPTC shall be kicked

int	m_PARAMminNumSpacePoints = 0
	only keep track candidates which have at least m_PARAMminNumSpacePoints space points

bool	m_PARAMstoreNewArray = true
	parameter for indicating if all checked SpacePointTrackCands should be stored in a new StoreArray NOTE: by storing the SpacePointTrackCands in a new StoreArray all previously registered relations are lost!)

double	m_PARAMminDistance = 0.
	minimal distance two subsequent SpacePoints have to be seperated

std::vector< double >	m_PARAMsetOrigin = { 0., 0., 0. }
	assumed interaction point from which the SpacePointTrackCands emerge. More...

B2Vector3F	m_origin
	origin used internally. More...

std::string	m_curlingArrayName
	name of the StoreArray in which the trackStubs from a curling SPTC are stored

unsigned int	m_SameSensorCtr
	counter for TrackCands with SpacePoints on the same sensor

unsigned int	m_minDistanceCtr
	counter for TrackCands with SpacePoints not far enough apart

unsigned int	m_totalTrackCandCtr
	counter for the total number of TrackCands

unsigned int	m_kickedSpacePointsCtr
	counter of kicked SpacePoints

unsigned int	m_curlingTracksCtr
	counter for tracks that curl

unsigned int	m_regTrackStubsCtr
	counter for the number of track stubs that were registered by this module

unsigned int	m_allInwardsCtr
	counter for the number of SPTCs which have direction of flight inward for all SpacePoints in them

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

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

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

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

Private Attributes
StoreArray< SpacePointTrackCand >	m_inputSpacePointTrackCands
	Input SpacePointTrackCands StoreArray.

StoreArray< SpacePointTrackCand >	m_optionalOutputSpacePointTrackCands
	Optional output SpacePointTrackCands StoreArray.

StoreArray< SpacePointTrackCand >	m_curlingSpacePointTrackCands
	Curling SpacePointTrackCands StoreArray.

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

Module that does some sanity checks on SpacePointTrackCands that have been created by conversion from genfit::TrackCands by the TrackFinderMCTruth (or any other for that matter)

If set by the parameters the module does:

check if a SPTC is curling (at the moment done by the CurlingTrackCandSplitter) and split into sub tracks if necessary
check if two subsequent SpacePoints of a SPTC are on the same sensor
check if two subsequent SpacePoints of a SPTC are seperated at least by a user defined distance (needed for some filters)
all this checks either by using MC information (where necessary) or with information that can be obtained from the SpacePoint

WARNING: Besides of setting different flags, splitting curling SPTCs and removing problematic SpacePoints (if set) the module does nothing! Every decision on how to handle the different outcomes of the different checks is left to the user!

Definition at line 40 of file SPTCRefereeModule.h.

Member Typedef Documentation

◆ CheckInfo

typedef std::tuple<std::vector<int>, std::vector<int> > CheckInfo

protected

typedef for storing the outcome of previously done checks to have them available later.

NOTE: declared as tuple in order to be able to add more stuff to it later on, without breaking the code!

Definition at line 55 of file SPTCRefereeModule.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.

Member Function Documentation

◆ addToStoreArray()

void addToStoreArray	(	const Belle2::SpacePointTrackCand &	trackCand,
		Belle2::StoreArray< Belle2::SpacePointTrackCand >	storeArray,
		const Belle2::SpacePointTrackCand *	origTrackCand
	)

protected

register the SpacePointTrackCand (i.e.

trackStub) in a new StoreArray and register also a relation to the original SpacePointTrackCand

Parameters

trackCand	the SPTC that has to be registered in
storeArray	the StoreArray that the trackCand will be added to
origTrackCand	pointer to the SPTC to which a relation from the trackCand will be registered

Definition at line 673 of file SPTCRefereeModule.cc.

 {
   SpacePointTrackCand* newTC = storeArray.appendNew(trackCand);
   newTC->addRelationTo(origTrackCand);
   B2DEBUG(20, "Added new SPTC to StoreArray " << storeArray.getName() << " and registered relation to SPTC " <<
           origTrackCand->getArrayIndex() << " from Array " << origTrackCand->getArrayName());
   m_regTrackStubsCtr++;
 }

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

◆ checkCurling()

const std::vector< int > checkCurling	(	Belle2::SpacePointTrackCand *	trackCand,
		bool	useMCInfo
	)

protected

Check if the SpacePointTrackCand shows curling behavior.

Returns: empty vector if it is not the case and the indices where the SpacePointTrackCand can be split into TrackStubs such that each of them is no longer curling If the first entry of the returned vector is 0 the direction of flight is inward for the whole SpacePointTrackCand

Definition at line 427 of file SPTCRefereeModule.cc.

◆ checkMinDistance()

const std::vector< int > checkMinDistance	(	Belle2::SpacePointTrackCand *	trackCand,
		double	minDistance
	)

protected

Check if two subsequent SpacePoints are seperated by at least the provided minDistance.

Returns: empty vector if all SpacePoints are far enough apart, indices of SpacePoints that are not elsewise

Definition at line 367 of file SPTCRefereeModule.cc.

◆ checkSameSensor()

const std::vector< int > checkSameSensor ( Belle2::SpacePointTrackCand * trackCand )

protected

Check if two subsequent SpacePoints are on the same sensor.

Returns: empty vector if it is not the case and the indices of the SpacePoints that are on a sensor if there are SpacePoints on the same sensors

Definition at line 338 of file SPTCRefereeModule.cc.

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

◆ copyToNewStoreArray()

void copyToNewStoreArray	(	const Belle2::SpacePointTrackCand *	trackCand,
		Belle2::StoreArray< Belle2::SpacePointTrackCand >	newStoreArray
	)

protected

copy the SpacePointTrackCand to a new StoreArray and register a relation to the original trackCand

Parameters

trackCand	pointer to the original SPTC (which is not in newStoreArray befor this call!)
newStoreArray	StoreArray where a copy of trackCand will be stored with a relation to the trackCand in its original StoreArray

Definition at line 663 of file SPTCRefereeModule.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

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

◆ getCheckStatus()

unsigned short int getCheckStatus ( const Belle2::SpacePointTrackCand * trackCand )

protected

get the checked referee status of a SPTC (i.e.

only which checks have been performed, but not the results) at the moment returns the status of trackCand with c_removedHits, c_hitsOnSameSensor and c_hitsLowDistance resetted!

Definition at line 685 of file SPTCRefereeModule.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

◆ getDirectionsOfFlight()

const std::vector< bool > getDirectionsOfFlight	(	const std::vector< const Belle2::SpacePoint * > &	spacePoints,
		bool	useMCInfo
	)

protected

get the directions of Flight for every SpacePoint in the passed vector.

Returns: true is outgoing, false is ingoing. using MC information can be switched with useMCInfo

Definition at line 566 of file SPTCRefereeModule.cc.

◆ getDirOfFlightPosMom()

bool getDirOfFlightPosMom	(	B2Vector3F	position,
		B2Vector3F	momentum,
		B2Vector3F	origin
	)

protected

get the direction of flight provided the global position and momentum of a SpacePoint/TrueHit for the TrueHit the momentum can be obtained from information stored in it.

For SpacePoints it has to be guessed somehow

Definition at line 639 of file SPTCRefereeModule.cc.

◆ getDirOfFlightTrueHit()

bool getDirOfFlightTrueHit	(	const Belle2::SpacePoint *	spacePoint,
		B2Vector3F	origin
	)

protected

get the direction of flight for a SpacePoint by using information from the underlying TrueHit NOTE: this method assumes that there are already registered relations to a TrueHit for each SpacePoint (if there are more only the first in the RelationVector will be used!)

Parameters

spacePoint	pointer to the SpacePoint of interest
origin	the assumed interaction point

Returns: result of internally called function getDirOfFlightPosMom

Definition at line 593 of file SPTCRefereeModule.cc.

◆ getDirsOfFlightSpacePoints()

std::vector< bool > getDirsOfFlightSpacePoints	(	const std::vector< const Belle2::SpacePoint * > &	spacePoints,
		B2Vector3F	origin
	)

protected

get the directions of flight for a vector of SpacePoints using only information from SpacePoints (i.e.

no MC information) NOTE: as the momentum is no property that can be infered from one SpacePoint. the difference of positions between two consecutive SpacePoints is assumed to be the direction of the momentum (i.e. linear approximation) WARNING: using this it is assumed, that the SpacePointTrackCand emerges from the origin (origin is used to calculate the estimate for the momentum of the first SpacePoint)

Definition at line 619 of file SPTCRefereeModule.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

◆ if_value()

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

inherited

Add a condition to the module.

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

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

◆ removeSpacePoints()

const std::vector< int > removeSpacePoints	(	Belle2::SpacePointTrackCand *	trackCand,
		const std::vector< int > &	indsToRemove
	)

protected

remove the SpacePoint passed to this function from the SpacePointTrackCand

Returns: indices of the SpacePoints that are in took the places of the ones that were removed (i.e. if (i,j,k) are passed -> (i,j-1,k-2) is returned) NOTE: trackCand will be altered!

Definition at line 402 of file SPTCRefereeModule.cc.

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

◆ splitTrackCand()

std::vector< Belle2::SpacePointTrackCand > splitTrackCand	(	const Belle2::SpacePointTrackCand *	trackCand,
		const std::vector< int > &	splitIndices,
		bool	onlyFirstPart,
		const CheckInfo &	prevChecksInfo,
		bool	removedHits
	)

protected

split a curling SpacePointTrackCand into TrackStubs.

Parameters

trackCand	the SpacePointTrackCand that has to be split
splitIndices	indices where to split it
onlyFirstPart	return only the TrackStub that holds the SpacePoint from the first to the first entry of splitIndices (not included in returned SpacePointTrackCand)
prevChecksInfo	determine and set the referee status of the trackStub based upon the information from the previous tests
removedHits	SpacePoints were removed from this SPTC

Definition at line 474 of file SPTCRefereeModule.cc.

◆ vectorHasValueBetween()

bool vectorHasValueBetween	(	std::vector< T >	V,
		std::pair< T, T >	P
	)

inlineprotected

function to determine if any of the values in vector V are between the values of P (i.e.

any value of V is in [P.first, P.second) )

Definition at line 238 of file SPTCRefereeModule.h.

     {
       return std::find_if(V.begin(), V.end(), [&P](const T & aValue) { return (aValue < P.second && aValue >= P.first);}) != V.end();
     }

Member Data Documentation

◆ m_origin

B2Vector3F m_origin

protected

origin used internally.

Gets assigned to the values of m_PARAMsetOrigin, after some sanity checks have been done on it

Definition at line 109 of file SPTCRefereeModule.h.

◆ m_PARAMcurlingSuffix

std::string m_PARAMcurlingSuffix = "_curlParts"

protected

Suffix that will be used to get a name for the StoreArray that holds the trackStubs that were obtained by splitting a curling SPTC.

Only needed if 'storeNewArray' is set to false

Definition at line 67 of file SPTCRefereeModule.h.

◆ m_PARAMsetOrigin

std::vector<double> m_PARAMsetOrigin = { 0., 0., 0. }

protected

assumed interaction point from which the SpacePointTrackCands emerge.

Needed to determine the direction of flight

Definition at line 104 of file SPTCRefereeModule.h.

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

tracking/modules/spacePointCreator/include/SPTCRefereeModule.h
tracking/modules/spacePointCreator/src/SPTCRefereeModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CheckInfo

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ addToStoreArray()

◆ beginRun()

◆ checkCurling()

◆ checkMinDistance()

◆ checkSameSensor()

◆ clone()

◆ copyToNewStoreArray()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ getAfterConditionPath()

◆ getCheckStatus()

◆ getConditionPath()

◆ getDirectionsOfFlight()

◆ getDirOfFlightPosMom()

◆ getDirOfFlightTrueHit()

◆ getDirsOfFlightSpacePoints()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ removeSpacePoints()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ splitTrackCand()

◆ vectorHasValueBetween()

Member Data Documentation

◆ m_origin

◆ m_PARAMcurlingSuffix

◆ m_PARAMsetOrigin