Belle II Software development
CDCCosmicAnalysisModule Class Reference

Analysis module for CDC CR data. More...

#include <CDCCosmicAnalysisModule.h>

Inheritance diagram for CDCCosmicAnalysisModule:
Module PathElement

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

 CDCCosmicAnalysisModule ()
 Constructor.
 
virtual ~CDCCosmicAnalysisModule ()
 Destructor.
 
void initialize () override
 Initializes the Module.
 
void beginRun () override
 Begin run action.
 
void event () override
 Event action (main routine).
 
void endRun () override
 End run action.
 
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.
 
LogConfiggetLogConfig ()
 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 ModuleConditiongetCondition () 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< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () 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

std::list< ModulePtrgetModules () 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

StoreObjPtr< EventMetaDatam_EventMetaData
 Event metadata.
 
StoreObjPtr< EventT0m_eventTimeStoreObject
 Event t0.
 
StoreArray< Trackm_Tracks
 Tracks.
 
StoreArray< RecoTrackm_RecoTracks
 Tracks.
 
StoreArray< TrackFitResultm_TrackFitResults
 Track fit results.
 
std::string m_trackArrayName
 Belle2::Track StoreArray name.
 
std::string m_recoTrackArrayName
 Belle2::RecoTrack StoreArray nam.e.
 
std::string m_trackFitResultArrayName
 Belle2::TrackFitResult StoreArray name.
 
std::string m_relRecoTrackTrackName
 Releation between RecoTrack and Belle2:Track.
 
std::string m_outputFileName
 Output file name.
 
std::string m_treeName
 output tree name.
 
TFile * tfile
 Output file.
 
TTree * tree
 output tree, save info of each hit.
 
int run
 Run number.
 
double ndf1
 degree of freedom of 1st track.
 
double ndf2
 degree of freedom of 2nd track.
 
double Pval1
 P-value of 1st track.
 
double Pval2
 P-value of 2nd track.
 
double D01
 D0 of 1st track.
 
double D02
 D0 of 2nd track.
 
double Phi01
 Phi0 of 1st track.
 
double Phi02
 Phi0 of 2nd track.
 
double Z01
 Z0 of 1st track.
 
double Z02
 Z0 of 2nd track.
 
double tanLambda1
 TanLambda of 1st track.
 
double tanLambda2
 Tanlambda of 2nd track.
 
double eD01
 error on D0 of 1st track.
 
double eD02
 error on D0 of 2nd track.
 
double eOm1
 error on Omega of 1st track.
 
double eOm2
 error on Omega of 2nd track.
 
double ePhi01
 error on Phi0 of 1st track.
 
double ePhi02
 error on Phi0 of 2nd track.
 
double eZ01
 error on Z0 of 1st track.
 
double eZ02
 error on Z0 of 2nd track.
 
double etanL1
 error on TanLambda of 1st track.
 
double etanL2
 error on TanLambda of 2nd track.
 
double Pt1
 Pt of 1st track.
 
double Pt2
 Pt of 2nd track.
 
TVector3 posSeed1
 seed position of the first track.
 
TVector3 posSeed2
 seed position of the second track.
 
TVector3 Mom1
 Momentum of 1st track.
 
TVector3 Mom2
 Momentum of 2nd track.
 
double Omega1
 omega of 1st track.
 
double Omega2
 omega of 2nd track.
 
double evtT0
 event t0.
 
short charge
 charge of track
 
bool m_bField
 Data are taken with B-field or not, if true, NDF=5 in cal P-value.
 
bool m_eventT0Extraction
 run with event t0 extraction
 
bool m_phi0InRad
 Unit of phi0, true: radian, false: degree.
 
bool m_storeTrackParErrors
 Store error of track parameters or not.
 
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< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

Analysis module for CDC CR data.

Definition at line 40 of file CDCCosmicAnalysisModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

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.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ CDCCosmicAnalysisModule()

Constructor.

Definition at line 33 of file CDCCosmicAnalysisModule.cc.

33 : Module()
34{
35 setDescription("Module for harvesting parameters of the two half (up/down) of a cosmic track for performance study");
36 setPropertyFlags(c_ParallelProcessingCertified); // specify this flag if you need parallel processing
37 addParam("RecoTracksColName", m_recoTrackArrayName, "Name of collectrion hold RecoTracks", std::string(""));
38 addParam("Output", m_outputFileName, "output file name", string("twotracks.root"));
39 addParam("EventT0Extraction", m_eventT0Extraction, "use event t0 extract t0 or not", true);
40 addParam("treeName", m_treeName, "Output tree name", string("tree"));
41 addParam("phi0InRad", m_phi0InRad, "Phi0 in unit of radian, true: rad, false: deg", true);
42 addParam("StoreTrackParErrors", m_storeTrackParErrors,
43 "Store Track Parameter errors (true) or not (false)", false);
44}
std::string m_recoTrackArrayName
Belle2::RecoTrack StoreArray nam.e.
bool m_phi0InRad
Unit of phi0, true: radian, false: degree.
bool m_eventT0Extraction
run with event t0 extraction
std::string m_treeName
output tree name.
std::string m_outputFileName
Output file name.
bool m_storeTrackParErrors
Store error of track parameters or not.
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Module()
Constructor.
Definition: Module.cc:30
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

◆ ~CDCCosmicAnalysisModule()

Destructor.

Definition at line 46 of file CDCCosmicAnalysisModule.cc.

47{
48}

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Begin run action.

Reimplemented from Module.

Definition at line 106 of file CDCCosmicAnalysisModule.cc.

107{
108 ROOT::Math::XYZVector pos(0, 0, 0);
109 ROOT::Math::XYZVector bfield = BFieldManager::getFieldInTesla(pos);
110 if (bfield.Z() > 0.5) {
111 m_bField = true;
112 B2INFO("CDCCosmicAnalysis: Magnetic field is ON");
113 } else {
114 m_bField = false;
115 B2INFO("CDCCosmicAnalysis: Magnetic field is OFF");
116 }
117 B2INFO("CDCCosmicAnalysis: BField at (0,0,0) = " << bfield.R());
118}
static ROOT::Math::XYZVector getFieldInTesla(const ROOT::Math::XYZVector &pos)
return the magnetic field at a given position in Tesla.
Definition: BFieldManager.h:61
bool m_bField
Data are taken with B-field or not, if true, NDF=5 in cal P-value.

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

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ 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(); }
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(); }
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(); }
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(); }
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(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ endRun()

void endRun ( void  )
overridevirtual

End run action.

Reimplemented from Module.

Definition at line 231 of file CDCCosmicAnalysisModule.cc.

232{
233}

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

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

Event action (main routine).

Reimplemented from Module.

Definition at line 120 of file CDCCosmicAnalysisModule.cc.

121{
122 if (m_EventMetaData.isValid())
123 run = m_EventMetaData->getRun();
124
125 evtT0 = 0;
127 // event with is fail to extract event-t0 will be excluded
128 if (m_eventTimeStoreObject.isValid() && m_eventTimeStoreObject->hasEventT0()) {
129 evtT0 = m_eventTimeStoreObject->getEventT0();
130 } else {
131 return;
132 }
133 }
134
135 // Loop over Tracks
136 int nTr = m_Tracks.getEntries();
137
138 short charge2 = 0;
139 short charge1 = 0;
140 bool up(false), down(false);
141 for (int i = 0; i < nTr; ++i) {
142 const Belle2::Track* b2track = m_Tracks[i];
143 const Belle2::TrackFitResult* fitresult;
144 fitresult = b2track->getTrackFitResult(Const::muon);
145 if (!fitresult) {
146 B2WARNING("There is no track fit result for muon hypothesis; try with the closest mass hypothesis...");
147 fitresult = b2track->getTrackFitResultWithClosestMass(Const::muon);
148 if (!fitresult) {
149 B2WARNING("There is also no track fit reslt for the other mass hypothesis");
150 continue;
151 }
152 }
154 if (!recoTrack) {
155 B2WARNING("Can not access RecoTrack of this Belle2::Track");
156 continue;
157 }
158
159 B2Vector3D posSeed = recoTrack->getPositionSeed();
160 const genfit::FitStatus* fs = recoTrack->getTrackFitStatus();
161
162 double ndf = fs->getNdf();
163 if (!m_bField) // in case of no magnetic field, #track par=4 instead of 5.
164 ndf += 1;
165
166 double Chi2 = fs->getChi2();
167 double TrPval = std::max(0., ROOT::Math::chisquared_cdf_c(Chi2, ndf));
168 double Phi0 = fitresult->getPhi0();
169 if (m_phi0InRad == false) { // unit of degrees.
170 Phi0 *= 180 / M_PI;
171 }
172
173 /*** Two track case.***/
174 if ((posSeed.Y() > 0 && !up) ||
175 (up && posSeed.Y()*posSeed1.Y() > 0 && ndf > ndf1)) {
176 charge1 = fitresult->getChargeSign();
177 posSeed1 = posSeed;
178 D01 = fitresult->getD0();
179 eD01 = sqrt(fitresult->getCovariance5()[0][0]);
180 Phi01 = Phi0;
181 ePhi01 = sqrt(fitresult->getCovariance5()[1][1]);
182 if (m_phi0InRad == false) { // unit of degrees.
183 ePhi01 *= 180 / M_PI;
184 }
185
186 Omega1 = fitresult->getOmega();
187 Mom1 = B2Vector3D(fitresult->getMomentum());
188 eOm1 = sqrt(fitresult->getCovariance5()[2][2]);
189 Z01 = fitresult->getZ0();
190 eZ01 = sqrt(fitresult->getCovariance5()[3][3]);
191 tanLambda1 = fitresult->getTanLambda();
192 etanL1 = sqrt(fitresult->getCovariance5()[4][4]);
193 Pt1 = fitresult->getTransverseMomentum();
194 ndf1 = ndf;
195 Pval1 = TrPval;
196 up = true;
197 }
198
199 if ((posSeed.Y() < 0 && !down) ||
200 (down && posSeed.Y()*posSeed2.Y() > 0 && ndf > ndf2)) {
201 charge2 = fitresult->getChargeSign();
202 posSeed2 = posSeed;
203 D02 = fitresult->getD0();
204 eD02 = sqrt(fitresult->getCovariance5()[0][0]);
205 Phi02 = Phi0;
206 ePhi02 = sqrt(fitresult->getCovariance5()[1][1]);
207 if (m_phi0InRad == false) { // unit of degrees.
208 ePhi02 *= 180 / M_PI;
209 }
210 Omega2 = fitresult->getOmega();
211 Mom2 = B2Vector3D(fitresult->getMomentum());
212 eOm2 = sqrt(fitresult->getCovariance5()[2][2]);
213 Z02 = fitresult->getZ0();
214 eZ02 = sqrt(fitresult->getCovariance5()[3][3]);
215 tanLambda2 = fitresult->getTanLambda();
216 etanL2 = sqrt(fitresult->getCovariance5()[4][4]);
217 Pt2 = fitresult->getTransverseMomentum();
218 ndf2 = ndf;
219 Pval2 = TrPval;
220 down = true;
221 }
222 }
223 if (m_bField && charge1 * charge2 == 0) return;
224 if (charge1 * charge2 >= 0 && up && down) {
225 charge = charge1;
226 tree->Fill();
227 }
228
229}
DataType Y() const
access variable Y (= .at(1) without boundary check)
Definition: B2Vector3.h:433
StoreObjPtr< EventT0 > m_eventTimeStoreObject
Event t0.
double eZ01
error on Z0 of 1st track.
double eD01
error on D0 of 1st track.
double ndf1
degree of freedom of 1st track.
double ndf2
degree of freedom of 2nd track.
double eD02
error on D0 of 2nd track.
TVector3 posSeed1
seed position of the first track.
double etanL1
error on TanLambda of 1st track.
double eOm1
error on Omega of 1st track.
double eOm2
error on Omega of 2nd track.
double etanL2
error on TanLambda of 2nd track.
TVector3 posSeed2
seed position of the second track.
double eZ02
error on Z0 of 2nd track.
TTree * tree
output tree, save info of each hit.
double tanLambda2
Tanlambda of 2nd track.
double ePhi02
error on Phi0 of 2nd track.
double ePhi01
error on Phi0 of 1st track.
StoreObjPtr< EventMetaData > m_EventMetaData
Event metadata.
double tanLambda1
TanLambda of 1st track.
static const ChargedStable muon
muon particle
Definition: Const.h:660
This is the Reconstruction Event-Data Model Track.
Definition: RecoTrack.h:79
ROOT::Math::XYZVector getPositionSeed() const
Return the position seed stored in the reco track. ATTENTION: This is not the fitted position.
Definition: RecoTrack.h:480
const genfit::FitStatus * getTrackFitStatus(const genfit::AbsTrackRep *representation=nullptr) const
Return the track fit status for the given representation or for the cardinal one. You are not allowed...
Definition: RecoTrack.h:621
TO * getRelatedTo(const std::string &name="", const std::string &namedRelation="") const
Get the object to which this object has a relation.
Values of the result of a track fit with a given particle hypothesis.
TMatrixDSym getCovariance5() const
Getter for covariance matrix of perigee parameters in matrix form.
short getChargeSign() const
Return track charge (1 or -1).
double getOmega() const
Getter for omega.
double getD0() const
Getter for d0.
double getTransverseMomentum() const
Getter for the absolute value of the transverse momentum at the perigee.
double getTanLambda() const
Getter for tanLambda.
double getZ0() const
Getter for z0.
ROOT::Math::XYZVector getMomentum() const
Getter for vector of momentum at closest approach of track in r/phi projection.
double getPhi0() const
Getter for phi0.
Class that bundles various TrackFitResults.
Definition: Track.h:25
const TrackFitResult * getTrackFitResult(const Const::ChargedStable &chargedStable) const
Default Access to TrackFitResults.
Definition: Track.cc:30
const TrackFitResult * getTrackFitResultWithClosestMass(const Const::ChargedStable &requestedType) const
Return the track fit for a fit hypothesis with the closest mass.
Definition: Track.cc:104
B2Vector3< double > B2Vector3D
typedef for common usage with double
Definition: B2Vector3.h:516
double sqrt(double a)
sqrt for double
Definition: beamHelpers.h:28

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "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.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

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

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

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

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

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

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

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

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

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

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}
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.

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

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

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ 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
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

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

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
overridevirtual

Initializes the Module.

Reimplemented from Module.

Definition at line 49 of file CDCCosmicAnalysisModule.cc.

50{
51 // Register histograms (calls back defineHisto)
52 m_Tracks.isRequired(m_trackArrayName);
56
57 m_relRecoTrackTrackName = relRecoTrackTrack.getName();
58
59 tfile = new TFile(m_outputFileName.c_str(), "RECREATE");
60 // tree = new TTree("treeTrk", "treeTrk");
61 tree = new TTree(m_treeName.c_str(), m_treeName.c_str());
62 tree->Branch("run", &run, "run/I");
63 tree->Branch("evtT0", &evtT0, "evtT0/D");
64 tree->Branch("charge", &charge, "charge/S");
65
66 tree->Branch("Pval1", &Pval1, "Pval1/D");
67 tree->Branch("ndf1", &ndf1, "ndf1/D");
68 tree->Branch("Pt1", &Pt1, "Pt1/D");
69 tree->Branch("D01", &D01, "D01/D");
70 tree->Branch("Phi01", &Phi01, "Phi01/D");
71 // tree->Branch("Om1", &Om1, "Om1/D");
72 tree->Branch("Z01", &Z01, "Z01/D");
73 tree->Branch("tanLambda1", &tanLambda1, "tanLambda1/D");
74 tree->Branch("posSeed1", "TVector3", &posSeed1);
75 tree->Branch("Omega1", &Omega1, "Omega1/D");
76 tree->Branch("Mom1", "TVector3", &Mom1);
77
78 tree->Branch("Pval2", &Pval2, "Pval2/D");
79 tree->Branch("ndf2", &ndf2, "ndf2/D");
80 tree->Branch("Pt2", &Pt2, "Pt2/D");
81 tree->Branch("D02", &D02, "D02/D");
82 tree->Branch("Phi02", &Phi02, "Phi02/D");
83 // tree->Branch("Om2", &Om2, "Om2/D");
84 tree->Branch("Z02", &Z02, "Z02/D");
85 tree->Branch("tanLambda2", &tanLambda2, "tanLambda2/D");
86 tree->Branch("posSeed2", "TVector3", &posSeed2);
87 tree->Branch("Omega2", &Omega2, "Omega2/D");
88 tree->Branch("Mom2", "TVector3", &Mom2);
89
91 tree->Branch("eD01", &eD01, "eD01/D");
92 tree->Branch("ePhi01", &ePhi01, "ePhi01/D");
93 tree->Branch("eOm1", &eOm1, "eOm1/D");
94 tree->Branch("eZ01", &eZ01, "eZ01/D");
95 tree->Branch("etanL1", &etanL1, "etanL1/D");
96
97 tree->Branch("eD02", &eD02, "eD02/D");
98 tree->Branch("ePhi02", &ePhi02, "ePhi02/D");
99 tree->Branch("eOm2", &eOm2, "eOm2/D");
100 tree->Branch("eZ02", &eZ02, "eZ02/D");
101 tree->Branch("etanL2", &etanL2, "etanL2/D");
102 }
103
104}
StoreArray< TrackFitResult > m_TrackFitResults
Track fit results.
std::string m_relRecoTrackTrackName
Releation between RecoTrack and Belle2:Track.
std::string m_trackArrayName
Belle2::Track StoreArray name.
std::string m_trackFitResultArrayName
Belle2::TrackFitResult StoreArray name.
StoreArray< RecoTrack > m_RecoTracks
Tracks.
Low-level class to create/modify relations between StoreArrays.
Definition: RelationArray.h:62
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ 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
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ 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
nameThe 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
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ 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
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ 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
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ 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
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

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

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

◆ terminate()

void terminate ( void  )
overridevirtual

Termination action.

Reimplemented from Module.

Definition at line 235 of file CDCCosmicAnalysisModule.cc.

236{
237 tfile->cd();
238 tree->Write();
239 tfile->Close();
240}

Member Data Documentation

◆ charge

short charge
private

charge of track

Definition at line 128 of file CDCCosmicAnalysisModule.h.

◆ D01

double D01
private

D0 of 1st track.

Definition at line 97 of file CDCCosmicAnalysisModule.h.

◆ D02

double D02
private

D0 of 2nd track.

Definition at line 98 of file CDCCosmicAnalysisModule.h.

◆ eD01

double eD01
private

error on D0 of 1st track.

Definition at line 107 of file CDCCosmicAnalysisModule.h.

◆ eD02

double eD02
private

error on D0 of 2nd track.

Definition at line 108 of file CDCCosmicAnalysisModule.h.

◆ eOm1

double eOm1
private

error on Omega of 1st track.

Definition at line 109 of file CDCCosmicAnalysisModule.h.

◆ eOm2

double eOm2
private

error on Omega of 2nd track.

Definition at line 110 of file CDCCosmicAnalysisModule.h.

◆ ePhi01

double ePhi01
private

error on Phi0 of 1st track.

Definition at line 111 of file CDCCosmicAnalysisModule.h.

◆ ePhi02

double ePhi02
private

error on Phi0 of 2nd track.

Definition at line 112 of file CDCCosmicAnalysisModule.h.

◆ etanL1

double etanL1
private

error on TanLambda of 1st track.

Definition at line 115 of file CDCCosmicAnalysisModule.h.

◆ etanL2

double etanL2
private

error on TanLambda of 2nd track.

Definition at line 116 of file CDCCosmicAnalysisModule.h.

◆ evtT0

double evtT0
private

event t0.

Definition at line 127 of file CDCCosmicAnalysisModule.h.

◆ eZ01

double eZ01
private

error on Z0 of 1st track.

Definition at line 113 of file CDCCosmicAnalysisModule.h.

◆ eZ02

double eZ02
private

error on Z0 of 2nd track.

Definition at line 114 of file CDCCosmicAnalysisModule.h.

◆ m_bField

bool m_bField
private

Data are taken with B-field or not, if true, NDF=5 in cal P-value.

Definition at line 130 of file CDCCosmicAnalysisModule.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_EventMetaData

StoreObjPtr<EventMetaData> m_EventMetaData
private

Event metadata.

Definition at line 77 of file CDCCosmicAnalysisModule.h.

◆ m_eventT0Extraction

bool m_eventT0Extraction
private

run with event t0 extraction

Definition at line 131 of file CDCCosmicAnalysisModule.h.

◆ m_eventTimeStoreObject

StoreObjPtr<EventT0> m_eventTimeStoreObject
private

Event t0.

Definition at line 78 of file CDCCosmicAnalysisModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.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_outputFileName

std::string m_outputFileName
private

Output file name.

Definition at line 86 of file CDCCosmicAnalysisModule.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_phi0InRad

bool m_phi0InRad
private

Unit of phi0, true: radian, false: degree.

Definition at line 132 of file CDCCosmicAnalysisModule.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_recoTrackArrayName

std::string m_recoTrackArrayName
private

Belle2::RecoTrack StoreArray nam.e.

Definition at line 83 of file CDCCosmicAnalysisModule.h.

◆ m_RecoTracks

StoreArray<RecoTrack> m_RecoTracks
private

Tracks.

Definition at line 80 of file CDCCosmicAnalysisModule.h.

◆ m_relRecoTrackTrackName

std::string m_relRecoTrackTrackName
private

Releation between RecoTrack and Belle2:Track.

Definition at line 85 of file CDCCosmicAnalysisModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_storeTrackParErrors

bool m_storeTrackParErrors
private

Store error of track parameters or not.

Definition at line 133 of file CDCCosmicAnalysisModule.h.

◆ m_trackArrayName

std::string m_trackArrayName
private

Belle2::Track StoreArray name.

Definition at line 82 of file CDCCosmicAnalysisModule.h.

◆ m_trackFitResultArrayName

std::string m_trackFitResultArrayName
private

◆ m_TrackFitResults

StoreArray<TrackFitResult> m_TrackFitResults
private

Track fit results.

Definition at line 81 of file CDCCosmicAnalysisModule.h.

◆ m_Tracks

StoreArray<Track> m_Tracks
private

Tracks.

Definition at line 79 of file CDCCosmicAnalysisModule.h.

◆ m_treeName

std::string m_treeName
private

output tree name.

Definition at line 87 of file CDCCosmicAnalysisModule.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.

◆ Mom1

TVector3 Mom1
private

Momentum of 1st track.

Definition at line 123 of file CDCCosmicAnalysisModule.h.

◆ Mom2

TVector3 Mom2
private

Momentum of 2nd track.

Definition at line 124 of file CDCCosmicAnalysisModule.h.

◆ ndf1

double ndf1
private

degree of freedom of 1st track.

Definition at line 93 of file CDCCosmicAnalysisModule.h.

◆ ndf2

double ndf2
private

degree of freedom of 2nd track.

Definition at line 94 of file CDCCosmicAnalysisModule.h.

◆ Omega1

double Omega1
private

omega of 1st track.

Definition at line 125 of file CDCCosmicAnalysisModule.h.

◆ Omega2

double Omega2
private

omega of 2nd track.

Definition at line 126 of file CDCCosmicAnalysisModule.h.

◆ Phi01

double Phi01
private

Phi0 of 1st track.

Definition at line 99 of file CDCCosmicAnalysisModule.h.

◆ Phi02

double Phi02
private

Phi0 of 2nd track.

Definition at line 100 of file CDCCosmicAnalysisModule.h.

◆ posSeed1

TVector3 posSeed1
private

seed position of the first track.

Definition at line 120 of file CDCCosmicAnalysisModule.h.

◆ posSeed2

TVector3 posSeed2
private

seed position of the second track.

Definition at line 121 of file CDCCosmicAnalysisModule.h.

◆ Pt1

double Pt1
private

Pt of 1st track.

Definition at line 117 of file CDCCosmicAnalysisModule.h.

◆ Pt2

double Pt2
private

Pt of 2nd track.

Definition at line 118 of file CDCCosmicAnalysisModule.h.

◆ Pval1

double Pval1
private

P-value of 1st track.

Definition at line 95 of file CDCCosmicAnalysisModule.h.

◆ Pval2

double Pval2
private

P-value of 2nd track.

Definition at line 96 of file CDCCosmicAnalysisModule.h.

◆ run

int run
private

Run number.

Definition at line 92 of file CDCCosmicAnalysisModule.h.

◆ tanLambda1

double tanLambda1
private

TanLambda of 1st track.

Definition at line 105 of file CDCCosmicAnalysisModule.h.

◆ tanLambda2

double tanLambda2
private

Tanlambda of 2nd track.

Definition at line 106 of file CDCCosmicAnalysisModule.h.

◆ tfile

TFile* tfile
private

Output file.

Definition at line 90 of file CDCCosmicAnalysisModule.h.

◆ tree

TTree* tree
private

output tree, save info of each hit.

Definition at line 91 of file CDCCosmicAnalysisModule.h.

◆ Z01

double Z01
private

Z0 of 1st track.

Definition at line 103 of file CDCCosmicAnalysisModule.h.

◆ Z02

double Z02
private

Z0 of 2nd track.

Definition at line 104 of file CDCCosmicAnalysisModule.h.


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