Extract CDC dE/dx information from fitted tracks. More...

#include <CDCDedxPIDModule.h>

Inheritance diagram for CDCDedxPIDModule:

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
	CDCDedxPIDModule ()
	Default constructor.

virtual	~CDCDedxPIDModule ()
	Destructor.

virtual void	initialize () override
	Initialize the module.

virtual void	event () override
	This method is called for each event.

virtual void	terminate () override
	End of the event processing.

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

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

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

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

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

void	setLogLevel (int logLevel)
	Configure the log level.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
double	meanCurve (double x, double par, int version) const
	parameterized beta-gamma curve for predicted means

double	getMean (double bg) const
	calculate the predicted mean using the parameterized resolution

double	sigmaCurve (double x, const double par, int version) const
	parameterized resolution for predictions

double	getSigma (double dedx, double nhit, double cos, double timereso) const
	calculate the predicted resolution using the parameterized resolution

double	I2D (double cosTheta, double I) const
	hadron saturation parameterization part 1

double	D2I (double cosTheta, double D) const
	hadron saturation parameterization part 2

void	calculateMeans (double mean, double truncatedMean, double *truncatedMeanErr, const std::vector< double > &dedx) const
	Save arithmetic and truncated mean for the 'dedx' values.

void	saveChiValue (double(&chi)[Const::ChargedStable::c_SetSize], double(&predmean)[Const::ChargedStable::c_SetSize], double(&predres)[Const::ChargedStable::c_SetSize], double p, double dedx, double cos, int nhit, double timereso) const
	for all particles, save chi values into 'chi'.

void	saveLookupLogl (double(&logl)[Const::ChargedStable::c_SetSize], double p, double dedx)
	for all particles, save log-likelihood values into 'logl'.

void	checkPDFs ()
	Check the pdfs for consistency every time they change in the database.

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< CDCDedxTrack >	m_dedxTracks
	Output array of CDCDedxTracks.

StoreArray< CDCDedxLikelihood >	m_dedxLikelihoods
	Output array of CDCDedxLikelihoods.

StoreArray< Track >	m_tracks
	Required array of input Tracks.

StoreArray< RecoTrack >	m_recoTracks
	Required array of input RecoTracks.

StoreArray< MCParticle >	m_mcparticles
	Optional array of input MCParticles.

std::vector< double >	m_meanpars
	dE/dx mean parameters

std::vector< double >	m_sigmapars
	dE/dx resolution parameters

DBObjPtr< CDCdEdxPDFs >	m_DBDedxPDFs
	DB object for dedx:momentum PDFs.

bool	m_trackLevel
	Whether to use track-level or hit-level MC.

bool	m_usePrediction
	Whether to use parameterized means and resolutions or lookup tables.

double	m_removeLowest
	Portion of lowest dE/dx values that should be discarded for truncated mean.

double	m_removeHighest
	Portion of highest dE/dx values that should be discarded for truncated mean.

bool	m_backHalfCurlers
	Whether to use the back half of curlers.

bool	m_enableDebugOutput
	Whether to save information on tracks and associated hits and dE/dx values in DedxTrack objects.

bool	m_useIndividualHits
	Include PDF value for each hit in likelihood.

bool	m_onlyPrimaryParticles
	Only save data for primary particles (as determined by MC truth)

bool	m_ignoreMissingParticles
	Ignore particles for which no PDFs are found.

DBObjPtr< CDCDedxScaleFactor >	m_DBScaleFactor
	Scale factor to make electrons ~1.

DBObjPtr< CDCDedxRunGain >	m_DBRunGain
	Run gain DB object.

DBObjPtr< CDCDedxInjectionTime >	m_DBInjectTime
	time gain/reso DB object

DBObjPtr< CDCDedxCosineCor >	m_DBCosineCor
	Electron saturation correction DB object.

DBObjPtr< CDCDedxCosineEdge >	m_DBCosEdgeCor
	non-linearly ACD correction DB object

DBObjPtr< CDCDedxWireGain >	m_DBWireGains
	Wire gain DB object.

DBObjPtr< CDCDedx2DCell >	m_DB2DCell
	2D correction DB object

DBObjPtr< CDCDedx1DCell >	m_DB1DCell
	1D correction DB object

DBObjPtr< CDCDedxADCNonLinearity >	m_DBNonlADC
	non-linearly ACD correction DB object

DBObjPtr< CDCDedxHadronCor >	m_DBHadronCor
	hadron saturation parameters

std::vector< double >	m_hadronpars
	hadron saturation parameters

int	m_nLayerWires [9] = {}
	number of wires per layer: needed for wire gain calibration

DBObjPtr< CDCDedxMeanPars >	m_DBMeanPars
	dE/dx mean parameters

DBObjPtr< CDCDedxSigmaPars >	m_DBSigmaPars
	dE/dx resolution parameters

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

Extract CDC dE/dx information from fitted tracks.

If a PDF file is specified using the 'PDFFile' parameter, likelihood values for all particle hypotheses are calculated and saved in a CDCDedxLikelihood object.

Performs a simple path length correction to the dE/dx measurement based on individual hits in the CDC and determines the mean and truncated mean dE/dx value for each track.

The 'EnableDebugOutput' option adds CDCDedxTrack objects (one for each genfit::Track), which includes individual dE/dx data points and their corresponding layer, and hit information like reconstructed position, charge, etc.

The reconstruction of flight paths and the used likelihood ratio method are described and evaluated in dE/dx Particle Identification and Pixel Detector Data Reduction for the Belle II Experiment (Chapter 6)

Definition at line 67 of file CDCDedxPIDModule.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

◆ CDCDedxPIDModule()

CDCDedxPIDModule ( )

Default constructor.

Definition at line 43 of file CDCDedxPIDModule.cc.

                                   : Module()
{
  setPropertyFlags(c_ParallelProcessingCertified);
 
  //Set module properties
  setDescription("Extract dE/dx and corresponding log-likelihood from fitted tracks and hits in the CDC.");
 
  //Parameter definitions
  addParam("usePrediction", m_usePrediction,
           "Use parameterized means and resolutions to determine PID values. If false, lookup table PDFs are used.", true);
  addParam("removeLowest", m_removeLowest,
           "Portion of events with low dE/dx that should be discarded", double(0.05));
  addParam("removeHighest", m_removeHighest,
           "Portion of events with high dE/dx that should be discarded", double(0.25));
  addParam("useBackHalfCurlers", m_backHalfCurlers,
           "Whether to use the back half of curlers", false);
  addParam("enableDebugOutput", m_enableDebugOutput,
           "Option to write out debugging information to CDCDedxTracks (DataStore objects).", true);
  addParam("useIndividualHits", m_useIndividualHits,
           "If using lookup table PDFs, include PDF value for each hit in likelihood. If false, the truncated mean of dedx values will be used.",
           true);
  addParam("ignoreMissingParticles", m_ignoreMissingParticles,
           "Ignore particles for which no PDFs are found", false);
  addParam("trackLevel", m_trackLevel,
           "ONLY USEFUL FOR MC: Use track-level MC. If false, use hit-level MC", true);
  addParam("onlyPrimaryParticles", m_onlyPrimaryParticles,
           "ONLY USEFUL FOR MC: Only save data for primary particles", false);
}

◆ ~CDCDedxPIDModule()

~CDCDedxPIDModule ( )

virtual

Destructor.

Definition at line 72 of file CDCDedxPIDModule.cc.

72{ }

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.

147{};

◆ calculateMeans()

void calculateMeans	(	double *	mean,
		double *	truncatedMean,
		double *	truncatedMeanErr,
		const std::vector< double > &	dedx
	)		const

private

Save arithmetic and truncated mean for the 'dedx' values.

Parameters

mean	calculated arithmetic mean
truncatedMean	calculated truncated mean
truncatedMeanErr	error for truncatedMean
dedx	input values

Definition at line 640 of file CDCDedxPIDModule.cc.

{
  // Calculate the truncated average by skipping the lowest & highest
  // events in the array of dE/dx values
  std::vector<double> sortedDedx = dedx;
  std::sort(sortedDedx.begin(), sortedDedx.end());
  sortedDedx.erase(std::remove(sortedDedx.begin(), sortedDedx.end(), 0), sortedDedx.end());
  sortedDedx.shrink_to_fit();
 
  double truncatedMeanTmp = 0.0;
  double meanTmp = 0.0;
  double sumOfSquares = 0.0;
  int numValuesTrunc = 0;
  const int numDedx = sortedDedx.size();
 
  // add a factor of 0.51 here to make sure we are rounding appropriately...
  const int lowEdgeTrunc = int(numDedx * m_removeLowest + 0.51);
  const int highEdgeTrunc = int(numDedx * (1 - m_removeHighest) + 0.51);
  for (int i = 0; i < numDedx; i++) {
    meanTmp += sortedDedx[i];
    if (i >= lowEdgeTrunc and i < highEdgeTrunc) {
      truncatedMeanTmp += sortedDedx[i];
      sumOfSquares += sortedDedx[i] * sortedDedx[i];
      numValuesTrunc++;
    }
  }
 
  if (numDedx != 0) {
    meanTmp /= numDedx;
  }
  if (numValuesTrunc != 0) {
    truncatedMeanTmp /= numValuesTrunc;
  } else {
    truncatedMeanTmp = meanTmp;
  }
 
  *mean = meanTmp;
  *truncatedMean = truncatedMeanTmp;
 
  if (numValuesTrunc > 1) {
    *truncatedMeanErr = sqrt(sumOfSquares / double(numValuesTrunc) - truncatedMeanTmp * truncatedMeanTmp) / double(
                          numValuesTrunc - 1);
  } else {
    *truncatedMeanErr = 0;
  }
}

◆ checkPDFs()

void checkPDFs ( )

private

Check the pdfs for consistency every time they change in the database.

Definition at line 74 of file CDCDedxPIDModule.cc.

{
  if (!m_DBDedxPDFs) B2FATAL("No Dedx pdfs found in database");
  //load dedx:momentum PDFs
  int nBinsX, nBinsY;
  double xMin, xMax, yMin, yMax;
  nBinsX = nBinsY = -1;
  xMin = xMax = yMin = yMax = 0.0;
  for (unsigned int iPart = 0; iPart < 6; iPart++) {
    const int pdgCode = Const::chargedStableSet.at(iPart).getPDGCode();
    const TH2F* pdf = m_DBDedxPDFs->getCDCPDF(iPart, !m_useIndividualHits);
 
    if (pdf->GetEntries() == 0) {
      if (m_ignoreMissingParticles)
        continue;
      B2FATAL("Couldn't find PDF for PDG " << pdgCode);
    }
 
    //check that PDFs have the same dimensions and same binning
    const double epsFactor = 1e-5;
    if (nBinsX == -1 and nBinsY == -1) {
      nBinsX = pdf->GetNbinsX();
      nBinsY = pdf->GetNbinsY();
      xMin = pdf->GetXaxis()->GetXmin();
      xMax = pdf->GetXaxis()->GetXmax();
      yMin = pdf->GetYaxis()->GetXmin();
      yMax = pdf->GetYaxis()->GetXmax();
    } else if (nBinsX != pdf->GetNbinsX()
               or nBinsY != pdf->GetNbinsY()
               or fabs(xMin - pdf->GetXaxis()->GetXmin()) > epsFactor * xMax
               or fabs(xMax - pdf->GetXaxis()->GetXmax()) > epsFactor * xMax
               or fabs(yMin - pdf->GetYaxis()->GetXmin()) > epsFactor * yMax
               or fabs(yMax - pdf->GetYaxis()->GetXmax()) > epsFactor * yMax) {
      B2FATAL("PDF for PDG " << pdgCode << " has binning/dimensions differing from previous PDF.");
    }
  }
}

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

◆ D2I()

double D2I	(	double	cosTheta,
		double	D
	)		const

private

hadron saturation parameterization part 2

Definition at line 724 of file CDCDedxPIDModule.cc.

{
  double absCosTheta   = fabs(cosTheta);
  double projection    = pow(absCosTheta, m_hadronpars[3]) + m_hadronpars[2];
  if (projection == 0) {
    B2WARNING("Something wrong with dE/dx hadron constants!");
    return D;
  }
 
  double chargeDensity = D / projection;
  double numerator     = 1 + m_hadronpars[0] * chargeDensity;
  double denominator   = 1 + m_hadronpars[1] * chargeDensity;
 
  if (denominator == 0) {
    B2WARNING("Something wrong with dE/dx hadron constants!");
    return D;
  }
 
  double I = D * m_hadronpars[4] * numerator / denominator;
  return I;
}

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

This method is called at the end of the event processing.

Definition: Module.h:176

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

166{};

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

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

◆ event()

void event ( void )

overridevirtual

This method is called for each event.

All processing of the event takes place in this method.

Reimplemented from Module.

Definition at line 171 of file CDCDedxPIDModule.cc.

{
  // go through Tracks
  // get fitresult and RecoTrack and do extrapolations, save corresponding dE/dx and likelihood values
  //   get hit indices through RecoTrack::getHitPointsWithMeasurement(...)
  //   create one CDCDedxTrack per fitresult/recoTrack
  // create one DedkLikelihood per Track (plus rel)
 
  // inputs
  const int numMCParticles = m_mcparticles.getEntries();
 
  // get the geometry of the cdc
  static CDCGeometryPar& cdcgeo = CDCGeometryPar::Instance();
 
  // **************************************************
  //
  //  LOOP OVER TRACKS
  //
  // **************************************************
 
  m_dedxTracks.clear();
  m_dedxLikelihoods.clear();
 
  int mtrack = 0;
  for (const auto& track : m_tracks) {
    std::shared_ptr<CDCDedxTrack> dedxTrack = std::make_shared<CDCDedxTrack>();
    dedxTrack->m_track = mtrack++;
 
    // load the pion fit hypothesis or the hypothesis which is the closest in mass to a pion
    // the tracking will not always successfully fit with a pion hypothesis
    const TrackFitResult* fitResult = track.getTrackFitResultWithClosestMass(Const::pion);
    if (!fitResult) {
      B2WARNING("No related fit for track ...");
      continue;
    }
 
    if ((m_enableDebugOutput or m_onlyPrimaryParticles) and numMCParticles != 0) {
      // find MCParticle corresponding to this track
      const MCParticle* mcpart = track.getRelatedTo<MCParticle>();
 
      if (mcpart) {
        if (m_onlyPrimaryParticles && !mcpart->hasStatus(MCParticle::c_PrimaryParticle)) {
          continue; //not a primary particle, ignore
        }
 
        //add some MC truths to CDCDedxTrack object
        dedxTrack->m_pdg = mcpart->getPDG();
        dedxTrack->m_mcmass = mcpart->getMass();
        const MCParticle* mother = mcpart->getMother();
        dedxTrack->m_motherPDG = mother ? mother->getPDG() : 0;
 
        const ROOT::Math::XYZVector trueMomentum = mcpart->getMomentum();
        dedxTrack->m_pTrue = trueMomentum.R();
        dedxTrack->m_cosThetaTrue = cos(trueMomentum.Theta());
      }
    } else {
      dedxTrack->m_pdg = -999;
    }
 
    // get momentum (at origin) from fit result
    const ROOT::Math::XYZVector& trackMom = fitResult->getMomentum();
    dedxTrack->m_p = trackMom.R();
    bool nomom = (dedxTrack->m_p != dedxTrack->m_p);
    double costh = std::cos(std::atan(1 / fitResult->getCotTheta()));
    int charge = 1;
    if (!nomom) {
      costh = cos(trackMom.Theta());
      charge = fitResult->getChargeSign();
    }
    dedxTrack->m_cosTheta = costh;
    dedxTrack->m_charge = charge;
 
    double injring = -1.0, injtime = -1.0;
    StoreObjPtr<EventLevelTriggerTimeInfo> m_TTDInfo;
    if (m_TTDInfo.isValid() && m_TTDInfo->hasInjection()) {
      injring = m_TTDInfo->isHER();
      injtime =  m_TTDInfo->getTimeSinceLastInjectionInMicroSeconds();
    }
    dedxTrack->m_injring = injring;
    dedxTrack->m_injtime = injtime;
 
    // dE/dx values will be calculated using associated RecoTrack
    const RecoTrack* recoTrack = track.getRelatedTo<RecoTrack>();
    if (!recoTrack) {
      B2WARNING("No related track for this fit...");
      continue;
    }
 
    // Check to see if the track is pruned
    if (recoTrack->getTrackFitStatus()->isTrackPruned()) {
      B2ERROR("GFTrack is pruned, please run CDCDedxPID only on unpruned tracks! Skipping this track.");
      continue;
    }
 
    // scale factor to make electron dE/dx ~ 1
    dedxTrack->m_scale = (m_DBScaleFactor) ? m_DBScaleFactor->getScaleFactor() : 1.0;
 
    // store run gains only for data!
    bool isData = false;
    if (m_usePrediction && numMCParticles == 0)isData = true;
    dedxTrack->m_runGain = (m_DBRunGain && isData) ? m_DBRunGain->getRunGain() : 1.0;
 
    // get the cosine correction only for data!
    dedxTrack->m_cosCor = (m_DBCosineCor && isData) ? m_DBCosineCor->getMean(costh) : 1.0;
 
    // get the cosine edge correction only for data!
    bool isEdge = false;
    if ((abs(costh + 0.860) < 0.010) || (abs(costh - 0.955) <= 0.005))isEdge = true;
    dedxTrack->m_cosEdgeCor = (m_DBCosEdgeCor && isData && isEdge) ? m_DBCosEdgeCor->getMean(costh) : 1.0;
 
    bool isvalidTime = true;
    if (injtime < 0 || injring < 0)isvalidTime = false;
    dedxTrack->m_timeGain = (m_DBInjectTime && isData && isvalidTime) ? m_DBInjectTime->getCorrection("mean", injring, injtime) : 1.0;
    dedxTrack->m_timeReso = (m_DBInjectTime && isData && isvalidTime) ? m_DBInjectTime->getCorrection("reso", injring, injtime) : 1.0;
 
    // initialize a few variables to be used in the loop over track points
    double layerdE = 0.0; // total charge in current layer
    double layerdx = 0.0; // total path length in current layer
    double cdcMom = 0.0; // momentum valid in the CDC
    int nhitscombined = 0; // number of hits combined per layer
    int wirelongesthit = 0; // wire number of longest hit
    double longesthit = 0; // path length of longest hit
 
    // loop over all CDC hits from this track
    // Get the TrackPoints, which contain the hit information we need.
    // Then iterate over each point.
    const std::vector< genfit::AbsTrackRep* >& gftrackRepresentations = recoTrack->getRepresentations();
    const std::vector< genfit::TrackPoint* >& gftrackPoints = recoTrack->getHitPointsWithMeasurement();
    for (std::vector< genfit::TrackPoint* >::const_iterator tp = gftrackPoints.begin();
         tp != gftrackPoints.end(); ++tp) {
 
      // should also be possible to use this for svd and pxd hits...
      genfit::AbsMeasurement* aAbsMeasurementPtr = (*tp)->getRawMeasurement(0);
      const CDCRecoHit* cdcRecoHit = dynamic_cast<const CDCRecoHit* >(aAbsMeasurementPtr);
      if (!cdcRecoHit) continue;
      const CDCHit* cdcHit = cdcRecoHit->getCDCHit();
      if (!cdcHit) continue;
 
      // get the poca on the wire and track momentum for this hit
      // make sure the fitter info exists
      const genfit::AbsFitterInfo* fi = (*tp)->getFitterInfo();
      if (!fi) {
        B2DEBUG(29, "No fitter info, skipping...");
        continue;
      }
 
      // get the wire ID (not between 0 and 14336) and the layer info
      WireID wireID = cdcRecoHit->getWireID();
      const int wire = wireID.getIWire(); // use getEWire() for encoded wire number
      int layer = cdcHit->getILayer(); // layer within superlayer
      int superlayer = cdcHit->getISuperLayer();
 
      // check which algorithm found this hit
      int foundByTrackFinder = 0;
      const RecoHitInformation* hitInfo = recoTrack->getRecoHitInformation(cdcHit);
      foundByTrackFinder = hitInfo->getFoundByTrackFinder();
 
      // add weights for hypotheses
      double weightPionHypo = 0;
      double weightProtHypo = 0;
      double weightKaonHypo = 0;
      // loop over all the present hypotheses
      for (std::vector<genfit::AbsTrackRep* >::const_iterator trep = gftrackRepresentations.begin();
           trep != gftrackRepresentations.end(); ++trep) {
        const int pdgCode = TMath::Abs((*trep)->getPDG());
        // configured to only save weights for one of these 3
        if (!(pdgCode == Const::pion.getPDGCode() ||
              pdgCode == Const::kaon.getPDGCode() ||
              pdgCode == Const::proton.getPDGCode())) continue;
        const genfit::KalmanFitterInfo* kalmanFitterInfo = (*tp)->getKalmanFitterInfo(*trep);
        if (kalmanFitterInfo == NULL) {
          //B2WARNING("No KalmanFitterInfo for hit in "<<pdgCode<<" track representationt. Skipping.");
          continue;
        }
 
        // there are always 2 hits, one of which is ~1, the other ~0; or both ~0. Store only the largest.
        std::vector<double> weights = kalmanFitterInfo->getWeights();
        const double maxWeight = weights[0] > weights[1] ? weights[0] : weights[1];
        if (pdgCode == Const::pion.getPDGCode()) weightPionHypo = maxWeight;
        else if (pdgCode == Const::kaon.getPDGCode()) weightKaonHypo = maxWeight;
        else if (pdgCode == Const::proton.getPDGCode()) weightProtHypo = maxWeight;
 
      }
 
      // continuous layer number
      int currentLayer = (superlayer == 0) ? layer : (8 + (superlayer - 1) * 6 + layer);
      int nextLayer = currentLayer;
 
      // dense packed wire number (between 0 and 14336)
      const int iwire = (superlayer == 0) ? 160 * layer + wire : m_nLayerWires[superlayer - 1] + (160 + 32 *
                        (superlayer - 1)) * layer + wire;
 
      // if multiple hits in a layer, we may combine the hits
      const bool lastHit = (tp + 1 == gftrackPoints.end());
      bool lastHitInCurrentLayer = lastHit;
      if (!lastHit) {
        // peek at next hit
        genfit::AbsMeasurement* aAbsMeasurementPtrNext = (*(tp + 1))->getRawMeasurement(0);
        const CDCRecoHit* nextcdcRecoHit = dynamic_cast<const CDCRecoHit* >(aAbsMeasurementPtrNext);
        // if next hit fails, assume this is the last hit in the layer
        if (!nextcdcRecoHit || !(cdcRecoHit->getCDCHit()) || !((*(tp + 1))->getFitterInfo())) {
          break;
        }
        const CDCHit* nextcdcHit = nextcdcRecoHit->getCDCHit();
        const int nextILayer = nextcdcHit->getILayer();
        const int nextSuperlayer = nextcdcHit->getISuperLayer();
        nextLayer = (nextSuperlayer == 0) ? nextILayer : (8 + (nextSuperlayer - 1) * 6 + nextILayer);
        lastHitInCurrentLayer = (nextLayer != currentLayer);
      }
 
      // find the position of the endpoints of the sense wire
      const ROOT::Math::XYZVector& wirePosF = cdcgeo.wireForwardPosition(wireID, CDCGeometryPar::c_Aligned);
 
      int nWires = cdcgeo.nWiresInLayer(currentLayer);
 
      // radii of field wires for this layer
      double inner = cdcgeo.innerRadiusWireLayer()[currentLayer];
      double outer = cdcgeo.outerRadiusWireLayer()[currentLayer];
 
      double topHeight = outer - wirePosF.Rho();
      double bottomHeight = wirePosF.Rho() - inner;
      double cellHeight = topHeight + bottomHeight;
      double topHalfWidth = M_PI * outer / nWires;
      double bottomHalfWidth = M_PI * inner / nWires;
      double cellHalfWidth = M_PI * wirePosF.Rho() / nWires;
 
      // first construct the boundary lines, then create the cell
      const DedxPoint tl = DedxPoint(-topHalfWidth, topHeight);
      const DedxPoint tr = DedxPoint(topHalfWidth, topHeight);
      const DedxPoint br = DedxPoint(bottomHalfWidth, -bottomHeight);
      const DedxPoint bl = DedxPoint(-bottomHalfWidth, -bottomHeight);
      DedxDriftCell c = DedxDriftCell(tl, tr, br, bl);
 
      // make sure the MOP is reasonable (an exception is thrown for bad numerics)
      try {
        const genfit::MeasuredStateOnPlane& mop = fi->getFittedState();
 
        // use the MOP to determine the DOCA and entrance angle
        B2Vector3D fittedPoca = mop.getPos();
        const TVector3& pocaMom = mop.getMom();
        if (tp == gftrackPoints.begin() || cdcMom == 0) {
          cdcMom = pocaMom.Mag();
          dedxTrack->m_pCDC = cdcMom;
        }
        if (nomom)
          dedxTrack->m_p = cdcMom;
 
        // get the doca and entrance angle information.
        // constructPlane places the coordinate center in the POCA to the
        // wire.  Using this is the default behavior.  If this should be too
        // slow, as it has to re-evaluate the POCA
        //  B2Vector3D pocaOnWire = cdcRecoHit->constructPlane(mop)->getO();
 
        // uses the plane determined by the track fit.
        B2Vector3D pocaOnWire = mop.getPlane()->getO(); // DOUBLE CHECK THIS --\/
 
        // The vector from the wire to the track.
        B2Vector3D B2WireDoca = fittedPoca - pocaOnWire;
 
        // the sign of the doca is defined here to be positive in the +x dir in the cell
        double doca = B2WireDoca.Perp();
        double phidiff = fittedPoca.Phi() - pocaOnWire.Phi();
        // be careful about "wrap around" cases when the poca and wire are close, but
        // the difference in phi is largy
        if (phidiff > -3.1416 && (phidiff < 0 || phidiff > 3.1416)) doca *= -1;
 
        // The opening angle of the track momentum direction
        const double px = pocaMom.X();
        const double py = pocaMom.Y();
        const double wx = pocaOnWire.X();
        const double wy = pocaOnWire.Y();
        const double cross = wx * py - wy * px;
        const double dot   = wx * px + wy * py;
        double entAng = atan2(cross, dot);
 
        // re-scaled (RS) doca and entAng variable: map to square cell
        double cellR = 2 * cellHalfWidth / cellHeight;
        double tana = 100.0;
        if (std::abs(2 * atan(1) - std::abs(entAng)) < 0.01)tana = 100 * (entAng / std::abs(entAng)); //avoid infinity at pi/2
        else tana =  std::tan(entAng);
        double docaRS = doca * std::sqrt((1 + cellR * cellR * tana * tana) / (1 + tana * tana));
        double entAngRS = std::atan(tana / cellR);
 
        LinearGlobalADCCountTranslator translator;
        int adcbaseCount = cdcHit->getADCCount(); // pedestal subtracted?
        int adcCount = (m_DBNonlADC && m_usePrediction
                        && numMCParticles == 0) ? m_DBNonlADC->getCorrectedADC(adcbaseCount, currentLayer) : adcbaseCount;
 
        double hitCharge = translator.getCharge(adcCount, wireID, false, pocaOnWire.Z(), pocaMom.Phi());
        int driftT = cdcHit->getTDCCount();
 
        // we want electrons to be one, so artificially scale the adcCount
        double dadcCount = 1.0 * adcCount;
        if (dedxTrack->m_scale != 0) dadcCount /= dedxTrack->m_scale;
 
        RealisticTDCCountTranslator realistictdc;
        double driftDRealistic = realistictdc.getDriftLength(driftT, wireID, 0, true, pocaOnWire.Z(), pocaMom.Phi(), pocaMom.Theta());
        double driftDRealisticRes = realistictdc.getDriftLengthResolution(driftDRealistic, wireID, true, pocaOnWire.Z(), pocaMom.Phi(),
                                    pocaMom.Theta());
 
        // now calculate the path length for this hit
        double celldx = c.dx(doca, entAng);
        if (c.isValid()) {
          // get the wire gain constant
          double wiregain = (m_DBWireGains && m_usePrediction && numMCParticles == 0) ? m_DBWireGains->getWireGain(iwire) : 1.0;
 
          //normalization of rescaled doca wrt cell size for layer dependent 2D corrections
          double normDocaRS = docaRS / cellHalfWidth;
          double twodcor = (m_DB2DCell && m_usePrediction
                            && numMCParticles == 0) ? m_DB2DCell->getMean(currentLayer, normDocaRS, entAngRS) : 1.0;
 
          // get the 1D cleanup correction
          double onedcor = (m_DB1DCell && m_usePrediction && numMCParticles == 0) ? m_DB1DCell->getMean(currentLayer, entAngRS) : 1.0;
 
          // apply the calibration to dE to propagate to both hit and layer measurements
          // Note: could move the sin(theta) here since it is common accross the track
          //       It is applied in two places below (hit level and layer level)
          double correction = dedxTrack->m_runGain * dedxTrack->m_cosCor * dedxTrack->m_cosEdgeCor * dedxTrack->m_timeGain * wiregain *
                              twodcor * onedcor;
 
          // --------------------
          // save individual hits (even for dead wires)
          // --------------------
          if (correction != 0) dadcCount = dadcCount / correction;
          else dadcCount = 0;
 
          double cellDedx = (dadcCount / celldx);
 
          // correct for path length through the cell
          if (nomom) cellDedx *= std::sin(std::atan(1 / fitResult->getCotTheta()));
          else cellDedx *= std::sin(trackMom.Theta());
 
          if (m_enableDebugOutput)
            dedxTrack->addHit(wire, iwire, currentLayer, doca, docaRS, entAng, entAngRS,
                              adcCount, adcbaseCount, hitCharge, celldx, cellDedx, cellHeight, cellHalfWidth, driftT,
                              driftDRealistic, driftDRealisticRes, wiregain, twodcor, onedcor,
                              foundByTrackFinder, weightPionHypo, weightKaonHypo, weightProtHypo);
 
          // --------------------
          // save layer hits only with active wires
          // --------------------
          if (correction != 0) {
 
            layerdE += dadcCount;
            layerdx += celldx;
 
            if (celldx > longesthit) {
              longesthit = celldx;
              wirelongesthit = iwire;
            }
            nhitscombined++;
          }
        }
      } catch (genfit::Exception&) {
        B2WARNING("Track: " << mtrack << ": genfit::MeasuredStateOnPlane exception...");
        continue;
      }
 
      // check if there are any more hits in this layer
      if (lastHitInCurrentLayer) {
        if (layerdx > 0) {
          double totalDistance;
          if (nomom) totalDistance = layerdx / std::sin(std::atan(1 / fitResult->getCotTheta()));
          else  totalDistance = layerdx / std::sin(trackMom.Theta());
          double layerDedx = layerdE / totalDistance;
 
          // save the information for this layer
          if (layerDedx > 0) {
            dedxTrack->addDedx(nhitscombined, wirelongesthit, currentLayer, totalDistance, layerDedx);
            // save the PID information if using individual hits
            if (m_useIndividualHits) {
              // use the momentum valid in the cdc
              saveLookupLogl(dedxTrack->m_cdcLogl, dedxTrack->m_pCDC, layerDedx);
            }
          }
        }
        // stop when the track starts to curl
        if (!m_backHalfCurlers && nextLayer < currentLayer) break;
 
        layerdE = 0;
        layerdx = 0;
        nhitscombined = 0;
        wirelongesthit = 0;
        longesthit = 0;
      }
    } // end of loop over CDC hits for this track
 
    // Determine the number of hits to be used
    //m_lDedx is a ector for layerDedx and created w/ ->adddedx method above
    if (dedxTrack->m_lDedx.empty()) {
      B2DEBUG(29, "Found track with no hits, ignoring.");
      continue;
    } else {
      // determine the number of hits for this track (used below)
      const int numDedx = dedxTrack->m_lDedx.size();
      // add a factor of 0.51 here to make sure we are rounding appropriately...
      const int lowEdgeTrunc = int(numDedx * m_removeLowest + 0.51);
      const int highEdgeTrunc = int(numDedx * (1 - m_removeHighest) + 0.51);
      dedxTrack->m_lNHitsUsed = highEdgeTrunc - lowEdgeTrunc;
    }
 
    // Get the truncated mean
    //
    // If using track-level MC, get the predicted mean and resolution and throw a random
    // number to get the simulated dE/dx truncated mean. Otherwise, calculate the truncated
    // mean from the simulated hits (hit-level MC).
    if (!m_useIndividualHits or m_enableDebugOutput) {
      calculateMeans(&(dedxTrack->m_dedxAvg),
                     &(dedxTrack->m_dedxAvgTruncatedNoSat),
                     &(dedxTrack->m_dedxAvgTruncatedErr),
                     dedxTrack->m_lDedx);
 
      // apply the "hadron correction" only to data
      if (numMCParticles == 0)
        dedxTrack->m_dedxAvgTruncated = D2I(costh, I2D(costh, 1.00) / 1.00 * dedxTrack->m_dedxAvgTruncatedNoSat);
      else dedxTrack->m_dedxAvgTruncated = dedxTrack->m_dedxAvgTruncatedNoSat;
    }
 
    // If this is a MC track, get the track-level dE/dx
    if (numMCParticles != 0 && dedxTrack->m_mcmass > 0 && dedxTrack->m_pTrue != 0) {
      // determine the predicted mean and resolution
      double mean = getMean(dedxTrack->m_pCDC / dedxTrack->m_mcmass);
      double sigma = getSigma(mean, dedxTrack->m_lNHitsUsed,
                              dedxTrack->m_cosTheta, dedxTrack->m_timeReso);
      dedxTrack->m_simDedx = gRandom->Gaus(mean, sigma);
      while (dedxTrack->m_simDedx < 0)
        dedxTrack->m_simDedx = gRandom->Gaus(mean, sigma);
      if (m_trackLevel)
        dedxTrack->m_dedxAvgTruncated = dedxTrack->m_simDedx;
    }
 
    // save the PID information for both lookup tables and parameterized means and resolutions
    saveChiValue(dedxTrack->m_cdcChi, dedxTrack->m_predmean, dedxTrack->m_predres, dedxTrack->m_pCDC, dedxTrack->m_dedxAvgTruncated,
                 dedxTrack->m_cosTheta, dedxTrack->m_lNHitsUsed, dedxTrack->m_timeReso);
    if (!m_useIndividualHits)
      saveLookupLogl(dedxTrack->m_cdcLogl, dedxTrack->m_pCDC, dedxTrack->m_dedxAvgTruncated);
 
    // save CDCDedxLikelihood
    // use parameterized method if called or if pdf file for lookup tables are empty
    double pidvalues[Const::ChargedStable::c_SetSize];
    Const::ParticleSet set = Const::chargedStableSet;
    if (m_usePrediction) {
      for (const Const::ChargedStable pdgIter : set) {
        pidvalues[pdgIter.getIndex()] = -0.5 * dedxTrack->m_cdcChi[pdgIter.getIndex()] * dedxTrack->m_cdcChi[pdgIter.getIndex()];
      }
    } else {
      for (const Const::ChargedStable pdgIter : set) {
        pidvalues[pdgIter.getIndex()] = dedxTrack->m_cdcLogl[pdgIter.getIndex()];
      }
    }
 
    CDCDedxLikelihood* likelihoodObj = m_dedxLikelihoods.appendNew(pidvalues);
    track.addRelationTo(likelihoodObj);
 
    if (m_enableDebugOutput) {
      // book the information for this track
      CDCDedxTrack* newCDCDedxTrack = m_dedxTracks.appendNew(*dedxTrack);
      track.addRelationTo(newCDCDedxTrack);
    }
 
  } // end of loop over tracks
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getMean()

double getMean ( double bg ) const

private

calculate the predicted mean using the parameterized resolution

Definition at line 803 of file CDCDedxPIDModule.cc.

{
  // define the section of the mean to use
  double A = 0, B = 0, C = 0;
  if (bg < 4.5)
    A = 1;
  else if (bg < 10)
    B = 1;
  else
    C = 1;
 
  double x[1]; x[0] = bg;
  double parsA[9];
  double parsB[5];
  double parsC[5];
 
  parsA[0] = 1; parsB[0] = 2; parsC[0] = 3;
  for (int i = 0; i < 15; ++i) {
    if (i < 7) parsA[i + 1] = m_meanpars[i];
    else if (i < 11) parsB[i % 7 + 1] = m_meanpars[i];
    else parsC[i % 11 + 1] = m_meanpars[i];
  }
 
  // calculate dE/dx from the Bethe-Bloch mean
  double partA = meanCurve(x, parsA, 0);
  double partB = meanCurve(x, parsB, 0);
  double partC = meanCurve(x, parsC, 0);
 
  return (A * partA + B * partB + C * partC);
}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getSigma()

double getSigma	(	double	dedx,
		double	nhit,
		double	cos,
		double	timereso
	)		const

private

calculate the predicted resolution using the parameterized resolution

Definition at line 857 of file CDCDedxPIDModule.cc.

{
 
  double x[1];
  double dedxpar[3];
  double nhitpar[6];
  double cospar[11];
 
  dedxpar[0] = 1; nhitpar[0] = 2; cospar[0] = 3;
  for (int i = 0; i < 10; ++i) {
    if (i < 2) dedxpar[i + 1] = m_sigmapars[i];
    if (i < 5) nhitpar[i + 1] = m_sigmapars[i + 2];
    cospar[i + 1] = m_sigmapars[i + 7];
  }
 
  // determine sigma from the parameterization
  x[0] = dedx;
  double corDedx = sigmaCurve(x, dedxpar, 0);
 
  x[0] = nhit;
  double corNHit;
  int nhit_min = 8, nhit_max = 37;
 
  if (nhit <  nhit_min) {
    x[0] = nhit_min;
    corNHit = sigmaCurve(x, nhitpar, 0) * sqrt(nhit_min / nhit);
  } else if (nhit > nhit_max) {
    x[0] = nhit_max;
    corNHit = sigmaCurve(x, nhitpar, 0) * sqrt(nhit_max / nhit);
  } else corNHit = sigmaCurve(x, nhitpar, 0);
 
  x[0] = cos;
  double corCos = sigmaCurve(x, cospar, 0);
 
  return (corDedx * corCos * corNHit * timereso);
}

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

◆ I2D()

double I2D	(	double	cosTheta,
		double	I
	)		const

private

hadron saturation parameterization part 1

Definition at line 746 of file CDCDedxPIDModule.cc.

{
  double absCosTheta = fabs(cosTheta);
  double projection  = pow(absCosTheta, m_hadronpars[3]) + m_hadronpars[2];
 
  if (projection == 0 || m_hadronpars[4] == 0) {
    B2WARNING("Something wrong with dE/dx hadron constants!");
    return I;
  }
 
  double a =  m_hadronpars[0] / projection;
  double b =  1 - m_hadronpars[1] / projection * (I / m_hadronpars[4]);
  double c = -1.0 * I / m_hadronpars[4];
 
  if (b == 0 && a == 0) {
    B2WARNING("both a and b coefficiants for hadron correction are 0");
    return I;
  }
 
  double discr = b * b - 4.0 * a * c;
  if (discr < 0) {
    B2WARNING("negative discriminant; return uncorrectecd value");
    return I;
  }
 
  double D = (a != 0) ? (-b + sqrt(discr)) / (2.0 * a) : -c / b;
  if (D < 0) {
    B2WARNING("D is less 0! will try another solution");
    D = (a != 0) ? (-b - sqrt(discr)) / (2.0 * a) : -c / b;
    if (D < 0) {
      B2WARNING("D is still less 0! just return uncorrectecd value");
      return I;
    }
  }
 
  return D;
}

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )

overridevirtual

Initialize the module.

Reimplemented from Module.

Definition at line 112 of file CDCDedxPIDModule.cc.

{
 
  // required inputs
  m_tracks.isRequired();
  m_recoTracks.isRequired();
 
  // optional inputs
  m_mcparticles.isOptional();
  m_tracks.optionalRelationTo(m_mcparticles);
 
  // register optional outputs
  if (m_enableDebugOutput) {
    m_dedxTracks.registerInDataStore();
    m_tracks.registerRelationTo(m_dedxTracks);
  }
 
  // register outputs
  m_dedxLikelihoods.registerInDataStore();
  m_tracks.registerRelationTo(m_dedxLikelihoods);
 
  m_DBDedxPDFs.addCallback([this]() { checkPDFs(); });
  checkPDFs();
 
  // lookup table for number of wires per layer (indexed on superlayer)
  m_nLayerWires[0] = 1280;
  for (int i = 1; i < 9; ++i) {
    m_nLayerWires[i] = m_nLayerWires[i - 1] + 6 * (160 + (i - 1) * 32);
  }
 
  // make sure the mean and resolution parameters are reasonable
  if (!m_DBMeanPars || m_DBMeanPars->getSize() == 0) {
    B2WARNING("No dE/dx mean parameters!");
    for (int i = 0; i < 15; ++i)
      m_meanpars.push_back(1.0);
  } else m_meanpars = m_DBMeanPars->getMeanPars();
 
  if (!m_DBSigmaPars || m_DBSigmaPars->getSize() == 0) {
    B2WARNING("No dE/dx sigma parameters!");
    for (int i = 0; i < 12; ++i)
      m_sigmapars.push_back(1.0);
  } else m_sigmapars = m_DBSigmaPars->getSigmaPars();
 
  // get the hadron correction parameters
  if (!m_DBHadronCor || m_DBHadronCor->getSize() == 0) {
    B2WARNING("No hadron correction parameters!");
    for (int i = 0; i < 4; ++i)
      m_hadronpars.push_back(0.0);
    m_hadronpars.push_back(1.0);
  } else m_hadronpars = m_DBHadronCor->getHadronPars();
 
  // create instances here to not confuse profiling
  CDCGeometryPar::Instance();
 
  if (!genfit::MaterialEffects::getInstance()->isInitialized()) {
    B2FATAL("Need to have SetupGenfitExtrapolationModule in path before this one.");
  }
}

◆ meanCurve()

double meanCurve	(	double *	x,
		double *	par,
		int	version
	)		const

private

parameterized beta-gamma curve for predicted means

Definition at line 784 of file CDCDedxPIDModule.cc.

{
  // calculate the predicted mean value as a function of beta-gamma (bg)
  // this is done with a different function depending on the value of bg
  double f = 0;
 
  if (version == 0) {
    if (par[0] == 1)
      f = par[1] * std::pow(std::sqrt(x[0] * x[0] + 1), par[3]) / std::pow(x[0], par[3]) *
          (par[2] - par[5] * std::log(1 / x[0])) - par[4] + std::exp(par[6] + par[7] * x[0]);
    else if (par[0] == 2)
      f = par[1] * std::pow(x[0], 3) + par[2] * x[0] * x[0] + par[3] * x[0] + par[4];
    else if (par[0] == 3)
      f = -1.0 * par[1] * std::log(par[4] + std::pow(1 / x[0], par[2])) + par[3];
  }
 
  return f;
}

◆ saveChiValue()

void saveChiValue	(	double(&)	chi[Const::ChargedStable::c_SetSize],
		double(&)	predmean[Const::ChargedStable::c_SetSize],
		double(&)	predres[Const::ChargedStable::c_SetSize],
		double	p,
		double	dedx,
		double	cos,
		int	nhit,
		double	timereso
	)		const

private

for all particles, save chi values into 'chi'.

Parameters

chi	array of chi values to be modified
predmean	predicted mean for each hypothesis
predres	predicted resolution for each hypothesis
p	track momentum valid in the cdc
dedx	dE/dx value
cos	track cos(theta)
nhit	number of hits used for this track
timereso	time resolution from database

Definition at line 894 of file CDCDedxPIDModule.cc.

{
  // determine a chi value for each particle type
  Const::ParticleSet set = Const::chargedStableSet;
  for (const Const::ChargedStable pdgIter : set) {
    double bg = p / pdgIter.getMass();
 
    // determine the predicted mean and resolution
    double mean = getMean(bg);
    double sigma = getSigma(mean, nhit, cos, timereso);
 
    predmean[pdgIter.getIndex()] = mean;
    predsigma[pdgIter.getIndex()] = sigma;
 
    // fill the chi value for this particle type
    if (sigma != 0) chi[pdgIter.getIndex()] = ((dedx - mean) / (sigma));
  }
}

◆ saveLookupLogl()

void saveLookupLogl	(	double(&)	logl[Const::ChargedStable::c_SetSize],
		double	p,
		double	dedx
	)

private

for all particles, save log-likelihood values into 'logl'.

Parameters

logl	array of log-likelihood to be modified
p	track momentum
dedx	dE/dx value

Definition at line 688 of file CDCDedxPIDModule.cc.

{
  //all pdfs have the same dimensions
  const TH2F* pdf = m_DBDedxPDFs->getCDCPDF(0, !m_useIndividualHits);
  const Int_t binX = pdf->GetXaxis()->FindFixBin(p);
  const Int_t binY = pdf->GetYaxis()->FindFixBin(dedx);
 
  for (unsigned int iPart = 0; iPart < Const::ChargedStable::c_SetSize; iPart++) {
    pdf = m_DBDedxPDFs->getCDCPDF(iPart, !m_useIndividualHits);
    if (pdf->GetEntries() == 0) { //might be NULL if m_ignoreMissingParticles is set
      B2WARNING("NO CDC PDFS...");
      continue;
    }
    double probability = 0.0;
 
    //check if this is still in the histogram, take overflow bin otherwise
    if (binX < 1 or binX > pdf->GetNbinsX()
        or binY < 1 or binY > pdf->GetNbinsY()) {
      probability = pdf->GetBinContent(binX, binY);
    } else {
      //in normal histogram range. Of course ROOT has a bug that Interpolate()
      //is not declared as const but it does not modify the internal state so
      //fine, const_cast it is.
      probability = const_cast<TH2F*>(pdf)->Interpolate(p, dedx);
    }
 
    if (probability != probability)
      B2ERROR("probability NAN for a track with p=" << p << " and dedx=" << dedx);
 
    //my pdfs aren't perfect...
    if (probability == 0.0)
      probability = m_useIndividualHits ? (1e-5) : (1e-3); //likelihoods for truncated mean are much higher
    logl[iPart] += log(probability);
  }
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

{
  if (!m_type.empty())
    B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
  m_type = type;
}

◆ sigmaCurve()

double sigmaCurve	(	double *	x,
		const double *	par,
		int	version
	)		const

private

parameterized resolution for predictions

Definition at line 834 of file CDCDedxPIDModule.cc.

{
  // calculate the predicted mean value as a function of beta-gamma (bg)
  // this is done with a different function depending dE/dx, nhit, and sin(theta)
  double f = 0;
 
  if (version == 0) {
    if (par[0] == 1) { // return dedx parameterization
      f = par[1] + par[2] * x[0];
    } else if (par[0] == 2) { // return nhit or sin(theta) parameterization
      f = par[1] * std::pow(x[0], 4) + par[2] * std::pow(x[0], 3) +
          par[3] * x[0] * x[0] + par[4] * x[0] + par[5];
    } else if (par[0] == 3) { // return cos(theta) parameterization
      f = par[1] * exp(-0.5 * pow(((x[0] - par[2]) / par[3]), 2)) +
          par[4] * pow(x[0], 6) + par[5] * pow(x[0], 5) + par[6] * pow(x[0], 4) +
          par[7] * pow(x[0], 3) + par[8] * x[0] * x[0] + par[9] * x[0] + par[10];
    }
  }
 
  return f;
}

◆ terminate()

void terminate ( void )

overridevirtual

End of the event processing.

Reimplemented from Module.

Definition at line 634 of file CDCDedxPIDModule.cc.

{
 
  B2DEBUG(29, "CDCDedxPIDModule exiting");
}

Member Data Documentation

◆ m_backHalfCurlers

bool m_backHalfCurlers

private

Whether to use the back half of curlers.

Definition at line 164 of file CDCDedxPIDModule.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_DB1DCell

DBObjPtr<CDCDedx1DCell> m_DB1DCell

private

1D correction DB object

Definition at line 180 of file CDCDedxPIDModule.h.

◆ m_DB2DCell

DBObjPtr<CDCDedx2DCell> m_DB2DCell

private

2D correction DB object

Definition at line 179 of file CDCDedxPIDModule.h.

◆ m_DBCosEdgeCor

DBObjPtr<CDCDedxCosineEdge> m_DBCosEdgeCor

private

non-linearly ACD correction DB object

Definition at line 177 of file CDCDedxPIDModule.h.

◆ m_DBCosineCor

DBObjPtr<CDCDedxCosineCor> m_DBCosineCor

private

Electron saturation correction DB object.

Definition at line 176 of file CDCDedxPIDModule.h.

◆ m_DBDedxPDFs

DBObjPtr<CDCdEdxPDFs> m_DBDedxPDFs

private

DB object for dedx:momentum PDFs.

Definition at line 158 of file CDCDedxPIDModule.h.

◆ m_DBHadronCor

DBObjPtr<CDCDedxHadronCor> m_DBHadronCor

private

hadron saturation parameters

Definition at line 182 of file CDCDedxPIDModule.h.

◆ m_DBInjectTime

DBObjPtr<CDCDedxInjectionTime> m_DBInjectTime

private

time gain/reso DB object

Definition at line 175 of file CDCDedxPIDModule.h.

◆ m_DBMeanPars

DBObjPtr<CDCDedxMeanPars> m_DBMeanPars

private

dE/dx mean parameters

Definition at line 189 of file CDCDedxPIDModule.h.

◆ m_DBNonlADC

DBObjPtr<CDCDedxADCNonLinearity> m_DBNonlADC

private

non-linearly ACD correction DB object

Definition at line 181 of file CDCDedxPIDModule.h.

◆ m_DBRunGain

DBObjPtr<CDCDedxRunGain> m_DBRunGain

private

Run gain DB object.

Definition at line 174 of file CDCDedxPIDModule.h.

◆ m_DBScaleFactor

DBObjPtr<CDCDedxScaleFactor> m_DBScaleFactor

private

Scale factor to make electrons ~1.

Definition at line 173 of file CDCDedxPIDModule.h.

◆ m_DBSigmaPars

DBObjPtr<CDCDedxSigmaPars> m_DBSigmaPars

private

dE/dx resolution parameters

Definition at line 190 of file CDCDedxPIDModule.h.

◆ m_DBWireGains

DBObjPtr<CDCDedxWireGain> m_DBWireGains

private

Wire gain DB object.

Definition at line 178 of file CDCDedxPIDModule.h.

◆ m_dedxLikelihoods

StoreArray<CDCDedxLikelihood> m_dedxLikelihoods

private

Output array of CDCDedxLikelihoods.

Definition at line 91 of file CDCDedxPIDModule.h.

◆ m_dedxTracks

StoreArray<CDCDedxTrack> m_dedxTracks

private

Output array of CDCDedxTracks.

Definition at line 90 of file CDCDedxPIDModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_enableDebugOutput

bool m_enableDebugOutput

private

Whether to save information on tracks and associated hits and dE/dx values in DedxTrack objects.

Definition at line 165 of file CDCDedxPIDModule.h.

◆ m_hadronpars

std::vector<double> m_hadronpars

private

hadron saturation parameters

Definition at line 184 of file CDCDedxPIDModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_ignoreMissingParticles

bool m_ignoreMissingParticles

private

Ignore particles for which no PDFs are found.

Definition at line 170 of file CDCDedxPIDModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_mcparticles

StoreArray<MCParticle> m_mcparticles

private

Optional array of input MCParticles.

Definition at line 98 of file CDCDedxPIDModule.h.

◆ m_meanpars

std::vector<double> m_meanpars

private

dE/dx mean parameters

Definition at line 154 of file CDCDedxPIDModule.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_nLayerWires

int m_nLayerWires[9] = {}

private

number of wires per layer: needed for wire gain calibration

Definition at line 186 of file CDCDedxPIDModule.h.

◆ m_onlyPrimaryParticles

bool m_onlyPrimaryParticles

private

Only save data for primary particles (as determined by MC truth)

Definition at line 169 of file CDCDedxPIDModule.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_recoTracks

StoreArray<RecoTrack> m_recoTracks

private

Required array of input RecoTracks.

Definition at line 95 of file CDCDedxPIDModule.h.

◆ m_removeHighest

double m_removeHighest

private

Portion of highest dE/dx values that should be discarded for truncated mean.

Definition at line 163 of file CDCDedxPIDModule.h.

◆ m_removeLowest

double m_removeLowest

private

Portion of lowest dE/dx values that should be discarded for truncated mean.

Definition at line 162 of file CDCDedxPIDModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_sigmapars

std::vector<double> m_sigmapars

private

dE/dx resolution parameters

Definition at line 155 of file CDCDedxPIDModule.h.

◆ m_trackLevel

bool m_trackLevel

private

Whether to use track-level or hit-level MC.

Definition at line 160 of file CDCDedxPIDModule.h.

◆ m_tracks

StoreArray<Track> m_tracks

private

Required array of input Tracks.

Definition at line 94 of file CDCDedxPIDModule.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_useIndividualHits

bool m_useIndividualHits

private

Include PDF value for each hit in likelihood.

If false, the truncated mean of dedx values for the detectors will be used.

Definition at line 167 of file CDCDedxPIDModule.h.

◆ m_usePrediction

bool m_usePrediction

private

Whether to use parameterized means and resolutions or lookup tables.

Definition at line 161 of file CDCDedxPIDModule.h.

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

reconstruction/modules/CDCDedxPID/include/CDCDedxPIDModule.h
reconstruction/modules/CDCDedxPID/src/CDCDedxPIDModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ CDCDedxPIDModule()

◆ ~CDCDedxPIDModule()

Member Function Documentation

◆ beginRun()

◆ calculateMeans()

◆ checkPDFs()

◆ clone()

◆ D2I()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getMean()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getSigma()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ I2D()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ meanCurve()

◆ saveChiValue()

◆ saveLookupLogl()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ sigmaCurve()

◆ terminate()

Member Data Documentation

◆ m_backHalfCurlers

◆ m_conditions

◆ m_DB1DCell

◆ m_DB2DCell