MCTrackCandClassifierModule Class Reference

The MCTrackCandClassifier Definition Module. More...

#include <MCTrackCandClassifierModule.h>

Inheritance diagram for MCTrackCandClassifierModule:

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
	MCTrackCandClassifierModule ()
	Constructor of the module.
void	initialize () override
	Initializes the Module.
void	beginRun () override
	Begin run.
void	event () override
	Event function.
void	endRun () override
	End run.
void	terminate () override
	Termination action.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

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

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Protected Attributes
std::string	m_mcTrackCandsColName
	TrackCand list name.
std::string	m_mcParticlesName
	MCParticle list name.
std::string	m_rootFileName
	root file name
int	m_nSigma
	nSigma dR
bool	m_usePXD
	Whether to use PXD.
bool	m_applyAnnulus
	Whether to require that the hit is in the expected annulus.
bool	m_applySemiplane
	Whether to require that the hit is in the expected semiplane.
bool	m_applyLap
	Whether to require that the hit belongs to the first lap in the transverse plane.
bool	m_applyWedge
	Whether to require that the hit belong to the barrel part of the SVD.
bool	m_removeBadHits
	Whether to remove the clusters that do not satisfy the criteria from the idealMCTrackCands.
int	m_minHit
	Minimum number of 1D Clusters to classify the MCTrackCand as ideal.
double	m_fraction
	Fraction of lap.
int	nWedge = 0
	Counter for hits on wedged sensors.
int	nBarrel = 0
	Counter for hits on barrel sensors.
TFile *	m_rootFilePtr = nullptr
	Pointer to root file used for storing histograms.
TList *	m_histoList = nullptr
	List of histograms.
TH3F *	m_h3_MCParticle = nullptr
	Histogram.
TH3F *	m_h3_idealMCTrackCand = nullptr
	Histogram.
TH3F *	m_h3_MCTrackCand = nullptr
	Histogram.
TH1F *	m_h1_thetaMS_SVD = nullptr
	Histogram.
TH1F *	m_h1_thetaMS_PXD = nullptr
	Histogram.
TH1F *	m_h1_dR = nullptr
	Histogram.
TH1F *	m_h1_dRoverR = nullptr
	Histogram.
TH1F *	m_h1_distOVERdR = nullptr
	Histogram.
TH1F *	m_h1_hitRadius_accepted = nullptr
	Histogram.
TH1F *	m_h1_hitRadius_rejected = nullptr
	Histogram.
TH1F *	m_h1_hitDistance_accepted = nullptr
	Histogram.
TH1F *	m_h1_hitDistance_rejected = nullptr
	Histogram.
TH1F *	m_h1_MCTrackCandNhits = nullptr
	Histogram.
TH1F *	m_h1_firstRejectedHit = nullptr
	Histogram.
TH1F *	m_h1_firstRejectedOVERMCHit = nullptr
	Histogram.
TH1F *	m_h1_lapTime = nullptr
	Histogram.
TH1F *	m_h1_timeDifference = nullptr
	Histogram.
TH1F *	m_h1_diffOVERlap = nullptr
	Histogram.
TH1F *	m_h1_nGoodTrueHits = nullptr
	Histogram.
TH1F *	m_h1_nBadTrueHits = nullptr
	Histogram.
TH1F *	m_h1_nGood1dInfo = nullptr
	Histogram.
TH1F *	m_h1_nBad1dInfo = nullptr
	Histogram.

Private Member Functions
double	semiPlane (ROOT::Math::XYZVector vertex, ROOT::Math::XYZVector center, ROOT::Math::XYZVector hit)
	Function to get semiplane.
bool	isInSemiPlane (double semiPlane, double omega)
	Function to check if a omega value is in a given semiPlane.
double	theDistance (ROOT::Math::XYZVector center, ROOT::Math::XYZVector hit)
	Get distance between two points.
bool	isInAnnulus (double hitDistance, double R, double dR)
	Function to check if hitDistance is within a given annulus.
bool	isFirstLap (double FirstHitTime, double HitTime, double LapTime)
	Function to check if a hitTime is within a given lapTime, under consideration of m_fraction and with respect to first hit.
TH3F *	createHistogram3D (const char *name, const char *title, Int_t nbinsX, Double_t minX, Double_t maxX, const char *titleX, Int_t nbinsY, Double_t minY, Double_t maxY, const char *titleY, Int_t nbinsZ, Double_t minZ, Double_t maxZ, const char *titleZ, TList *histoList=nullptr)
	Create a 3D ROOT Histogram.
TH3F *	createHistogram3D (const char *name, const char *title, Int_t nbinsX, Double_t *binsX, const char *titleX, Int_t nbinsY, Double_t *binsY, const char *titleY, Int_t nbinsZ, Double_t *binsZ, const char *titleZ, TList *histoList=nullptr)
	Create a 3D ROOT Histogram.
TH1 *	duplicateHistogram (const char *newname, const char *newtitle, TH1 *h, TList *histoList=nullptr)
	Function to clone a histogram.
TH1F *	createHistogramsRatio (const char *name, const char *title, TH1 *hNum, TH1 *hDen, bool isEffPlot, int axisRef)
	Function to create a ratio histogram from two histograms.
void	addEfficiencyPlots (TList *graphList=nullptr)
	Function to create efficiency plots and add them to list.
void	addInefficiencyPlots (TList *graphList=nullptr)
	Function to create inefficiency plots and add them to list.
float	compute_dR (double thetaMS, double omega)
	Calculate dR.
float	compute_thetaMS (MCParticleInfo &mcParticleInfo, VXDTrueHit *aTrueHit)
	Calculate thetaMS.
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< PXDCluster >	m_PXDClusters
	PXDClusters StoreArray.
StoreArray< SVDCluster >	m_SVDClusters
	SVDClusters StoreArray.
StoreArray< MCParticle >	m_MCParticles
	MCParticles StoreArray.
StoreArray< genfit::TrackCand >	m_GenfitMCTrackCands
	MC Genfit TrackCands StoreArray.
StoreArray< genfit::TrackCand >	m_GenfitIdealMCTrackCands
	Ideal Genfit TrackCands StoreArray.
ROOT::Math::XYZVector	m_magField
	magnetic field needed set particle info
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 MCTrackCandClassifier Definition Module.

this module classifies the MCTrackCands in

• idealMCTrackCands: MCTrackCand
• fineMCTrackCands (not produced yet)
• nastyMCTrackCands (not produced yet) on the basis of their properties in order to study the inefficiencies of the pattern recognition and the fitter

Definition at line 42 of file MCTrackCandClassifierModule.h.

Member Typedef Documentation

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

EModulePropFlags

enum EModulePropFlags

inherited

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

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

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

MCTrackCandClassifierModule()

MCTrackCandClassifierModule

(

)

Constructor of the module.

Implementation.

Definition at line 26 of file MCTrackCandClassifierModule.cc.

                                                         : Module()
  , m_rootFilePtr(nullptr)
{
  //Set module properties
  setDescription("This module is meant to classify the MCTrackCands as either ideal, fine and nasty");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("MCParticlesName", m_mcParticlesName,
           "Name of MC Particle collection.",
           std::string(""));
 
  addParam("MCTrackCandCollName", m_mcTrackCandsColName,
           "Name of the input collection of MC track candidates",
           std::string(""));
 
  addParam("rootFileName", m_rootFileName,
           "Name of the root file",
           std::string("MCTrackCandClassifier.root"));
 
  addParam("isInAnnulusCriterium", m_applyAnnulus,
           "Require that the hit is in the expected annulus",
           bool(true));
  addParam("isInSemiplaneCriterium", m_applySemiplane,
           "Require that the hit is in the expected semiplane",
           bool(true));
  addParam("isInFirstLapCriterium", m_applyLap,
           "Require that the hit belong to the first lap in the transverse plane",
           bool(true));
  addParam("isInWedgePartCriterium", m_applyWedge,
           "Require that the hit belong to the barrel part of the SVD",
           bool(true));
  addParam("removeBadHits", m_removeBadHits,
           "Remove the clusters that do not satisfy the criteria from the idealMCTrackCands",
           bool(true));
 
  addParam("minNhits", m_minHit,
           "Minimum number of 1D Clusters to classify the MCTrackCand as ideal",
           int(5));
 
  addParam("nSigma_dR", m_nSigma, "n sigma dR", int(3));
 
  addParam("lapFraction", m_fraction, "Fraction of lap", double(1));
 
  addParam("usePXD", m_usePXD, "Use the PXD or not", bool(true));
}

Member Function Documentation

addEfficiencyPlots()

void addEfficiencyPlots ( TList *  graphList = nullptr )

private

Function to create efficiency plots and add them to list.

Parameters

graphList

pointer to list to add the plots to

Definition at line 655 of file MCTrackCandClassifierModule.cc.

{
  //normalized to MCTrackCands
  TH1F* h_effMCTC_pt = createHistogramsRatio("heffMCTCpt", "fraction of idealMCTrackCand VS pt", m_h3_idealMCTrackCand,
                                             m_h3_MCTrackCand, true, 0);
  histoList->Add(h_effMCTC_pt);
 
  TH1F* h_effMCTC_theta = createHistogramsRatio("heffMCTCtheta", "fraction of idealMCTrackCandVS #lambda", m_h3_idealMCTrackCand,
                                                m_h3_MCTrackCand, true, 1);
  histoList->Add(h_effMCTC_theta);
 
  TH1F* h_effMCTC_phi = createHistogramsRatio("heffMCTCphi", "fraction of idealMCTrackCand VS #phi", m_h3_idealMCTrackCand,
                                              m_h3_MCTrackCand, true, 2);
  histoList->Add(h_effMCTC_phi);
}

addInefficiencyPlots()

void addInefficiencyPlots ( TList *  graphList = nullptr )

private

Function to create inefficiency plots and add them to list.

Parameters

graphList

pointer to list to add the plots to

Definition at line 672 of file MCTrackCandClassifierModule.cc.

{
  //normalized to MCTrackCands
  TH1F* h_ineffMCTC_pt = createHistogramsRatio("hineffMCTCpt", "1 - fraction of idealMCTrackCand VS pt", m_h3_idealMCTrackCand,
                                               m_h3_MCTrackCand, false, 0);
  histoList->Add(h_ineffMCTC_pt);
 
  TH1F* h_ineffMCTC_theta = createHistogramsRatio("hineffMCTCtheta", "1 - fraction of idealMCTrackCandVS #lambda",
                                                  m_h3_idealMCTrackCand, m_h3_MCTrackCand, false, 1);
  histoList->Add(h_ineffMCTC_theta);
 
  TH1F* h_ineffMCTC_phi = createHistogramsRatio("hineffMCTCphi", "1 - fraction of idealMCTrackCand VS #phi", m_h3_idealMCTrackCand,
                                                m_h3_MCTrackCand, false, 2);
  histoList->Add(h_ineffMCTC_phi);
}

beginRun()

void beginRun ( void  )

overridevirtual

Begin run.

Reimplemented from Module.

Definition at line 192 of file MCTrackCandClassifierModule.cc.

{
  nWedge = 0;
  nBarrel = 0;
 
  m_magField = BFieldManager::getField(0, 0, 0) / Unit::T;
}

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

compute_dR()

float compute_dR ( double  thetaMS, double  omega  )

private

Calculate dR.

Parameters

thetaMS	thetaMS of a hit
omega	omega value

Returns

dR value

Definition at line 795 of file MCTrackCandClassifierModule.cc.

{
  double dL;
  if (hitDistance < 1.8) //L1
    dL = 0.4;
  else if (hitDistance < 3) //L2
    dL = 0.8;
  else if (hitDistance < 5) //L3
    dL = 1.6;
  else if (hitDistance < 9) //L4
    dL = 4.2;
  else if (hitDistance < 12) //L5
    dL = 2.4;
  else dL = 3.1;
 
  if ((hitDistance < 3) && (hitDistance > 1.2))
    thetaMS = thetaMS / 2;
 
  double dR = m_nSigma * dL * thetaMS;
 
  return dR;
};

compute_thetaMS()

float compute_thetaMS ( MCParticleInfo &  mcParticleInfo, VXDTrueHit *  aTrueHit  )

private

Calculate thetaMS.

Parameters

mcParticleInfo	mcParticleInfo object
aTrueHit	pointer to vxd true hit

Returns

thetaMS value

Definition at line 819 of file MCTrackCandClassifierModule.cc.

{
  //  double thetaMS = 0.0136 * 14 * sqrt(0.008); //SVD, PXD is half of it
  double thetaMS = 0.0136 * 14;  //SVD, PXD is half of it
 
  double p = mcParticleInfo.getP();
  //  double pt = mcParticleInfo.getPt();
  double E = mcParticleInfo.getEnergy();
 
  double X = sqrt(pow(aTrueHit->getEntryU() - aTrueHit->getExitU(), 2) +
                  pow(aTrueHit->getEntryV() - aTrueHit->getExitV(), 2) +
                  pow(aTrueHit->getEntryW() - aTrueHit->getExitW(), 2));
 
  double X0 = 21.82; // g cm-2
  double rho = 2.329; // g cm-3
  thetaMS = thetaMS / (p * p / E) * sqrt(X / X0 * rho);
 
  return thetaMS;
};

createHistogram3D() [1/2]

TH3F * createHistogram3D ( const char *  name, const char *  title, Int_t  nbinsX, Double_t *  binsX, const char *  titleX, Int_t  nbinsY, Double_t *  binsY, const char *  titleY, Int_t  nbinsZ, Double_t *  binsZ, const char *  titleZ, TList *  histoList = nullptr  )

private

Create a 3D ROOT Histogram.

Parameters

name	name of histogram
title	title of histogram
nbinsX	number of bins on x axis
binsX	x bins
titleX	x axis title
nbinsY	number of bins on y axis
binsY	y bins
titleY	y axis title
nbinsZ	number of bins on z axis
binsZ	z bins
titleZ	z axis title
histoList	list of histograms to add this histogram to

Returns

the histogram

Definition at line 601 of file MCTrackCandClassifierModule.cc.

{
  TH3F* h = new TH3F(name, title, nbinsX, binsX, nbinsY, binsY, nbinsZ, binsZ);
 
  h->GetXaxis()->SetTitle(titleX);
  h->GetYaxis()->SetTitle(titleY);
  h->GetZaxis()->SetTitle(titleZ);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

createHistogram3D() [2/2]

TH3F * createHistogram3D ( const char *  name, const char *  title, Int_t  nbinsX, Double_t  minX, Double_t  maxX, const char *  titleX, Int_t  nbinsY, Double_t  minY, Double_t  maxY, const char *  titleY, Int_t  nbinsZ, Double_t  minZ, Double_t  maxZ, const char *  titleZ, TList *  histoList = nullptr  )

private

Create a 3D ROOT Histogram.

Parameters

name	name of histogram
title	title of histogram
nbinsX	number of bins on x axis
minX	minimal x value
maxX	maximal x value
titleX	x axis title
nbinsY	number of bins on y axis
minY	minimal y value
maxY	maximal y value
titleY	y axis title
nbinsZ	number of bins on z axis
minZ	minimal z value
maxZ	maximal z value
titleZ	z axis title
histoList	list of histograms to add this histogram to

Returns

the histogram

Definition at line 579 of file MCTrackCandClassifierModule.cc.

{
  TH3F* h = new TH3F(name, title, nbinsX, minX, maxX, nbinsY, minY, maxY, nbinsZ, minZ, maxZ);
 
  h->GetXaxis()->SetTitle(titleX);
  h->GetYaxis()->SetTitle(titleY);
  h->GetZaxis()->SetTitle(titleZ);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

createHistogramsRatio()

TH1F * createHistogramsRatio ( const char *  name, const char *  title, TH1 *  hNum, TH1 *  hDen, bool  isEffPlot, int  axisRef  )

private

Function to create a ratio histogram from two histograms.

Parameters

name	name of histogram
title	title of histogram
hNum	histogram for the numerator of the ratio
hDen	histogram for the denominator of the ratio
isEffPlot	if the result is a efficiency plot
axisRef	reference axis to use. (x=0, y=1, z=2)

Returns

the histogram

Definition at line 689 of file MCTrackCandClassifierModule.cc.

{
  TH1F* h1den =  dynamic_cast<TH1F*>(hDen);
  TH1F* h1num =  dynamic_cast<TH1F*>(hNum);
  TH2F* h2den =  dynamic_cast<TH2F*>(hDen);
  TH2F* h2num =  dynamic_cast<TH2F*>(hNum);
  TH3F* h3den =  dynamic_cast<TH3F*>(hDen);
  TH3F* h3num =  dynamic_cast<TH3F*>(hNum);
 
  TH1* hden = nullptr;
  TH1* hnum = nullptr;
 
  if (h1den) {
    hden = new TH1F(*h1den);
    hnum = new TH1F(*h1num);
  }
  if (h2den) {
    hden = new TH2F(*h2den);
    hnum = new TH2F(*h2num);
  }
  if (h3den) {
    hden = new TH3F(*h3den);
    hnum = new TH3F(*h3num);
  }
 
  if (hden == nullptr or hnum == nullptr) {
    B2ERROR("In function createHistogramsRatio: either hden or hnum are a nullptr. This shouldn't happen."\
            "Don't continue creatio of histogram ratios in this case and return nullptr.");
    return nullptr;
  }
 
  TAxis* the_axis;
  TAxis* the_other1;
  TAxis* the_other2;
 
  if (axisRef == 0) {
    the_axis = hden->GetXaxis();
    the_other1 = hden->GetYaxis();
    the_other2 = hden->GetZaxis();
  } else if (axisRef == 1) {
    the_axis = hden->GetYaxis();
    the_other1 = hden->GetXaxis();
    the_other2 = hden->GetZaxis();
  } else if (axisRef == 2) {
    the_axis = hden->GetZaxis();
    the_other1 = hden->GetXaxis();
    the_other2 = hden->GetYaxis();
  } else
    return nullptr;
 
 
  TH1F* h;
  if (the_axis->GetXbins()->GetSize())
    h = new TH1F(name, title, the_axis->GetNbins(), (the_axis->GetXbins())->GetArray());
  else
    h = new TH1F(name, title, the_axis->GetNbins(), the_axis->GetXmin(), the_axis->GetXmax());
  h->GetXaxis()->SetTitle(the_axis->GetTitle());
 
  h->GetYaxis()->SetRangeUser(0.00001, 1);
 
  Int_t bin = 0;
 
  for (int the_bin = 1; the_bin < the_axis->GetNbins() + 1; the_bin++) {
 
    double num = 0;
    double den = 0 ;
 
    for (int other1_bin = 1; other1_bin < the_other1->GetNbins() + 1; other1_bin++)
      for (int other2_bin = 1; other2_bin < the_other2->GetNbins() + 1; other2_bin++) {
 
        if (axisRef == 0) bin = hden->GetBin(the_bin, other1_bin, other2_bin);
        else if (axisRef == 1) bin = hden->GetBin(other1_bin, the_bin, other2_bin);
        else if (axisRef == 2) bin = hden->GetBin(other1_bin, other2_bin, the_bin);
 
        if (hden->IsBinUnderflow(bin))
          B2DEBUG(21, "  bin = " << bin << "(" << the_bin << "," << other1_bin << "," << other2_bin << "), UNDERFLOW");
        if (hden->IsBinOverflow(bin))
          B2DEBUG(21, "  bin = " << bin << "(" << the_bin << "," << other1_bin << "," << other2_bin << "), OVERFLOW");
 
        num += hnum->GetBinContent(bin);
        den += hden->GetBinContent(bin);
      }
    double eff = 0;
    double err = 0;
 
    if (den > 0) {
      eff = (double)num / den;
      err = sqrt(eff * (1 - eff)) / sqrt(den);
    }
 
    if (isEffPlot) {
      h->SetBinContent(the_bin, eff);
      h->SetBinError(the_bin, err);
    } else {
      h->SetBinContent(the_bin, 1 - eff);
      h->SetBinError(the_bin, err);
    }
 
  }
 
  return h;
}

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.

{ beginRun(); }

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.

{ endRun(); }

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.

{ event(); }

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.

{ initialize(); }

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.

{ terminate(); }

duplicateHistogram()

TH1 * duplicateHistogram ( const char *  newname, const char *  newtitle, TH1 *  h, TList *  histoList = nullptr  )

private

Function to clone a histogram.

Parameters

newname	new histogram name
newtitle	new title
h	histogram to clone
histoList	list of histograms to add this histogram to

Returns

the duplicated histogram

Definition at line 623 of file MCTrackCandClassifierModule.cc.

{
  TH1F* h1 =  dynamic_cast<TH1F*>(h);
  TH2F* h2 =  dynamic_cast<TH2F*>(h);
  TH3F* h3 =  dynamic_cast<TH3F*>(h);
 
  TH1* newh = nullptr;
 
  if (h1)
    newh = new TH1F(*h1);
  if (h2)
    newh = new TH2F(*h2);
  if (h3)
    newh = new TH3F(*h3);
 
  if (newh == nullptr) {
    B2ERROR("In function duplicateHistogram: newh is a nullptr. This shouldn't happen."\
            "Don't continue creation of duplicate histogram in this case and return nullptr.");
    return nullptr;
  }
 
  newh->SetName(newname);
  newh->SetTitle(newtitle);
 
  if (histoList)
    histoList->Add(newh);
 
  return newh;
}

endRun()

void endRun ( void  )

overridevirtual

End run.

Reimplemented from Module.

Definition at line 444 of file MCTrackCandClassifierModule.cc.

{
  B2INFO("** MCTrackCandClassifier parameters **");
  B2INFO("rootfilename = " << m_rootFileName);
  B2INFO("use PXD information = " << m_usePXD);
  B2INFO("--> classification criteria:");
  if (m_applyAnnulus)
    B2INFO("  -)  |d - R| < " << m_nSigma << " dL thetaMS");
  if (m_applySemiplane)
    B2INFO("  -)  hit in the expected semiplane");
  if (m_applyLap)
    B2INFO("  -)  HitTime < " << m_fraction << " lap time");
  if (m_applyWedge)
    B2INFO("  -)  hit must be in the barrel part of the VXD");
  B2INFO("");
 
  double num = 0;
  double den = 0;
 
  num = m_h3_idealMCTrackCand->GetEntries();
  den = m_h3_MCTrackCand->GetEntries();
  double efficiency = num / den ;
  double efficiencyErr =  sqrt(efficiency * (1 - efficiency)) / sqrt(den);
 
  B2INFO("");
  B2INFO("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
  B2INFO("~ MCTrackCandClassifier ~ SHORT SUMMARY ~");
  B2INFO("");
  B2INFO(" + overall:");
  B2INFO("   fraction of ideal MCTrackCands = (" << efficiency * 100 << " +/- " << efficiencyErr * 100 << ")% ");
  B2INFO("");
  B2INFO("   # idealMCTrackCand = " << num);
  B2INFO("        # MCTrackCand = " << den);
  B2INFO("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
  B2INFO("");
  B2DEBUG(21, "  nWedge = " << nWedge);
  B2DEBUG(21, " nBarrel = " << nBarrel);
}

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

Reimplemented from Module.

Definition at line 201 of file MCTrackCandClassifierModule.cc.

{
  B2DEBUG(21, "+++++ 1. loop on MCTrackCands");
 
  const VXD::GeoCache& aGeometry = VXD::GeoCache::getInstance();
 
  //1.a retrieve the MCTrackCands
  for (const genfit::TrackCand& mcTrackCand : m_GenfitMCTrackCands) {
 
    int nGoodTrueHits = 0;
    int nGood1Dinfo = 0;
 
    B2DEBUG(21, " a NEW MCTrackCand ");
 
    //1.b retrieve the MCParticle
    RelationVector<MCParticle> MCParticles_fromMCTrackCand = DataStore::getRelationsWithObj<MCParticle>(&mcTrackCand);
 
    B2DEBUG(21, "~~~ " << MCParticles_fromMCTrackCand.size() << " MCParticles related to this MCTrackCand");
    for (int mcp = 0; mcp < (int)MCParticles_fromMCTrackCand.size(); mcp++) { //should be ONE
 
      MCParticle mcParticle = *MCParticles_fromMCTrackCand[mcp];
 
      B2DEBUG(21, " a NEW charged MC Particle, " << mcParticle.getIndex() << ", " << mcParticle.getPDG());
 
      MCParticleInfo mcParticleInfo(mcParticle, m_magField);
 
      B2Vector3D decayVertex = mcParticle.getProductionVertex();
      ROOT::Math::XYZVector mom = mcParticle.getMomentum();
      double charge = mcParticle.getCharge();
      double omega = mcParticleInfo.getOmega();
      double px = mom.x();
      double py = mom.y();
      double pt = mom.Rho();
      double x = decayVertex.X();
      double y = decayVertex.Y();
      double R = 1 / abs(omega); //cm
 
      m_h3_MCTrackCand->Fill(mcParticleInfo.getPt(), mcParticleInfo.getLambda(), mcParticleInfo.getPphi());
 
      double alpha =  R / pt * charge; //cm/GeV
      double Cx = x + alpha * py; //cm
      double Cy = y - alpha * px; //cm
 
      ROOT::Math::XYZVector center(Cx, Cy, 0);
 
      //recover Clusters and loop on them
      int Nhits = mcTrackCand.getNHits();
      m_h1_MCTrackCandNhits->Fill(Nhits);
 
      int cluster = 0;
      bool hasTrueHit = true;
      bool isAccepted = true;
      int firstRejectedHit =  Nhits + 1;
      double prevHitRadius = abs(1 / omega);
 
      double lapTime = 2 * M_PI * mcParticle.getEnergy() / 0.299792 / m_magField.Z();
      double FirstHitTime = -1;
      double HitTime = -1;
 
      bool isFirstSVDhit = true;
 
      while (cluster < Nhits && isAccepted && hasTrueHit) {
        int detId, hitId;
        mcTrackCand.getHit(cluster, detId, hitId);
 
        bool hasPXDCluster = false;
        bool hasSVDuCluster = false;
        bool hasSVDvCluster = false;
 
        double uCoor = 0;
        double vCoor = 0;
        VxdID sensor = 0;
 
        double thetaMS = 0;
 
        if (detId == Const::PXD && m_usePXD) {
 
          PXDCluster* aPXDCluster = m_PXDClusters[hitId];
          RelationVector<PXDTrueHit> PXDTrueHit_fromPXDCluster = aPXDCluster->getRelationsWith<PXDTrueHit>();
          if (PXDTrueHit_fromPXDCluster.size() == 0) {
            B2WARNING("What's happening?!? no True Hit associated to the PXD Cluster");
            hasTrueHit = false;
            isAccepted = false;
            continue;
          }
 
          PXDTrueHit* aPXDTrueHit = PXDTrueHit_fromPXDCluster[0];
          thetaMS = compute_thetaMS(mcParticleInfo, aPXDTrueHit);
          m_h1_thetaMS_PXD->Fill(thetaMS / 2 * 1000); //PXD
 
          uCoor = aPXDTrueHit->getU();
          vCoor = aPXDTrueHit->getV();
          sensor = aPXDTrueHit->getSensorID();
          if (cluster == 0) {
            FirstHitTime = aPXDTrueHit->getGlobalTime();
            HitTime = FirstHitTime;
          } else
            HitTime = aPXDTrueHit->getGlobalTime();
 
          hasPXDCluster = true;
        } else if (detId == Const::SVD) {
          SVDCluster* aSVDCluster = m_SVDClusters[hitId];
          RelationVector<SVDTrueHit> SVDTrueHit_fromSVDCluster = aSVDCluster->getRelationsWith<SVDTrueHit>();
          if (SVDTrueHit_fromSVDCluster.size() == 0) {
            B2WARNING("What's happening?!? no True Hit associated to the SVD Cluster");
            hasTrueHit = false;
            isAccepted = false;
            continue;
          }
 
          SVDTrueHit* aSVDTrueHit = SVDTrueHit_fromSVDCluster[0];
 
          thetaMS = compute_thetaMS(mcParticleInfo, aSVDTrueHit);
          m_h1_thetaMS_SVD->Fill(thetaMS * 1000); //SVD
 
          uCoor = aSVDTrueHit->getU();
          vCoor = aSVDTrueHit->getV();
          sensor = aSVDTrueHit->getSensorID();
          if (isFirstSVDhit) {
            FirstHitTime = aSVDTrueHit->getGlobalTime();
            HitTime = FirstHitTime;
            isFirstSVDhit = false;
 
          } else
            HitTime = aSVDTrueHit->getGlobalTime();
          if (aSVDCluster->isUCluster())
            hasSVDuCluster = true;
          else
            hasSVDvCluster = true;
        } else {
          cluster++;
          continue;
        }
 
        const VXD::SensorInfoBase& aSensorInfo = aGeometry.getSensorInfo(sensor);
        bool accepted4 = true;
        if (m_applyWedge) {
          if (aSensorInfo.getForwardWidth() != aSensorInfo.getBackwardWidth()) {
            nWedge++;
            accepted4 = false;
          } else
            nBarrel++;
        }
 
        ROOT::Math::XYZVector globalHit = aSensorInfo.pointToGlobal(ROOT::Math::XYZVector(uCoor, vCoor, 0), true);
        double hitRadius = theDistance(center, globalHit);
 
        bool accepted1 = true;
        if (m_applySemiplane)
          accepted1 = isInSemiPlane(semiPlane(decayVertex, center, globalHit), omega);
 
        if (accepted1) {
          B2DEBUG(21, "     semiplane: ACCEPTED");
        } else {
          B2DEBUG(21, "     semiplane: REJECTED, next track");
        }
 
        double dR = compute_dR(thetaMS, theDistance(ROOT::Math::XYZVector(0, 0, 0), globalHit));
        m_h1_dR->Fill(dR);
        m_h1_dRoverR->Fill(dR * abs(omega));
        m_h1_distOVERdR->Fill((hitRadius - abs(1 / omega)) / dR);
 
 
        bool accepted2 = true;
        if (m_applyAnnulus)
          accepted2 = isInAnnulus(hitRadius, prevHitRadius, dR);
 
        prevHitRadius = hitRadius;
 
        if (accepted2) {
          B2DEBUG(21, "     annulus: ACCEPTED");
        } else {
          B2DEBUG(21, "     annulus: REJECTED, next track");
        }
 
        bool accepted3 = true;
        if (m_applyLap)
          accepted3 = isFirstLap(FirstHitTime,  HitTime, lapTime);
 
        if (accepted3) {
          B2DEBUG(21, "     lapTime: ACCEPTED");
        } else {
          B2DEBUG(21, "     lapTime: REJECTED, next track");
        }
 
        if (accepted2 && accepted1 && accepted3 && accepted4) {
          nGoodTrueHits ++;
          m_h1_hitDistance_accepted->Fill(theDistance(ROOT::Math::XYZVector(0, 0, 0), globalHit));
          m_h1_hitRadius_accepted->Fill(hitRadius);
        } else {
          m_h1_hitDistance_rejected->Fill(theDistance(ROOT::Math::XYZVector(0, 0, 0), globalHit));
          m_h1_hitRadius_rejected->Fill(hitRadius);
          if (m_removeBadHits)
            firstRejectedHit = cluster;
          isAccepted = false;
          continue;
        }
 
        if (hasPXDCluster)
          nGood1Dinfo = +2;
        else {
          if (hasSVDuCluster)
            nGood1Dinfo++;
          if (hasSVDvCluster)
            nGood1Dinfo++;
        }
        if (hasPXDCluster || hasSVDuCluster || hasSVDvCluster)
          B2DEBUG(21, "cluster: ACCEPTED (" << nGood1Dinfo << ")");
 
        cluster++;
      }//close loop on clusters
 
      if (nGood1Dinfo >= m_minHit) {
        B2DEBUG(21, "  idealMCTrackCand FOUND!! " << nGood1Dinfo << " 1D infos (" << nGoodTrueHits << " good true hits)");
        m_h3_idealMCTrackCand->Fill(mcParticleInfo.getPt(), mcParticleInfo.getLambda(), mcParticleInfo.getPphi());
        m_h1_nGoodTrueHits->Fill(nGoodTrueHits);
        m_h1_nGood1dInfo->Fill(nGood1Dinfo);
 
        genfit::TrackCand* tmpTrackCand = new genfit::TrackCand(mcTrackCand);
 
        if ((int)firstRejectedHit <= (int)mcTrackCand.getNHits()) {
          tmpTrackCand->reset();
          for (int hit = 0; hit < firstRejectedHit; hit++)
            if (mcTrackCand.getHit(hit))
              tmpTrackCand->addHit(mcTrackCand.getHit(hit));
          tmpTrackCand->sortHits();
        }
        m_GenfitIdealMCTrackCands.appendNew(*tmpTrackCand);
 
        m_h1_firstRejectedHit->Fill(tmpTrackCand->getNHits());
        m_h1_firstRejectedOVERMCHit->Fill((float)tmpTrackCand->getNHits() / mcTrackCand.getNHits());
      } else {
        B2DEBUG(21, "  too few good hits (" << nGood1Dinfo << ") to track this one ( vs " << nGoodTrueHits << " true hits)");
        m_h1_nBadTrueHits->Fill(nGoodTrueHits);
        m_h1_nBad1dInfo->Fill(nGood1Dinfo);
      }
 
      B2DEBUG(21, "");
    }//close loop on MCParticles
  }//close loop on MCTrackCands
}

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

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.

{return m_description;}

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.

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

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

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

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

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

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

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

{ 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

Initializes the Module.

Reimplemented from Module.

Definition at line 73 of file MCTrackCandClassifierModule.cc.

{
  // MCParticles, MCTrackCands, MCTracks needed for this module
  m_PXDClusters.isRequired();
  m_SVDClusters.isRequired();
  m_MCParticles.isRequired(m_mcParticlesName);
 
  m_GenfitMCTrackCands.isRequired(m_mcTrackCandsColName);
  m_GenfitIdealMCTrackCands.registerInDataStore("idealMCTrackCands", DataStore::c_ErrorIfAlreadyRegistered);
 
  //create list of histograms to be saved in the rootfile
  m_histoList = new TList;
 
  //set the ROOT File
  m_rootFilePtr = new TFile(m_rootFileName.c_str(), "RECREATE");
 
  //histograms to produce efficiency plots
  Double_t bins_pt[9 + 1] = {0, 0.05, 0.1, 0.15, 0.2, 0.3, 0.5, 1, 2, 3.5}; //GeV/c
  const Double_t bins_theta[10 + 1] = {0, 0.25, 0.5, 0.75, 0.75 + 0.32, 0.75 + 2 * 0.32, 0.75 + 3 * 0.32, 0.75 + 4 * 0.32, 0.75 + 5 * 0.32, 2.65, TMath::Pi()};
  Double_t bins_lambda[10 + 1];
  const Double_t width_lambda =  TMath::Pi() / 10;
  Double_t bins_phi[14 + 1];
  const Double_t width_phi = 2 * TMath::Pi() / 14;
  for (int bin = 0; bin < 14 + 1; bin++)
    bins_phi[bin] = - TMath::Pi() + bin * width_phi;
 
  for (int bin = 0; bin < 10 + 1; bin++) {
    bins_lambda[bin] = - TMath::Pi() / 2 + bin * width_lambda;
    B2DEBUG(21, bins_lambda[bin] << "   " <<  bins_theta[bin]);
  }
 
  m_h3_MCParticle = createHistogram3D("h3MCParticle", "entry per MCParticle",
                                      9, bins_pt, "p_{t} (GeV/c)",
                                      10, bins_lambda, "#lambda",
                                      14, bins_phi, "#phi" /*, m_histoList*/);
 
  m_h3_idealMCTrackCand = (TH3F*)duplicateHistogram("h3idealMCTrackCand",
                                                    "entry per idealMCTrackCand",
                                                    m_h3_MCParticle /*, m_histoList*/);
 
  m_h3_MCTrackCand = (TH3F*)duplicateHistogram("h3MCTrackCand",
                                               "entry per MCTrackCand",
                                               m_h3_MCParticle /*, m_histoList*/);
 
 
  m_h1_thetaMS_SVD = new TH1F("h1thetaMS_SVD", "Multiple Scattering Angle (SVD)", 500, 0, 500);
  m_histoList->Add(m_h1_thetaMS_SVD);
  m_h1_thetaMS_SVD->GetXaxis()->SetTitle("#theta_{MS} (mrad)");
 
  m_h1_thetaMS_PXD = (TH1F*) duplicateHistogram("h1thetaMS_PXD", "Multiple Scattering Angle (PXD)", m_h1_thetaMS_SVD, m_histoList);
 
  m_h1_dR = new TH1F("h1dR", "dR, annulus half width", 1000, 0, 5);
  m_histoList->Add(m_h1_dR);
  m_h1_dR->GetXaxis()->SetTitle("dR (cm)");
 
  m_h1_dRoverR = new TH1F("h1dRoverR", "dR over helix radius", 1000, 0, 0.1);
  m_histoList->Add(m_h1_dRoverR);
  m_h1_dRoverR->GetXaxis()->SetTitle("dR/R");
 
  m_h1_distOVERdR = new TH1F("h1distOVERdR", "(hit radius - helix radius)/dR", 100, -5, 5);
  m_histoList->Add(m_h1_distOVERdR);
  m_h1_distOVERdR->GetXaxis()->SetTitle("(hit R - helix R)/dR");
 
  m_h1_hitRadius_accepted = new TH1F("h1hitRadAccep", "hit radius for accepted hits", 100, 0, 500);
  m_histoList->Add(m_h1_hitRadius_accepted);
  m_h1_hitRadius_accepted->GetXaxis()->SetTitle("hit radius (cm)");
 
  m_h1_hitRadius_rejected = new TH1F("h1hitRadRejec", "hit radius for rejected hits", 100, 0, 500);
  m_histoList->Add(m_h1_hitRadius_rejected);
  m_h1_hitRadius_rejected->GetXaxis()->SetTitle("hit radius (cm)");
 
  m_h1_hitDistance_accepted = new TH1F("h1hitDistCentAccep", "hit distance from 0,0 for accepted hits", 100, 0, 15);
  m_histoList->Add(m_h1_hitDistance_accepted);
  m_h1_hitDistance_accepted->GetXaxis()->SetTitle("hit distance (cm)");
 
  m_h1_hitDistance_rejected = new TH1F("h1hitDistCentRejec", "hit distance from 0,0 for rejected hits", 100, 0, 15);
  m_histoList->Add(m_h1_hitDistance_rejected);
  m_h1_hitDistance_rejected->GetXaxis()->SetTitle("hit distance (cm)");
 
  m_h1_lapTime = new TH1F("h1LapTime", "lap time", 200, 0, 100);
  m_histoList->Add(m_h1_lapTime);
  m_h1_lapTime->GetXaxis()->SetTitle("time (ns)");
 
  m_h1_timeDifference = (TH1F*)duplicateHistogram("h1TimeDiff", "Hit Time Difference",
                                                  m_h1_lapTime, m_histoList);
  m_h1_diffOVERlap = new TH1F("h1HitDiffOVERlap", "Hit Time Difference over Lap Time",
                              100, 0, 1.5);
  m_histoList->Add(m_h1_diffOVERlap);
  m_h1_diffOVERlap->GetXaxis()->SetTitle("hit difference/lap");
 
  m_h1_nGoodTrueHits = new TH1F("h1nTrueHitsGoods", "Number of True Hits for Accepted Tracks", 20, 0, 20);
  m_histoList->Add(m_h1_nGoodTrueHits);
  m_h1_nGoodTrueHits->GetXaxis()->SetTitle("number of hits");
 
  m_h1_nBadTrueHits = new TH1F("h1nTrueHitsBads", "Number of True Hits for Rejected Tracks", 10, 0, 10);
  m_histoList->Add(m_h1_nBadTrueHits);
  m_h1_nBadTrueHits->GetXaxis()->SetTitle("number of hits");
 
  m_h1_nGood1dInfo = new TH1F("h1nGood1Dinfo", "Number of 1D Info for Accepted Tracks", 20, 0, 20);
  m_histoList->Add(m_h1_nGood1dInfo);
  m_h1_nGood1dInfo->GetXaxis()->SetTitle("number of hits");
 
  m_h1_nBad1dInfo = new TH1F("h1nBad1Dinfo", "Number of 1D Info for Rejected Tracks", 20, 0, 20);
  m_histoList->Add(m_h1_nBad1dInfo);
  m_h1_nBad1dInfo->GetXaxis()->SetTitle("number of hits");
 
  m_h1_firstRejectedHit = new TH1F("h1idealMCTCnHit", "idealMCTrackCands number of hits", 40, 0, 40);
  m_histoList->Add(m_h1_firstRejectedHit);
  m_h1_firstRejectedHit->GetXaxis()->SetTitle("# idealMCTrackCands hits");
 
  m_h1_firstRejectedOVERMCHit = new TH1F("h1FirstRejOVERmc", "# idealMCTrackCands hits / # MCTrackCands hits", 100, 0, 1);
  m_histoList->Add(m_h1_firstRejectedOVERMCHit);
  m_h1_firstRejectedOVERMCHit->GetXaxis()->SetTitle("# idealMCTrackCands hits / # MCTrackCands hits");
 
  m_h1_MCTrackCandNhits = (TH1F*)duplicateHistogram("h1MCTrackCandNhits", "number of MCTrackCands hits", m_h1_firstRejectedHit,
                                                    m_histoList);
}

isFirstLap()

bool isFirstLap ( double  FirstHitTime, double  HitTime, double  LapTime  )

private

Function to check if a hitTime is within a given lapTime, under consideration of m_fraction and with respect to first hit.

Parameters

FirstHitTime	time of first hit
HitTime	hit time
LapTime	lap time

Returns

true if in first lap

Definition at line 558 of file MCTrackCandClassifierModule.cc.

{
  bool accepted = false;
 
  B2DEBUG(21, "");
  B2DEBUG(21, " lapTime: " << LapTime);
  B2DEBUG(21, "     FirstHitTime = " << FirstHitTime);
  B2DEBUG(21, "          HitTime = " << HitTime);
  B2DEBUG(21, "       difference = " << HitTime - FirstHitTime);
 
  m_h1_lapTime->Fill(LapTime);
  m_h1_timeDifference->Fill(HitTime - FirstHitTime);
  m_h1_diffOVERlap->Fill((HitTime - FirstHitTime) / LapTime);
 
  if (HitTime - FirstHitTime < m_fraction * LapTime)
    accepted = true;
 
  return accepted;
}

isInAnnulus()

bool isInAnnulus ( double  hitDistance, double  R, double  dR  )

private

Function to check if hitDistance is within a given annulus.

Parameters

hitDistance	distance between two hits
R	radius for annulus
dR	width of annulus

Returns

true if in annulus

Definition at line 541 of file MCTrackCandClassifierModule.cc.

{
  bool accepted = false;
 
  B2DEBUG(21, "");
  B2DEBUG(21, " ANNULUS defined between radii: " << R - dR << " and " << R + dR);
  B2DEBUG(21, "     hit distance = " << hitDistance);
  B2DEBUG(21, "     helix radius = " << R);
  B2DEBUG(21, "               dR = " << dR);
 
  if ((hitDistance > R - dR) && (hitDistance < R + dR))
    accepted = true;
 
  return accepted;
}

isInSemiPlane()

bool isInSemiPlane ( double  semiPlane, double  omega  )

private

Function to check if a omega value is in a given semiPlane.

Parameters

semiPlane	slope of semiplane
omega	Signed curvature

Returns

true if in semiplane

Definition at line 523 of file MCTrackCandClassifierModule.cc.

{
  if (semiPlane * omega > 0)
    return true;
  else
    return false;
}

semiPlane()

double semiPlane ( ROOT::Math::XYZVector  vertex, ROOT::Math::XYZVector  center, ROOT::Math::XYZVector  hit  )

private

Function to get semiplane.

Parameters

vertex	Vertex position
center	center position
hit	hit position

Returns

difference in y-slope between hit and semiplane

Definition at line 502 of file MCTrackCandClassifierModule.cc.

{
  ROOT::Math::XYZVector err = center - vertex;
 
  double semiPlane = err.Y() / err.X() * hit.X() + err.Y() / err.X() * vertex.x() - vertex.Y();
 
  B2DEBUG(21, "");
  B2DEBUG(21, " SEMI-PLANE defined by: y + " << err.Y() / err.X() << " x + " << err.Y() / err.X()*vertex.x() - vertex.Y() << " = 0");
  B2DEBUG(21, "     with: center(" << center.X() << "," << center.Y() << ")");
  B2DEBUG(21, "           decayV(" << vertex.X() << "," << vertex.Y() << ")");
  B2DEBUG(21, "           vector(" << err.X() << "," << err.Y() << ")");
  B2DEBUG(21, "           y SLOPE = " << semiPlane << " VS y HIT = " << hit.Y());
  B2DEBUG(21, "           HIT - SLOPE = " << - semiPlane + hit.Y());
 
  if (vertex.X() < center.X())
    return hit.Y() - semiPlane;
  else
    return semiPlane - hit.Y();
}

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.

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

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

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

terminate()

void terminate ( void  )

overridevirtual

Termination action.

Reimplemented from Module.

Definition at line 484 of file MCTrackCandClassifierModule.cc.

{
  addEfficiencyPlots(m_histoList);
  addInefficiencyPlots(m_histoList);
 
  if (m_rootFilePtr != nullptr) {
    m_rootFilePtr->cd();
 
    TIter nextH(m_histoList);
    TObject* obj;
    while ((obj = nextH()))
      obj->Write();
 
    m_rootFilePtr->Close();
  }
}

theDistance()

double theDistance ( ROOT::Math::XYZVector  center, ROOT::Math::XYZVector  hit  )

private

Get distance between two points.

Parameters

center	center position
hit	hit position

Returns

Distance between the two hits

Definition at line 532 of file MCTrackCandClassifierModule.cc.

{
  double xSquared = TMath::Power(center.X() - hit.X(), 2);
  double ySquared = TMath::Power(center.Y() - hit.Y(), 2);
 
  return TMath::Sqrt(xSquared + ySquared);
}

Member Data Documentation

m_applyAnnulus

bool m_applyAnnulus

protected

Whether to require that the hit is in the expected annulus.

Definition at line 76 of file MCTrackCandClassifierModule.h.

m_applyLap

bool m_applyLap

protected

Whether to require that the hit belongs to the first lap in the transverse plane.

Definition at line 80 of file MCTrackCandClassifierModule.h.

m_applySemiplane

bool m_applySemiplane

protected

Whether to require that the hit is in the expected semiplane.

Definition at line 78 of file MCTrackCandClassifierModule.h.

m_applyWedge

bool m_applyWedge

protected

Whether to require that the hit belong to the barrel part of the SVD.

Definition at line 82 of file MCTrackCandClassifierModule.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_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_fraction

double m_fraction

protected

Fraction of lap.

Definition at line 88 of file MCTrackCandClassifierModule.h.

m_GenfitIdealMCTrackCands

StoreArray<genfit::TrackCand> m_GenfitIdealMCTrackCands

private

Ideal Genfit TrackCands StoreArray.

Definition at line 132 of file MCTrackCandClassifierModule.h.

m_GenfitMCTrackCands

StoreArray<genfit::TrackCand> m_GenfitMCTrackCands

private

MC Genfit TrackCands StoreArray.

Definition at line 131 of file MCTrackCandClassifierModule.h.

m_h1_diffOVERlap

TH1F* m_h1_diffOVERlap = nullptr

protected

Histogram.

Definition at line 119 of file MCTrackCandClassifierModule.h.

m_h1_distOVERdR

TH1F* m_h1_distOVERdR = nullptr

protected

Histogram.

Definition at line 107 of file MCTrackCandClassifierModule.h.

m_h1_dR

TH1F* m_h1_dR = nullptr

protected

Histogram.

Definition at line 105 of file MCTrackCandClassifierModule.h.

m_h1_dRoverR

TH1F* m_h1_dRoverR = nullptr

protected

Histogram.

Definition at line 106 of file MCTrackCandClassifierModule.h.

m_h1_firstRejectedHit

TH1F* m_h1_firstRejectedHit = nullptr

protected

Histogram.

Definition at line 114 of file MCTrackCandClassifierModule.h.

m_h1_firstRejectedOVERMCHit

TH1F* m_h1_firstRejectedOVERMCHit = nullptr

protected

Histogram.

Definition at line 115 of file MCTrackCandClassifierModule.h.

m_h1_hitDistance_accepted

TH1F* m_h1_hitDistance_accepted = nullptr

protected

Histogram.

Definition at line 110 of file MCTrackCandClassifierModule.h.

m_h1_hitDistance_rejected

TH1F* m_h1_hitDistance_rejected = nullptr

protected

Histogram.

Definition at line 111 of file MCTrackCandClassifierModule.h.

m_h1_hitRadius_accepted

TH1F* m_h1_hitRadius_accepted = nullptr

protected

Histogram.

Definition at line 108 of file MCTrackCandClassifierModule.h.

m_h1_hitRadius_rejected

TH1F* m_h1_hitRadius_rejected = nullptr

protected

Histogram.

Definition at line 109 of file MCTrackCandClassifierModule.h.

m_h1_lapTime

TH1F* m_h1_lapTime = nullptr

protected

Histogram.

Definition at line 117 of file MCTrackCandClassifierModule.h.

m_h1_MCTrackCandNhits

TH1F* m_h1_MCTrackCandNhits = nullptr

protected

Histogram.

Definition at line 113 of file MCTrackCandClassifierModule.h.

m_h1_nBad1dInfo

TH1F* m_h1_nBad1dInfo = nullptr

protected

Histogram.

Definition at line 124 of file MCTrackCandClassifierModule.h.

m_h1_nBadTrueHits

TH1F* m_h1_nBadTrueHits = nullptr

protected

Histogram.

Definition at line 122 of file MCTrackCandClassifierModule.h.

m_h1_nGood1dInfo

TH1F* m_h1_nGood1dInfo = nullptr

protected

Histogram.

Definition at line 123 of file MCTrackCandClassifierModule.h.

m_h1_nGoodTrueHits

TH1F* m_h1_nGoodTrueHits = nullptr

protected

Histogram.

Definition at line 121 of file MCTrackCandClassifierModule.h.

m_h1_thetaMS_PXD

TH1F* m_h1_thetaMS_PXD = nullptr

protected

Histogram.

Definition at line 104 of file MCTrackCandClassifierModule.h.

m_h1_thetaMS_SVD

TH1F* m_h1_thetaMS_SVD = nullptr

protected

Histogram.

Definition at line 103 of file MCTrackCandClassifierModule.h.

m_h1_timeDifference

TH1F* m_h1_timeDifference = nullptr

protected

Histogram.

Definition at line 118 of file MCTrackCandClassifierModule.h.

m_h3_idealMCTrackCand

TH3F* m_h3_idealMCTrackCand = nullptr

protected

Histogram.

Definition at line 100 of file MCTrackCandClassifierModule.h.

m_h3_MCParticle

TH3F* m_h3_MCParticle = nullptr

protected

Histogram.

Definition at line 99 of file MCTrackCandClassifierModule.h.

m_h3_MCTrackCand

TH3F* m_h3_MCTrackCand = nullptr

protected

Histogram.

Definition at line 101 of file MCTrackCandClassifierModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_histoList

TList* m_histoList = nullptr

protected

List of histograms.

Definition at line 98 of file MCTrackCandClassifierModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_magField

ROOT::Math::XYZVector m_magField

private

magnetic field needed set particle info

Definition at line 134 of file MCTrackCandClassifierModule.h.

m_MCParticles

StoreArray<MCParticle> m_MCParticles

private

MCParticles StoreArray.

Definition at line 130 of file MCTrackCandClassifierModule.h.

m_mcParticlesName

std::string m_mcParticlesName

protected

MCParticle list name.

Definition at line 68 of file MCTrackCandClassifierModule.h.

m_mcTrackCandsColName

std::string m_mcTrackCandsColName

protected

TrackCand list name.

Definition at line 66 of file MCTrackCandClassifierModule.h.

m_minHit

int m_minHit

protected

Minimum number of 1D Clusters to classify the MCTrackCand as ideal.

Definition at line 86 of file MCTrackCandClassifierModule.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_nSigma

int m_nSigma

protected

nSigma dR

Definition at line 72 of file MCTrackCandClassifierModule.h.

m_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

m_PXDClusters

StoreArray<PXDCluster> m_PXDClusters

private

PXDClusters StoreArray.

Definition at line 128 of file MCTrackCandClassifierModule.h.

m_removeBadHits

bool m_removeBadHits

protected

Whether to remove the clusters that do not satisfy the criteria from the idealMCTrackCands.

Definition at line 84 of file MCTrackCandClassifierModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_rootFileName

std::string m_rootFileName

protected

root file name

Definition at line 70 of file MCTrackCandClassifierModule.h.

m_rootFilePtr

TFile* m_rootFilePtr = nullptr

protected

Pointer to root file used for storing histograms.

Definition at line 96 of file MCTrackCandClassifierModule.h.

m_SVDClusters

StoreArray<SVDCluster> m_SVDClusters

private

SVDClusters StoreArray.

Definition at line 129 of file MCTrackCandClassifierModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

m_usePXD

bool m_usePXD

protected

Whether to use PXD.

Definition at line 74 of file MCTrackCandClassifierModule.h.

nBarrel

int nBarrel = 0

protected

Counter for hits on barrel sensors.

Definition at line 93 of file MCTrackCandClassifierModule.h.

nWedge

int nWedge = 0

protected

Counter for hits on wedged sensors.

Definition at line 91 of file MCTrackCandClassifierModule.h.

---

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

• tracking/modules/mcTrackCandClassifier/include/MCTrackCandClassifierModule.h
• tracking/modules/mcTrackCandClassifier/src/MCTrackCandClassifierModule.cc