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:

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.

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

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.

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

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

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.

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.

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!)

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.

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.

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
std::string	m_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.

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 separated

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

B2Vector3F	m_origin
	origin used internally.

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.

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

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 separated 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 37 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 52 of file SPTCRefereeModule.h.

◆ 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

◆ SPTCRefereeModule()

SPTCRefereeModule ( )

Constructor.

Definition at line 28 of file SPTCRefereeModule.cc.

                                     : Module()
{
  setDescription("Module that does some sanity checks on SpacePointTrackCands to prevent some problematic cases to be "
                 "forwarded to other modules that rely on 'unproblematic' cases (e.g. FilterCalculator). "
                 "Different checks can be enabled by setting the according flags. Using MC information for "
                 "the tests can also be switched on/off for tests where MC information can be helpful.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // names
  addParam("sptcName", m_PARAMsptcName,
           "Container name of the SpacePointTrackCands to be checked (input)",
           m_PARAMsptcName);
  addParam("newArrayName", m_PARAMnewArrayName,
           "Container name of SpacePointTrackCands if 'storeNewArray' is set to true",
           m_PARAMnewArrayName);
  addParam("curlingSuffix", m_PARAMcurlingSuffix,
           "Suffix that will be used to get a name for the StoreArray in which the trackStubs that are obtained by "
           "splitting a curling SPTC get stored. NOTE: If 'storeNewArray' is set to true, "
           "this will not be used and all output SPTCs will be in the same Array!",
           m_PARAMcurlingSuffix);
 
  // flags
  addParam("checkSameSensor", m_PARAMcheckSameSensor,
           "Check if two subsequent SpacePoints are on the same sensor",
           m_PARAMcheckSameSensor);
  addParam("checkMinDistance", m_PARAMcheckMinDistance,
           "Check if two subsequent SpacePoints are separated by more than 'minDistance'",
           m_PARAMcheckMinDistance);
  addParam("checkCurling", m_PARAMcheckCurling,
           "Check the SpacePointTrackCand for curling behaviour and mark it as curling if it does",
           m_PARAMcheckCurling);
  addParam("splitCurlers", m_PARAMsplitCurlers,
           "Split curling SpacePointTrackCands and save the TrackStubs in separate StoreArrays",
           m_PARAMsplitCurlers);
  addParam("keepOnlyFirstPart", m_PARAMkeepOnlyFirstPart,
           "Keep only the first part of a curling SpacePointTrackCand (e.g. when only this is needed)",
           m_PARAMkeepOnlyFirstPart);
  addParam("useMCInfo", m_PARAMuseMCInfo,
           "Set to true if the use of MC information (e.g. from underlying TrueHits) for the checks is wanted, "
           "and to false if the checks should all be done with information that can be obtained from "
           "SpacePoints directly. NOTE: the tests without MC information have to be developed first!",
           m_PARAMuseMCInfo);
  addParam("kickSpacePoint", m_PARAMkickSpacePoint,
           "Set to true if only the 'problematic' SpacePoint shall be kicked and not the whole SpacePointTrackCand",
           m_PARAMkickSpacePoint);
  addParam("storeNewArray", m_PARAMstoreNewArray,
           "Set to true if the checked SpacePointTrackCands should be stored in a new StoreArray."
           "WARNING: all previously registered relations get lost in this way!",
           m_PARAMstoreNewArray);
 
  // other
  addParam("minDistance", m_PARAMminDistance,
           "Minimal Distance [cm] that two subsequent SpacePoints have to be separated if 'checkMinDistance' is enabled",
           m_PARAMminDistance);
  addParam("setOrigin", m_PARAMsetOrigin, "WARNING: still need to find out the units that are used internally! "
           "Reset origin to given point. Used for determining the direction of flight of a particle for a "
           "given hit. Needs to be reset for e.g. testbeam, where origin is not at (0,0,0)",
           m_PARAMsetOrigin);
 
  addParam("minNumSpacePoints", m_PARAMminNumSpacePoints,
           "minimum number of space points that a track candidate has to "
           "contain (added later, set to 0 to reproduce old behavior",
           m_PARAMminNumSpacePoints);
 
  addParam("checkIfFitted", m_PARAMcheckIfFitted,
           "If true a flag is set in the SpacePointTrackCandidate if any related RecoTrack "
           "with successful track fit is found",
           m_PARAMcheckIfFitted);
 
  // initialize counters (cppcheck)
  initializeCounters();
}

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.

147{};

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

{
  std::vector<int> splitInds; // return vector
 
  //catch cases where there are no space points in the trackCand!
  if (trackCand->getHits().size() == 0) return splitInds;
 
  // Only do curling checking if useMCInfo is false, OR if useMCInfo is true if the SPTCs SpacePoints have been checked for a relation to TrueHits!
  if (!m_PARAMuseMCInfo || trackCand->hasRefereeStatus(SpacePointTrackCand::c_checkedTrueHits)) {
 
    std::string mcInfoStr = useMCInfo ? std::string("with") : std::string("without");
    B2DEBUG(20, "Checking SpacePointTrackCand " << trackCand->getArrayIndex() << " from Array " << trackCand->getArrayName() <<
            " for curling behavior " << mcInfoStr << " MC Information");
 
    // get the SpacePoints of the TrackCand
    const std::vector<const SpacePoint*>& tcSpacePoints = trackCand->getHits();
    B2DEBUG(20, "SPTC has " << tcSpacePoints.size() << " SpacePoints");
 
    // get the directions of flight for every SpacePoint
    const std::vector<bool> dirsOfFlight = getDirectionsOfFlight(tcSpacePoints, useMCInfo);
 
    //   if(trackCand->getNHits() != dirsOfFlight.size()) B2FATAL("did not get a direction of flight for every SpacePoint"); // should not /cannot happen
 
    // loop over all entries of dirsOfFlight and compare them pair-wise. If they change -> add Index to splitInds.
    if (!dirsOfFlight.at(0)) {
      // if the direction of flight is inwards for the first hit, push_back 0 -> make information accessible from outside this function
      splitInds.push_back(0);
      B2DEBUG(20, "Direction of flight was inwards for first SpacePoint of this SPTC");
    }
    // DEBUG output
    B2DEBUG(20, "Direction of flight is " << dirsOfFlight.at(0) << " for SpacePoint " << 0 << " of this SPTC");
    for (unsigned int i = 1; i < dirsOfFlight.size(); ++i) {
      B2DEBUG(20, "Direction of flight is " << dirsOfFlight.at(i) << " for SpacePoint " << i << " of this SPTC");
      if (dirsOfFlight.at(i) ^ dirsOfFlight.at(i - 1)) {
        splitInds.push_back(i); // NOTE: using the bitoperator for XOR here to determine if the bools differ!
        B2DEBUG(20, "Direction of flight has changed from SpacePoint " << i - 1 << " to " << i << ".");
      }
    } // END DEBUG output
  } else {
    B2ERROR("'useMCInfo' is set to true, but SpacePoints of SPTC have not been checked for relations to TrueHits! Not Checking this SPTC for curling!");
    trackCand->setTrackStubIndex(-1); // reset to not being checked for curling
  }
  return splitInds;
}

◆ checkMinDistance()

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

protected

Check if two subsequent SpacePoints are separated 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.

{
  B2DEBUG(20, "Checking the distances between consecutive SpacePoints for SpacePointTrackCand " << trackCand->getArrayIndex() <<
          " from Array " << trackCand->getArrayIndex());
  std::vector<int> lowDistanceInds; // return vector
 
  std::vector<const SpacePoint*> spacePoints = trackCand->getHits();
 
  // catch case where the track candidate has no spacepoints
  if (spacePoints.size() == 0) return lowDistanceInds;
 
  B2Vector3F oldPosition = spacePoints.at(0)->getPosition();
 
  for (unsigned int iSp = 1; iSp < spacePoints.size(); ++iSp) {
    B2Vector3F position = spacePoints.at(iSp)->getPosition();
    B2Vector3F diffPos = oldPosition - position;
    B2DEBUG(20, "Position of SpacePoint " << iSp << " (ArrayIndex " << spacePoints.at(iSp)->getArrayIndex() << "): (" << position.X() <<
            "," << position.Y() << "," << position.Z() << "), Position of SpacePoint " << iSp - 1 << ": (" << oldPosition.X() << "," <<
            oldPosition.Y() << "," << oldPosition.Z() << ") --> old - new = (" << diffPos.X() << "," << diffPos.Y() << "," << diffPos.Z() <<
            ")");
 
    if (diffPos.Mag() <= minDistance) {
      B2DEBUG(20, "Position difference is " << diffPos.Mag() <<  " but minDistance is set to " << minDistance << ". SpacePoints: " << iSp
              << " and " << iSp - 1);
      // push back the index of the first SpacePoint (50:50 chance of getting the right one without further testing)
      lowDistanceInds.push_back(iSp);
    }
    oldPosition = position;
  }
 
  return lowDistanceInds;
}

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

{
  B2DEBUG(20, "Checking SpacePointTrackCand " << trackCand->getArrayIndex() << " from Array " << trackCand->getArrayName() <<
          " for consecutive SpacePoints on the same sensor");
  std::vector<int> sameSensorInds; // return vector
 
  std::vector<const SpacePoint*> spacePoints = trackCand->getHits();
 
  // catch cases where the TC has no space points! (Yes that happens!)
  if (spacePoints.size() == 0) return sameSensorInds;
 
  VxdID lastSensorId = spacePoints.at(0)->getVxdID();
 
  for (unsigned int iSp = 1; iSp < spacePoints.size(); ++iSp) {
    VxdID sensorId = spacePoints.at(iSp)->getVxdID();
    B2DEBUG(20, "Checking SpacePoint " << iSp << ". (ArrayIndex " << spacePoints.at(iSp)->getArrayIndex() <<
            ") SensorId of this SpacePoint: " << sensorId << ", SensorId of last SpacePoint: " << lastSensorId);
    if (sensorId == lastSensorId) {
      // push back the index of the first SpacePoint (50:50 chance of getting the right one without further testing) -> retrieving the other index is no big science from this index!!
      sameSensorInds.push_back(iSp - 1);
      B2DEBUG(20, "SpacePoint " << iSp << " and " << iSp - 1 << " are on the same sensor: " << sensorId);
    }
    lastSensorId = sensorId;
  }
 
  return sameSensorInds;
}

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

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

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

◆ 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

event: check SpacePointTrackCands

Reimplemented from Module.

Definition at line 149 of file SPTCRefereeModule.cc.

{
  StoreObjPtr<EventMetaData> eventMetaDataPtr("EventMetaData", DataStore::c_Event);
  const int eventCtr = eventMetaDataPtr->getEvent();
  B2DEBUG(20, "Processing event " << eventCtr << " -----------------------");
 
  const int nTCs = m_inputSpacePointTrackCands.getEntries();
 
  m_totalTrackCandCtr += nTCs;
 
  B2DEBUG(20, "Found " << nTCs << " SpacePointTrackCands in Array " << m_inputSpacePointTrackCands.getName() << " for this event");
 
  for (int iTC = 0; iTC < nTCs; ++iTC) { // loop over all TrackCands
    SpacePointTrackCand* trackCand = m_inputSpacePointTrackCands[iTC];
    B2DEBUG(20, "Processing SpacePointTrackCand " << iTC << ": It has " << trackCand->getNHits() << " SpacePoints in it");
 
    if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 200, PACKAGENAME())) { trackCand->print(); }
    B2DEBUG(20, "refereeStatus of TrackCand before tests: " << trackCand->getRefereeStatus() << " -> " <<
            trackCand->getRefereeStatusString());
 
    // if all tests will be performed -> add checkedByReferee status to the SPTC,
    // CAUTION: if there are new tests this has to be updated!!!, WARNING: if curling check fails,
    // checkedForCurling will return false but hasRefereeStatus(c_checkedByReferee) will return true after this module!
    if (m_PARAMcheckCurling && m_PARAMcheckMinDistance && m_PARAMcheckSameSensor && m_PARAMcheckIfFitted) {
      trackCand->addRefereeStatus(SpacePointTrackCand::c_checkedByReferee);
    }
    bool allChecksClean = true; // assume that all tests will be passed, change to false if one of them fails
    CheckInfo prevChecksInfo;
 
 
    // added check for the number of space points in the track candidate
    if ((int)(trackCand->getNHits()) < m_PARAMminNumSpacePoints) {
      allChecksClean = false;
    }
 
 
    // set a flag if a fitted recotrack is found for that trackcand
    if (m_PARAMcheckIfFitted) {
      // take any related recotrack
      RelationVector<RecoTrack> relatedRecoTracks = trackCand->getRelationsTo<RecoTrack>("ALL");
      if (relatedRecoTracks.size() >= 1) {
        // assume that there is only one!
        if (relatedRecoTracks[0]->wasFitSuccessful()) {
          trackCand->addRefereeStatus(SpacePointTrackCand::c_hasFittedRecoTrack);
        } else {
          allChecksClean = false;
          B2DEBUG(20, "Found RecoTrack was not fitted! Will not use this track candidate for training.");
        }
      } else {
        allChecksClean = false;
        B2DEBUG(20, "No related RecoTrack found. Will not use that track candidate for training");
      }
    }
 
 
    // check same sensors if desired
    if (m_PARAMcheckSameSensor) {
      const std::vector<int> sameSensorInds = checkSameSensor(trackCand);
      std::get<0>(prevChecksInfo) = sameSensorInds;
      if (!sameSensorInds.empty()) {
        m_SameSensorCtr++;
        allChecksClean = false;
        // assign the actually removed indices to the prevChecksInfo
        if (m_PARAMkickSpacePoint) {
          std::get<0>(prevChecksInfo) = removeSpacePoints(trackCand, sameSensorInds);
        } else {
          // only add status if the SpacePoints on the same sensors have not been removed!
          trackCand->addRefereeStatus(SpacePointTrackCand::c_hitsOnSameSensor);
        }
      } else {
        B2DEBUG(20, "Found no two subsequent SpacePoints on the same sensor for this SpacePointTrackCand ("
                << iTC << " in Array " << m_inputSpacePointTrackCands.getName() << ")");
      }
      trackCand->addRefereeStatus(SpacePointTrackCand::c_checkedSameSensors);
      B2DEBUG(20, "refereeStatus of TrackCand after checkSameSensor " << trackCand->getRefereeStatus() << " -> " <<
              trackCand->getRefereeStatusString());
    }
 
 
    // check min distance if desired
    if (m_PARAMcheckMinDistance) {
      const std::vector<int> lowDistanceInds = checkMinDistance(trackCand, m_PARAMminDistance);
      std::get<1>(prevChecksInfo) = lowDistanceInds;
      if (!lowDistanceInds.empty()) {
        m_minDistanceCtr++;
        allChecksClean = false;
        // assign the actually removed indices to the prevChecksInfo
        if (m_PARAMkickSpacePoint) {
          std::get<1>(prevChecksInfo) = removeSpacePoints(trackCand, lowDistanceInds);
        } else {
          // only add status if the SpacePoints not far enough apart have not been removed!
          trackCand->addRefereeStatus(SpacePointTrackCand::c_hitsLowDistance);
        }
      } else {
        B2DEBUG(20, "Found no two subsequent SpacePoints that were closer than " << m_PARAMminDistance <<
                " cm together for this SpacePointTrackCand (" << iTC << " in Array " << m_inputSpacePointTrackCands.getName() << ")");
      }
      trackCand->addRefereeStatus(SpacePointTrackCand::c_checkedMinDistance);
      B2DEBUG(20, "refereeStatus of TrackCand after checkMinDistance " << trackCand->getRefereeStatus() << " -> " <<
              trackCand->getRefereeStatusString());
    }
 
    // vector of TrackStubs that shall be saved to another StoreArray
    std::vector<SpacePointTrackCand> curlingTrackStubs;
    // check curling if desired
    if (m_PARAMcheckCurling) {
      // setting the TrackStubIndex to 0 implies that this trackCand has been checked for curling.
      // (If there is something wrong in the curling check this value is reset to -1!)
      trackCand->setTrackStubIndex(0);
      const std::vector<int> curlingSplitInds = checkCurling(trackCand, m_PARAMuseMCInfo);
      if (!curlingSplitInds.empty()) {
        if (!(curlingSplitInds.at(0) == 0 && curlingSplitInds.size() == 1)) {
          // this means essentially that the direction of flight for this SPTC is inwards for all SpacePoints!
          m_curlingTracksCtr++;
          allChecksClean = false;
          if (m_PARAMsplitCurlers) {
            curlingTrackStubs = splitTrackCand(trackCand, curlingSplitInds, m_PARAMkeepOnlyFirstPart, prevChecksInfo, m_PARAMkickSpacePoint);
            if (curlingTrackStubs.empty()) {
              B2ERROR("The vector returned by splitTrackCand is empty!");
            } // safety measure
          }
          // set this to the original SPTC only after splitting to avoid having this status in the trackStubs
          trackCand->addRefereeStatus(SpacePointTrackCand::c_curlingTrack);
        } else {
          B2DEBUG(20, "The only entry in the return vector of checkCurling is 0! The direction of flight is inwards for the whole SPTC!");
          trackCand->setFlightDirection(false);
          m_allInwardsCtr++;
        }
      } else {
        B2DEBUG(20, "SpacePointTrackCand " << trackCand->getArrayIndex() << " is not curling!");
      }
      B2DEBUG(20, "refereeStatus of TrackCand after checkCurling " << trackCand->getRefereeStatus() << " -> " <<
              trackCand->getRefereeStatusString());
    }
 
    // PROCESSING AFTER CHECKS
    if (allChecksClean) trackCand->addRefereeStatus(SpacePointTrackCand::c_checkedClean);
 
    B2DEBUG(20, "referee Status of SPTC after referee module: " << trackCand->getRefereeStatus() << " -> " <<
            trackCand->getRefereeStatusString());
    if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 200, PACKAGENAME())) { trackCand->print();}
 
    // store in appropriate StoreArray
    if (m_PARAMstoreNewArray) {
      if (!trackCand->isCurling()) { copyToNewStoreArray(trackCand, m_optionalOutputSpacePointTrackCands); }
      else {
        for (const SpacePointTrackCand& trackStub : curlingTrackStubs) { addToStoreArray(trackStub, m_optionalOutputSpacePointTrackCands, trackCand); }
      }
    } else {
      if (trackCand->isCurling()) {
        for (const SpacePointTrackCand& trackStub : curlingTrackStubs) { addToStoreArray(trackStub, m_curlingSpacePointTrackCands, trackCand); }
      }
    }
  }
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ 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 reset!

Definition at line 685 of file SPTCRefereeModule.cc.

{
  unsigned short int status = trackCand->getRefereeStatus();
  if (trackCand->hasRefereeStatus(SpacePointTrackCand::c_hitsLowDistance)) status -= SpacePointTrackCand::c_hitsLowDistance;
  if (trackCand->hasRefereeStatus(SpacePointTrackCand::c_hitsOnSameSensor)) status -= SpacePointTrackCand::c_hitsOnSameSensor;
  if (trackCand->hasRefereeStatus(SpacePointTrackCand::c_removedHits)) status -= SpacePointTrackCand::c_removedHits;
  return status;
}

◆ 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

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

{
  std::vector<bool> dirsOfFlight; // return vector
 
  if (useMCInfo) {
    try {
      for (const SpacePoint* spacePoint : spacePoints) {  // loop over all SpacePoints
        if (spacePoint->getType() == VXD::SensorInfoBase::PXD) {
          dirsOfFlight.push_back(getDirOfFlightTrueHit<PXDTrueHit>(spacePoint, m_origin));
        } else if (spacePoint->getType() == VXD::SensorInfoBase::SVD) {
          dirsOfFlight.push_back(getDirOfFlightTrueHit<SVDTrueHit>(spacePoint, m_origin));
        } else throw
          SpacePointTrackCand::UnsupportedDetType(); // NOTE: should never happen, because SpacePointTrackCand can only handle PXD and SVD at the moment!
      }
    } catch (SpacePointTrackCand::UnsupportedDetType& anE) {
      B2FATAL("Caught a fatal exception while checking if a SpacePointTrackCand curls: " <<
              anE.what()); // FATAL because if this happens this needs some time to implement and it affects more than only this module!
    }
  } else {
    dirsOfFlight = getDirsOfFlightSpacePoints(spacePoints, m_origin);
  }
 
  return dirsOfFlight;
}

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

{
  // calculate the position relative to the set origin, and add the momentum to the position to get the direction of flight
  B2Vector3F originToHit = position - origin;
 
  B2DEBUG(20, "Position relative to origin: (" << originToHit.x() << "," << originToHit.y() << "," << originToHit.z() <<
          "). Momentum : (" << momentum.x() << "," << momentum.y() << "," <<
          momentum.z() << ").");
 
  // get dot product of momentum and hit position for the perpendicular component only!
  float dot_xy = originToHit.x() * momentum.x() + originToHit.y() * momentum.y();
 
  B2DEBUG(20, "result dot product xy component between position and momentum: " << dot_xy);
 
  if (dot_xy < 0) {
    B2DEBUG(20, "Direction of flight is inwards for this hit");
    return false;
  } else {
    B2DEBUG(20, "Direction of flight is outwards for this hit");
    return true;
  }
}

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

{
  TrueHitType* trueHit = spacePoint->template getRelatedTo<TrueHitType>("ALL"); // COULDDO: search only certain arrays
 
  if (trueHit == nullptr) {B2FATAL("Found no TrueHit to SpacePoint " << spacePoint->getArrayIndex() << " from Array " << spacePoint->getArrayName()); }
 
  // get SensorId - needed for transforming local to global coordinates
  // cppcheck-suppress nullPointerRedundantCheck
  VxdID vxdID = trueHit->getSensorID();
 
  const VXD::SensorInfoBase& sensorInfoBase = VXD::GeoCache::getInstance().getSensorInfo(vxdID);
  // cppcheck-suppress nullPointerRedundantCheck
  B2Vector3F position = sensorInfoBase.pointToGlobal(B2Vector3F(trueHit->getU(), trueHit->getV(), 0), true); // global position
  // cppcheck-suppress nullPointerRedundantCheck
  B2Vector3F momentum = sensorInfoBase.vectorToGlobal(trueHit->getMomentum(), true); // global momentum
 
  B2DEBUG(20, "Getting the direction of flight for SpacePoint " << spacePoint->getArrayIndex() << ", related to TrueHit " <<
          // cppcheck-suppress nullPointerRedundantCheck
          trueHit->getArrayIndex() << ". Both are on Sensor " << vxdID << ". (TrueHit) Position: (" << position.x() << "," << position.y() <<
          "," << position.z() << "), (TrueHit) Momentum: (" << momentum.x() << "," << momentum.y() << "," << momentum.z() << ")");
 
  return getDirOfFlightPosMom(position, momentum, origin);
}

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

{
  std::vector<bool> dirsOfFlight; // return vector
 
  B2Vector3F oldPosition = origin; // assumption: first position is origin
  for (unsigned int iSP = 0; iSP < spacePoints.size(); ++iSP) {
    B2Vector3F position = spacePoints.at(iSP)->getPosition();
    // estimate momentum by linearizing between old position and new position -> WARNING: not a very good estimate!!!
    B2Vector3F momentumEst = position - oldPosition;
    B2DEBUG(20, "Getting the direction of flight for SpacePoint " << spacePoints.at(iSP)->getArrayIndex() << ". Position: (" <<
            position.x() << "," << position.y() << "," << position.z() << "), estimated momentum: (" << momentumEst.x() << "," <<
            momentumEst.y() << "," << momentumEst.z() << ")");
    dirsOfFlight.push_back(getDirOfFlightPosMom(position, momentumEst, origin));
    oldPosition = position; // reassign for next round
  }
 
  return dirsOfFlight;
}

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )

overridevirtual

initialize: check StoreArrays, initialize counters, ...

Reimplemented from Module.

Definition at line 102 of file SPTCRefereeModule.cc.

{
  B2INFO("SPTCReferee::initialize(): ------------------------------------------------ ");
  // check if StoreArray of SpacePointTrackCands is her
  m_inputSpacePointTrackCands.isRequired(m_PARAMsptcName);
 
  // register new StoreArray
  if (m_PARAMstoreNewArray) {
//     StoreArray<SpacePointTrackCand> m_optionalOutputSpacePointTrackCands(m_PARAMnewArrayName);
    m_optionalOutputSpacePointTrackCands.registerInDataStore(m_PARAMnewArrayName,
                                                             DataStore::c_DontWriteOut | DataStore::c_ErrorIfAlreadyRegistered);
    m_optionalOutputSpacePointTrackCands.registerRelationTo(m_inputSpacePointTrackCands, DataStore::c_Event, DataStore::c_DontWriteOut);
  } else {
    m_curlingArrayName = m_PARAMsptcName + m_PARAMcurlingSuffix;
    B2DEBUG(20, "StoreArray name of the curling parts: " << m_curlingArrayName);
//     StoreArray<SpacePointTrackCand> m_curlingSpacePointTrackCands(m_curlingArrayName);
    m_curlingSpacePointTrackCands.registerInDataStore(m_curlingArrayName,
                                                      DataStore::c_DontWriteOut | DataStore::c_ErrorIfAlreadyRegistered);
    m_curlingSpacePointTrackCands.registerRelationTo(m_inputSpacePointTrackCands, DataStore::c_Event, DataStore::c_DontWriteOut);
  }
 
  // sanity checks on the other parameters
  if (m_PARAMcheckMinDistance) {
    if (m_PARAMminDistance < 0) {
      B2WARNING("minDistance set to value below 0: " << m_PARAMminDistance <<
                ", Taking the absolute value and resetting 'minDistance' to that!");
      m_PARAMminDistance = -m_PARAMminDistance;
    }
  }
 
  B2DEBUG(20, "Provided Parameters: checkSameSensor - " << m_PARAMcheckSameSensor << ", checkMinDistance - " <<
          m_PARAMcheckMinDistance
          << ", checkCurling - " << m_PARAMcheckCurling << ", splitCurlers - " << m_PARAMsplitCurlers << ", keepOnlyFirstPart - " <<
          m_PARAMkeepOnlyFirstPart << ", useMCInfo - " << m_PARAMuseMCInfo << ", kickSpacePoint - " << m_PARAMkickSpacePoint);
  if (m_PARAMsetOrigin.size() != 3) {
    B2WARNING("CurlingTrackCandSplitter::initialize: Provided origin is not a 3D point! Please provide 3 values (x,y,z). "
              "Rejecting user input and setting origin to (0,0,0) for now!");
    m_PARAMsetOrigin.clear();
    m_PARAMsetOrigin.assign(3, 0);
  }
  m_origin.SetXYZ(m_PARAMsetOrigin.at(0), m_PARAMsetOrigin.at(1), m_PARAMsetOrigin.at(2));
  B2DEBUG(20, "Set origin to (x,y,z): (" << m_origin.X() << "," << m_origin.Y() << "," << m_origin.Z() << ")");
 
  initializeCounters();
}

◆ initializeCounters()

void initializeCounters ( )

inlineprotected

initialize all counters to 0

Definition at line 137 of file SPTCRefereeModule.h.

    {
      m_SameSensorCtr = 0;
      m_minDistanceCtr = 0;
      m_totalTrackCandCtr = 0;
      m_kickedSpacePointsCtr = 0;
      m_curlingTracksCtr = 0;
      m_regTrackStubsCtr = 0;
      m_allInwardsCtr = 0;
    }

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

{
  std::vector<int> removedInds; // return vector
  try {
    unsigned int nInds = indsToRemove.size();
    B2DEBUG(20, "Got " << nInds << " indices to remove from SPTC " << trackCand->getArrayIndex());
 
    int nRemoved = 0;
    for (int index : boost::adaptors::reverse(indsToRemove)) { // reverse iteration as trackCand gets 'resized' with every remove
      B2DEBUG(20, "Removing " << nRemoved + 1 << " from " << nInds << ". index = " << index); // +1 only for better readability
      trackCand->removeSpacePoint(index);
      nRemoved++;
      m_kickedSpacePointsCtr++;
      B2DEBUG(20, "Removed SpacePoint " << index << " from SPTC " << trackCand->getArrayIndex());
      // NOTE: this way if a removed SpacePoint is "at the edge" between two trackStubs the status will be assigned to the second of those!
      removedInds.push_back(index - (nInds - nRemoved));
    }
    trackCand->addRefereeStatus(SpacePointTrackCand::c_removedHits);
  } catch (SpacePointTrackCand::SPTCIndexOutOfBounds& anE) {
    B2WARNING("Caught an Exception while trying to remove a SpacePoint from a SpacePointTrackCand: " << anE.what());
  }
 
  return removedInds;
}

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

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

{
  std::vector<SpacePointTrackCand> trackStubs; // return vector
 
  B2DEBUG(20, "Splitting SpacePointTrackCand " << trackCand->getArrayIndex() << " from Array " << trackCand->getArrayName() <<
          ": number of entries in splitIndices " << splitIndices.size());
  //  int trackStub = 0;
  bool dirOfFlight = splitIndices.at(0) != 0; // if first entry is zero the direction of flight is false (= ingoing)
 
  B2DEBUG(20, "first entry of passed vector<int> is " << splitIndices.at(0) << " --> direction of flight is " << dirOfFlight);
  // if the first entry of splitIndices is zero the first TrackStub is from 0 to second entry instead of from 0 to first entry
  int firstLast = dirOfFlight ? splitIndices.at(0) : splitIndices.at(1);
  std::vector<std::pair<int, int> >
  rangeIndices; // .first is starting, .second is final index for each TrackStub. Store them in vector to be able to easily loop over them
  rangeIndices.push_back(std::make_pair(0, firstLast));
 
  if (!onlyFirstPart) { // if more than the first part is desired push_back the other ranges too
    unsigned int iStart = dirOfFlight ? 1 : 2;
    for (unsigned int i = iStart; i < splitIndices.size(); ++i) {
      rangeIndices.push_back(std::make_pair(splitIndices.at(i - 1), splitIndices.at(i)));
    }
    // last TrackStub is from last split index to end of TrackCand
    rangeIndices.push_back(std::make_pair(splitIndices.at(splitIndices.size() - 1), trackCand->getNHits()));
  }
  B2DEBUG(20, "There will be " << rangeIndices.size() << " TrackStubs created for this TrackCand. (size of the passed splitIndices: "
          << splitIndices.size() << ", onlyFirstPart " << onlyFirstPart);
 
  if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 999, PACKAGENAME())) {
    std::stringstream dbOutput;
    dbOutput << "The indices that will be used for splitting the SPTC: ";
    for (auto entry : rangeIndices) { dbOutput << "[" << entry.first << "," << entry.second << ") "; }
    B2DEBUG(20, dbOutput.str());
  }
 
  // loop over all entries in range indices and create a SpacePointTrackCand from it
  for (unsigned int iTs = 0; iTs < rangeIndices.size(); ++iTs) {
    int firstInd = rangeIndices.at(iTs).first;
    int lastInd = rangeIndices.at(iTs).second;
 
    unsigned short int refStatus = getCheckStatus(trackCand);
 
    B2DEBUG(20, "Trying to create TrackStub from SPTC " << trackCand->getArrayIndex() << " with indices [" << firstInd << "," <<
            lastInd << ")");
    // encapsulate in try block to catch indices out of range
    try {
      const std::vector<const SpacePoint*> spacePoints = trackCand->getHitsInRange(firstInd, lastInd);
      const std::vector<double> sortingParams = trackCand->getSortingParametersInRange(firstInd, lastInd);
 
      // create new TrackCand
      SpacePointTrackCand trackStub(spacePoints, trackCand->getPdgCode(), trackCand->getChargeSeed(), trackCand->getMcTrackID());
      trackStub.setSortingParameters(sortingParams);
 
      // set the state seed and the cov seed only for the first trackStub of the TrackCand
      if (iTs < 1) {
        trackStub.set6DSeed(trackCand->getStateSeed());
        trackStub.setCovSeed(trackCand->getCovSeed());
      }
 
      // set the direction of flight and flip it afterwards, because next trackCand hs changed direction of flight
      trackStub.setFlightDirection(dirOfFlight);
      dirOfFlight = !dirOfFlight;
 
      // trackStub index starts at 1 for curling SPTCs. NOTE: this might be subject to changes with the new bitfield in SpacePointTrackCand
      trackStub.setTrackStubIndex(iTs + 1);
 
      // determine and set the referee status of this trackStub based upon the information from the previous tests
      const std::vector<int>& sameSensInds = std::get<0>(prevChecksInfo);
      const std::vector<int>& lowDistInds = std::get<0>(prevChecksInfo);
      bool hasSameSens = vectorHasValueBetween(sameSensInds, rangeIndices.at(iTs));
      bool hasLowDist = vectorHasValueBetween(lowDistInds, rangeIndices.at(iTs));
      if ((hasSameSens || hasLowDist) && removedHits) refStatus += SpacePointTrackCand::c_removedHits;
      if (hasSameSens && !removedHits) refStatus += SpacePointTrackCand::c_hitsOnSameSensor;
      if (hasLowDist && !removedHits) refStatus += SpacePointTrackCand::c_hitsLowDistance;
 
      trackStub.setRefereeStatus(refStatus);
      B2DEBUG(20, "Set TrackStubIndex " << iTs + 1 << " and refereeStatus " << trackStub.getRefereeStatus() <<
              " for this trackStub (refStatus string: " << trackStub.getRefereeStatusString());
 
      trackStubs.push_back(trackStub);
      if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 499, PACKAGENAME())) { trackStub.print(); }
    } catch (SpacePointTrackCand::SPTCIndexOutOfBounds& anE) {
      B2WARNING("Caught an exception while trying to split a curling SpacePointTrackCand: " << anE.what() <<
                " This trackStub will not be created!");
    }
  }
 
  return trackStubs;
}

◆ terminate()

void terminate ( void )

overridevirtual

terminate: print some summary information

Reimplemented from Module.

Definition at line 306 of file SPTCRefereeModule.cc.

{
  // TODO: info output more sophisticated
  std::stringstream summary;
  if (m_PARAMcheckSameSensor) {
    summary << "Checked for consecutive SpacePoints on same sensor and found "
            << m_SameSensorCtr << " TrackCands showing this behavior.\n";
  }
  if (m_PARAMcheckMinDistance) {
    summary << "Checked for minimal distance between two consecutive SpacePoints and found "
            << m_minDistanceCtr << " TrackCands with SpacePoints not far enough apart.\n";
  }
  if (m_PARAMkickSpacePoint) {
    summary << m_kickedSpacePointsCtr << " SpacePoints have been removed from SpacePointTrackCands\n";
  }
  if (m_PARAMcheckCurling) {
    summary << m_curlingTracksCtr << " SPTCs were curling. Registered "
            << m_regTrackStubsCtr << " track stubs. 'splitCurlers' was set to "
            << m_PARAMsplitCurlers << ", 'keepOnlyFirstPart' was set to "
            << m_PARAMkeepOnlyFirstPart << ". There were "
            << m_allInwardsCtr << " SPTCs that had flight direction 'inward' for all SpacePoints in them";
  }
 
  B2INFO("SPTCRefere::terminate(): Module got " << m_totalTrackCandCtr << " SpacePointTrackCands. \n" << summary.str());
 
  if (!m_PARAMuseMCInfo && m_PARAMcheckCurling) {
    B2WARNING("The curling checking without MC Information is at the moment at a very crude and unsophisticated state. "
              "If you have MC information available you should use it to do this check!");
  }
}

◆ 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 235 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_allInwardsCtr

unsigned int m_allInwardsCtr

protected

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

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

std::string m_curlingArrayName

protected

name of the StoreArray in which the trackStubs from a curling SPTC are stored

Definition at line 109 of file SPTCRefereeModule.h.

◆ m_curlingSpacePointTrackCands

StoreArray<SpacePointTrackCand> m_curlingSpacePointTrackCands

private

Curling SpacePointTrackCands StoreArray.

Definition at line 243 of file SPTCRefereeModule.h.

◆ m_curlingTracksCtr

unsigned int m_curlingTracksCtr

protected

counter for tracks that curl

Definition at line 126 of file SPTCRefereeModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_inputSpacePointTrackCands

StoreArray<SpacePointTrackCand> m_inputSpacePointTrackCands

private

Input SpacePointTrackCands StoreArray.

Definition at line 241 of file SPTCRefereeModule.h.

◆ m_kickedSpacePointsCtr

unsigned int m_kickedSpacePointsCtr

protected

counter of kicked SpacePoints

Definition at line 123 of file SPTCRefereeModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_minDistanceCtr

unsigned int m_minDistanceCtr

protected

counter for TrackCands with SpacePoints not far enough apart

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

StoreArray<SpacePointTrackCand> m_optionalOutputSpacePointTrackCands

private

Optional output SpacePointTrackCands StoreArray.

Definition at line 242 of file SPTCRefereeModule.h.

◆ 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 106 of file SPTCRefereeModule.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_PARAMcheckCurling

bool m_PARAMcheckCurling = true

protected

parameter for indicating if the SpacePointTrackCand should be checked for curling

Definition at line 76 of file SPTCRefereeModule.h.

◆ m_PARAMcheckIfFitted

bool m_PARAMcheckIfFitted = true

protected

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

Definition at line 70 of file SPTCRefereeModule.h.

◆ m_PARAMcheckMinDistance

bool m_PARAMcheckMinDistance = true

protected

parameter for indicating if the check for the minimal distance between two subsequent SpacePoints should be done

Definition at line 73 of file SPTCRefereeModule.h.

◆ m_PARAMcheckSameSensor

bool m_PARAMcheckSameSensor = true

protected

parameter for indicating if the check for subsequent SpacePoints being on the same sensor should be done

Definition at line 67 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 64 of file SPTCRefereeModule.h.

◆ m_PARAMkeepOnlyFirstPart

bool m_PARAMkeepOnlyFirstPart = false

protected

parameter for keeping only the first part of a curling SpacePointTrackCand

Definition at line 82 of file SPTCRefereeModule.h.

◆ m_PARAMkickSpacePoint

bool m_PARAMkickSpacePoint = false

protected

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

Definition at line 88 of file SPTCRefereeModule.h.

◆ m_PARAMminDistance

double m_PARAMminDistance = 0.

protected

minimal distance two subsequent SpacePoints have to be separated

Definition at line 98 of file SPTCRefereeModule.h.

◆ m_PARAMminNumSpacePoints

int m_PARAMminNumSpacePoints = 0

protected

only keep track candidates which have at least m_PARAMminNumSpacePoints space points

Definition at line 91 of file SPTCRefereeModule.h.

◆ m_PARAMnewArrayName

std::string m_PARAMnewArrayName = ""

protected

Name of the output container of SpacePointTrackCands if 'storeNewArray' is set to true.

Definition at line 60 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 101 of file SPTCRefereeModule.h.

◆ m_PARAMsplitCurlers

bool m_PARAMsplitCurlers = false

protected

parameter for switching on/off the splitting of curling SpacePointTrackCands

Definition at line 79 of file SPTCRefereeModule.h.

◆ m_PARAMsptcName

std::string m_PARAMsptcName = ""

protected

Name of input container of SpacePointTrackCands.

Definition at line 57 of file SPTCRefereeModule.h.

◆ m_PARAMstoreNewArray

bool m_PARAMstoreNewArray = true

protected

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!)

Definition at line 95 of file SPTCRefereeModule.h.

◆ m_PARAMuseMCInfo

bool m_PARAMuseMCInfo = true

protected

parameter for indicating if MC information should be used or not

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

unsigned int m_regTrackStubsCtr

protected

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

Definition at line 129 of file SPTCRefereeModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_SameSensorCtr

unsigned int m_SameSensorCtr

protected

counter for TrackCands with SpacePoints on the same sensor

Definition at line 114 of file SPTCRefereeModule.h.

◆ m_totalTrackCandCtr

unsigned int m_totalTrackCandCtr

protected

counter for the total number of TrackCands

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

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

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ SPTCRefereeModule()

Member Function Documentation

◆ addToStoreArray()

◆ beginRun()

◆ checkCurling()

◆ checkMinDistance()

◆ checkSameSensor()

◆ clone()

◆ copyToNewStoreArray()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCheckStatus()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getDirectionsOfFlight()

◆ getDirOfFlightPosMom()

◆ getDirOfFlightTrueHit()

◆ getDirsOfFlightSpacePoints()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ initializeCounters()

◆ removeSpacePoints()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ splitTrackCand()

◆ terminate()