The module creates and saves a Relation between Tracks and ECLCluster in the DataStore. More...

#include <ECLTrackClusterMatchingModule.h>

Inheritance diagram for ECLTrackClusterMatchingModule:

Collaboration diagram for ECLTrackClusterMatchingModule:

[legend]

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

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

Public Member Functions
	ECLTrackClusterMatchingModule ()
	Constructor, for setting module description and parameters.

virtual	~ECLTrackClusterMatchingModule ()
	Use to clean up anything you created in the constructor.

virtual void	initialize () override
	Use this to initialize resources or memory your module needs. More...

virtual void	event () override
	Called once for each event. More...

virtual void	terminate () override
	Clean up anything created in initialize().

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

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

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

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

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

void	setLogLevel (int logLevel)
	Configure the log level.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
bool	isECLEnterHit (const ExtHit &extHit) const
	Check if status of extrapolated hit is entering of ECL.

bool	isECLHit (const ExtHit &extHit) const
	Check if extrapolated hit is inside ECL and matches one of the desired categories.

double	showerQuality (double deltaPhi, double deltaTheta, double pt, int eclDetectorRegion, int hitStatus) const
	Calculate matching quality based on phi and theta consistencies.

double	phiConsistency (double deltaPhi, double pt, int eclDetectorRegion, int hitStatus) const
	Calculate phi consistency based on difference in azimuthal angle. More...

double	thetaConsistency (double deltaTheta, double pt, int eclDetectorRegion, int hitStatus) const
	Calculate theta consistency based on difference in polar angle. More...

bool	trackTowardsGap (double theta) const
	return if track points towards gap or adjacent part of barrel

void	optimizedPTMatchingConsistency (double theta, double pt)
	choose criterion depending on track's pt

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

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

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

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

Private Attributes
StoreArray< ExtHit >	m_extHits
	Required input array of ExtHits.

StoreArray< Track >	m_tracks
	Required input array of Tracks.

StoreArray< TrackFitResult >	m_trackFitResults
	Required input array of TrackFitResults.

StoreArray< ECLCluster >	m_eclClusters
	Required input array of ECLClusters.

StoreArray< ECLShower >	m_eclShowers
	Required input array of ECLShowers.

StoreArray< ECLCalDigit >	m_eclCalDigits
	Required input array of ECLCalDigits.

DBObjPtr< ECLTrackClusterMatchingParameterizations >	m_matchingParameterizations
	Parameterizations of RMS.

TF1	f_phiRMSFWDCROSS
	function to describe phi RMS for FWD CROSS

TF1	f_phiRMSFWDDL
	function to describe phi RMS for FWD DL

TF1	f_phiRMSFWDNEAR
	function to describe phi RMS for FWD NEAR

TF1	f_phiRMSBRLCROSS
	function to describe phi RMS for BRL CROSS

TF1	f_phiRMSBRLDL
	function to describe phi RMS for BRL DL

TF1	f_phiRMSBRLNEAR
	function to describe phi RMS for BRL NEAR

TF1	f_phiRMSBWDCROSS
	function to describe phi RMS for BWD CROSS

TF1	f_phiRMSBWDDL
	function to describe phi RMS for BWD DL

TF1	f_phiRMSBWDNEAR
	function to describe phi RMS for BWD NEAR

TF1	f_thetaRMSFWDCROSS
	function to describe theta RMS for FWD CROSS

TF1	f_thetaRMSFWDDL
	function to describe theta RMS for FWD DL

TF1	f_thetaRMSFWDNEAR
	function to describe theta RMS for FWD NEAR

TF1	f_thetaRMSBRLCROSS
	function to describe theta RMS for BRL CROSS

TF1	f_thetaRMSBRLDL
	function to describe theta RMS for BRL DL

TF1	f_thetaRMSBRLNEAR
	function to describe theta RMS for BRL NEAR

TF1	f_thetaRMSBWDCROSS
	function to describe theta RMS for BWD CROSS

TF1	f_thetaRMSBWDDL
	function to describe theta RMS for BWD DL

TF1	f_thetaRMSBWDNEAR
	function to describe theta RMS for BWD NEAR

DBObjPtr< ECLTrackClusterMatchingThresholds >	m_matchingThresholds
	Optimized matching thresholds.

std::vector< std::pair< double, double > >	m_matchingThresholdValuesFWD
	Matching threshold values for FWD.

std::vector< std::pair< double, std::pair< double, double > > >	m_matchingThresholdValuesBRL
	Matching threshold values for BRL.

std::vector< std::pair< double, double > >	m_matchingThresholdValuesBWD
	Matching threshold values for BWD.

bool	m_angularDistanceMatching
	members of ECLTrackClusterMatching Module More...

bool	m_useOptimizedMatchingConsistency
	if true, a theta dependent matching criterion will be used

bool	m_skipZeroChargeTracks
	if true, tracks whose charge has been set to zero are excluded from track-cluster matching

double	m_matchingConsistency
	minimal quality of ExtHit-ECLCluster pair for positive track-cluster match

double	m_matchingPTThreshold
	pt limit between angular-distance based and crystal-entering based matching algorithm

double	m_brlEdgeTheta
	distance of polar angle from gaps where crystal-entering based matching is applied (in rad)

int	m_minimalCDCHits
	minimal required number of CDC hits before track-cluster match is initiated

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

The module creates and saves a Relation between Tracks and ECLCluster in the DataStore.

It uses the existing Relation between Tracks and ExtHit as well as the Relation between ECLCluster and ExtHit.

Definition at line 34 of file ECLTrackClusterMatchingModule.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

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

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

Definition at line 77 of file Module.h.

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

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

This method can be implemented by subclasses.

Definition at line 147 of file Module.h.

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

◆ event()

void event ( void )

overridevirtual

Called once for each event.

This is most likely where your module will actually do anything.

Reimplemented from Module.

Definition at line 110 of file ECLTrackClusterMatchingModule.cc.

 {
   for (auto& eclCluster : m_eclClusters) {
     eclCluster.setIsTrack(false);
   }
   for (const Track& track : m_tracks) {
     const TrackFitResult* fitResult = track.getTrackFitResultWithClosestMass(Const::pion);
     // TEMPORARY FIX: require minimal number of CDC hits, otherwise exclude tracks from track-cluster matching procedure
     if (!(fitResult->getHitPatternCDC().getNHits() > m_minimalCDCHits)) continue;
     if (m_skipZeroChargeTracks && fitResult->getChargeSign() == 0) continue;
     double theta = fitResult->getMomentum().Theta();
     double pt = fitResult->getTransverseMomentum();
     if (!m_angularDistanceMatching || pt < m_matchingPTThreshold || trackTowardsGap(theta)) {
  
       // Unique shower ids related to this track
       set<int> uniqueShowerIds;
  
       // Need to make sure that we match one shower at most
       set<int> uniquehypothesisIds;
       vector<int> hypothesisIds;
       vector<double> energies;
       vector<int> arrayIndexes;
  
       // Find extrapolated track hits in the ECL, considering
       // only hit points where the track enters the crystal
       // note that more than one crystal belonging to more than one shower
       // can be found
       for (const auto& extHit : track.getRelationsTo<ExtHit>()) {
         if (!isECLEnterHit(extHit)) continue;
         const int cell = extHit.getCopyID() + 1;
  
         // Find ECLCalDigit with same cell ID as ExtHit
         const auto idigit = find_if(m_eclCalDigits.begin(), m_eclCalDigits.end(),
         [&](const ECLCalDigit & d) { return d.getCellId() == cell; }
                                    );
         // Couldn't find ECLCalDigit with same cell ID as the ExtHit
         if (idigit == m_eclCalDigits.end()) continue;
  
         // Save all unique shower IDs of the showers related to idigit
         for (auto& shower : idigit->getRelationsFrom<ECLShower>()) {
           bool inserted = (uniqueShowerIds.insert(shower.getUniqueId())).second;
  
           // If this track <-> shower relation hasn't been set yet, set it for the shower and the ECLCLuster
           if (!inserted) continue;
  
           hypothesisIds.push_back(shower.getHypothesisId());
           energies.push_back(shower.getEnergy());
           arrayIndexes.push_back(shower.getArrayIndex());
           uniquehypothesisIds.insert(shower.getHypothesisId());
  
           B2DEBUG(29, shower.getArrayIndex() << " "  << shower.getHypothesisId() << " " << shower.getEnergy() << " " <<
                   shower.getConnectedRegionId());
  
         } // end loop on shower related to idigit
       } // end loop on ExtHit
  
       // only set the relation for the highest energetic shower per hypothesis
       for (auto hypothesisId : uniquehypothesisIds) {
         double highestEnergy = 0.0;
         int arrayindex = -1;
  
         for (unsigned ix = 0; ix < energies.size(); ix++) {
           if (hypothesisIds[ix] == hypothesisId and energies[ix] > highestEnergy) {
             highestEnergy = energies[ix];
             arrayindex = arrayIndexes[ix];
           }
         }
  
         // if we find a shower, take that one by directly accessing the store array
         if (arrayindex > -1) {
           auto shower = m_eclShowers[arrayindex];
           shower->setIsTrack(true);
           if (m_angularDistanceMatching) {
             track.addRelationTo(shower);
             track.addRelationTo(shower, 1.0, "AngularDistance");
           } else {
             track.addRelationTo(shower, 1.0, "EnterCrystal");
           }
           B2DEBUG(29, shower->getArrayIndex() << " "  << shower->getIsTrack());
  
           // there is a 1:1 relation, just set the relation for the corresponding cluster as well
           ECLCluster* cluster = shower->getRelatedFrom<ECLCluster>();
           if (cluster != nullptr) {
             cluster->setIsTrack(true);
             if (m_angularDistanceMatching) {
               track.addRelationTo(cluster);
               track.addRelationTo(cluster, 1.0, "AngularDistance");
             } else {
               track.addRelationTo(cluster, 1.0, "EnterCrystal");
             }
           }
         }
       } // end loop on hypothesis IDs
     }
     if (m_angularDistanceMatching) {
       // tracks should never be matched to more than one cluster
       if (track.getRelationsTo<ECLCluster>("", "AngularDistance").size() > 0) continue;
       // never match tracks pointing towards gaps or adjacent part of barrel using angular distance
       if (trackTowardsGap(theta)) continue;
       // for low-pt tracks matching based on the angular distance is only applied if track points towards the FWD
       ECL::DetectorRegion trackDetectorRegion = ECL::getDetectorRegion(theta);
       if (pt < m_matchingPTThreshold && trackDetectorRegion != ECL::DetectorRegion::FWD) continue;
  
       map<int, pair<double, int>> hypothesisIdBestQualityCROSSArrayIndexMap;
       map<int, pair<double, int>> hypothesisIdBestQualityDLArrayIndexMap;
       map<int, pair<double, int>> hypothesisIdBestQualityNEARArrayIndexMap;
       set<int> uniqueHypothesisIds;
  
       // Find extrapolated track hits in the ECL, considering only hit points
       // that either are on the sphere, closest to, or on radial direction of an
       // ECLCluster.
       for (const auto& extHit : track.getRelationsTo<ExtHit>()) {
         if (!isECLHit(extHit)) continue;
         ECLCluster* eclCluster = extHit.getRelatedFrom<ECLCluster>();
         if (!eclCluster) continue;
         ECLShower* eclShower = eclCluster->getRelatedTo<ECLShower>();
         if (eclShower != nullptr) {
           // accept only shower from region matching track direction, exception for gaps
           int eclDetectorRegion = eclShower->getDetectorRegion();
           if (abs(eclDetectorRegion - trackDetectorRegion) == 1) continue;
           // never match low-pt tracks with showers in the barrel
           if (pt < m_matchingPTThreshold && eclDetectorRegion == ECL::DetectorRegion::BRL) continue;
           double phiHit = extHit.getPosition().Phi();
           double phiShower = eclShower->getPhi();
           double deltaPhi = phiHit - phiShower;
           if (deltaPhi > M_PI) {
             deltaPhi = deltaPhi - 2 * M_PI;
           } else if (deltaPhi < -M_PI) {
             deltaPhi = deltaPhi + 2 * M_PI;
           }
           double thetaHit = extHit.getPosition().Theta();
           double thetaShower = eclShower->getTheta();
           double deltaTheta = thetaHit - thetaShower;
           ExtHitStatus extHitStatus = extHit.getStatus();
           double quality = showerQuality(deltaPhi, deltaTheta, pt, eclDetectorRegion, extHitStatus);
           int hypothesisId = eclShower->getHypothesisId();
           bool inserted = (uniqueHypothesisIds.insert(hypothesisId)).second;
           if (inserted) {
             hypothesisIdBestQualityCROSSArrayIndexMap.insert(make_pair(hypothesisId, make_pair(0, -1)));
             hypothesisIdBestQualityDLArrayIndexMap.insert(make_pair(hypothesisId, make_pair(0, -1)));
             hypothesisIdBestQualityNEARArrayIndexMap.insert(make_pair(hypothesisId, make_pair(0, -1)));
           }
           if (extHitStatus == EXT_ECLCROSS) {
             if (quality > hypothesisIdBestQualityCROSSArrayIndexMap.at(hypothesisId).first) {
               hypothesisIdBestQualityCROSSArrayIndexMap[hypothesisId] = make_pair(quality, eclShower->getArrayIndex());
             }
           } else if (extHitStatus == EXT_ECLDL) {
             if (quality > hypothesisIdBestQualityDLArrayIndexMap.at(hypothesisId).first) {
               hypothesisIdBestQualityDLArrayIndexMap[hypothesisId] = make_pair(quality, eclShower->getArrayIndex());
             }
           } else {
             if (quality > hypothesisIdBestQualityNEARArrayIndexMap.at(hypothesisId).first) {
               hypothesisIdBestQualityNEARArrayIndexMap[hypothesisId] = make_pair(quality, eclShower->getArrayIndex());
             }
           }
         }
       } // end loop on ExtHits related to Track
  
       vector<map<int, pair<double, int>>> hypothesisIdBestQualityArrayIndexMaps;
       hypothesisIdBestQualityArrayIndexMaps.push_back(hypothesisIdBestQualityCROSSArrayIndexMap);
       hypothesisIdBestQualityArrayIndexMaps.push_back(hypothesisIdBestQualityDLArrayIndexMap);
       hypothesisIdBestQualityArrayIndexMaps.push_back(hypothesisIdBestQualityNEARArrayIndexMap);
       if (m_useOptimizedMatchingConsistency) optimizedPTMatchingConsistency(theta, pt);
       for (const auto& uniqueHypothesisId : uniqueHypothesisIds) {
         for (const auto& hypothesisIdBestQualityArrayIndexMap : hypothesisIdBestQualityArrayIndexMaps) {
           if (hypothesisIdBestQualityArrayIndexMap.at(uniqueHypothesisId).first > m_matchingConsistency
               && hypothesisIdBestQualityArrayIndexMap.at(uniqueHypothesisId).second > -1) {
             auto shower = m_eclShowers[hypothesisIdBestQualityArrayIndexMap.at(uniqueHypothesisId).second];
             shower->setIsTrack(true);
             track.addRelationTo(shower);
             track.addRelationTo(shower, 1.0, "AngularDistance");
             ECLCluster* cluster = shower->getRelatedFrom<ECLCluster>();
             if (cluster != nullptr) {
               cluster->setIsTrack(true);
               track.addRelationTo(cluster);
               track.addRelationTo(cluster, 1.0, "AngularDistance");
             }
             break;
           }
         }
       }
     }
   } // end loop on Tracks
 } // end event loop

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

◆ initialize()

void initialize ( void )

overridevirtual

Use this to initialize resources or memory your module needs.

Also register any outputs of your module (StoreArrays, RelationArrays, StoreObjPtrs) here, see the respective class documentation for details.

Reimplemented from Module.

Definition at line 51 of file ECLTrackClusterMatchingModule.cc.

◆ phiConsistency()

double phiConsistency	(	double	deltaPhi,
		double	pt,
		int	eclDetectorRegion,
		int	hitStatus
	)		const

private

Calculate phi consistency based on difference in azimuthal angle.

Parametrization depends on transverse momentum and detector region of cluster.

Definition at line 323 of file ECLTrackClusterMatchingModule.cc.

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

◆ thetaConsistency()

double thetaConsistency	(	double	deltaTheta,
		double	pt,
		int	eclDetectorRegion,
		int	hitStatus
	)		const

private

Calculate theta consistency based on difference in polar angle.

Parametrization depends on transverse momentum and detector region of cluster.

Definition at line 356 of file ECLTrackClusterMatchingModule.cc.

Member Data Documentation

◆ m_angularDistanceMatching

bool m_angularDistanceMatching

private

members of ECLTrackClusterMatching Module

Track cluster matching method

true: track cluster matching based on angular distance between track at specific points and cluster centers false: track cluster matching based on tracks entering crystals belonging to cluster

Definition at line 124 of file ECLTrackClusterMatchingModule.h.

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

ecl/modules/eclTrackClusterMatching/include/ECLTrackClusterMatchingModule.h
ecl/modules/eclTrackClusterMatching/src/ECLTrackClusterMatchingModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ event()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ phiConsistency()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ thetaConsistency()

Member Data Documentation

◆ m_angularDistanceMatching