Extracts dE/dx information for calibration testing. More...

#include <HitLevelInfoWriter.h>

Inheritance diagram for HitLevelInfoWriterModule:

Collaboration diagram for HitLevelInfoWriterModule:

[legend]

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

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

Public Member Functions
	HitLevelInfoWriterModule ()
	Default constructor.

virtual	~HitLevelInfoWriterModule ()
	Destructor.

virtual void	initialize () override
	Initialize the module.

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

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

void	bookOutput (std::string filename)
	Create the output TFiles and TTrees.

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

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

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

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

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

void	setLogLevel (int logLevel)
	Configure the log level.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
void	fillTrack (const TrackFitResult *fitResult)
	Fill the TTree with the information from the track fit.

void	fillDedx (CDCDedxTrack *dedxTrack)
	Fill the TTree with the information from a CDCDedxTrack object.

void	clearEntries ()
	Clear the arrays before filling an event.

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

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

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

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

Private Attributes
std::string	m_strOutputBaseName
	Base name for the output ROOT files.

std::vector< std::string >	m_strParticleList
	Vector of ParticleLists to write out.

std::vector< std::string >	m_filename
	full names of the output ROOT files

std::vector< TFile * >	m_file
	output ROOT files

std::vector< TTree * >	m_tree
	output ROOT trees

StoreArray< CDCDedxTrack >	m_dedxTracks
	Required array of CDCDedxTracks.

StoreArray< Track >	m_tracks
	Required array of input Tracks.

StoreArray< TrackFitResult >	m_trackFitResults
	Required array of input TrackFitResults.

StoreArray< ECLCluster >	m_eclClusters
	Required array of input ECLClusters.

StoreArray< KLMCluster >	m_klmClusters
	Required array of input KLMClusters.

int	m_expID { -1}
	experiment in which this Track was found

int	m_runID { -1}
	run in which this Track was found

int	m_eventID { -1}
	event in which this Track was found

double	m_d0 {0.}
	Signed distance to the POCA in the r-phi plane.

double	m_z0 {0.}
	z coordinate of the POCA

double	m_dz { -1.}
	vertex or POCA in case of tracks z in respect to IPs

double	m_dr { -1.}
	track d0 relative to IP

double	m_dphi { -1.}
	POCA in degrees in respect to IP.

double	m_vx0 {0.}
	X coordinate of track POCA to origin.

double	m_vy0 {0.}
	Y coordinate of track POCA to origin.

double	m_vz0 {0.}
	Z coordinate of track POCA to origin.

double	m_tanlambda { -1.}
	Slope of the track in the r-z plane.

double	m_phi0 { -1.}
	Angle of the transverse momentum in the r-phi plane.

double	m_chi2 { -1.}
	chi^2 from track fit

double	m_nCDChits { -1.}
	Number of CDC hits associated to the track.

int	m_inCDC { -1}
	frack is CDC acceptance or not

int	m_trackID { -1}
	ID number of the Track.

double	m_length { -1.}
	total path length of the Track

int	m_charge {0}
	the charge for this Track

double	m_cosTheta { -2.}
	cos(theta) for the track

double	m_pCDC { -1.}
	momentum valid in CDC

double	m_p { -1.}
	momentum from tracking

double	m_pt { -1.}
	transverse momentum from tracking

double	m_phi { -1.}
	phi for the track

double	m_ioasym { -1.}
	asymmetry in increasing vs decreasing layer numbers per track

double	m_theta { -2.}
	cos(theta) for the track

double	m_PDG { -1.}
	MC PID.

double	m_mean { -1.}
	dE/dx averaged

double	m_trunc { -1.}
	dE/dx averaged, truncated mean, with corrections

double	m_truncNoSat { -1.}
	dE/dx averaged, truncated mean, with corrections (not hadron)

double	m_error { -1.}
	standard deviation of the truncated mean

double	m_eop { -1.}
	energy over momentum in the calorimeter

double	m_e { -1.}
	energy in the calorimeter

double	m_e1_9 { -1.}
	ratio of energies of the central 1 crystal vs 3x3 crystals

double	m_e9_21 { -1.}
	ratio of energies of the central 3x3 crystal vs 5x5 crystals

double	m_klmLayers { -1.}
	number of klm layers with hits

double	m_scale { -1.}
	calibration scale factor

double	m_cosCor { -1.}
	calibration cosine correction

double	m_cosEdgeCor { -1.}
	calibration cosine edge correction

double	m_runGain { -1.}
	calibration run gain

double	m_chie { -1.}
	chi value for electron hypothesis

double	m_chimu { -1.}
	chi value for muon hypothesis

double	m_chipi { -1.}
	chi value for pion hypothesis

double	m_chik { -1.}
	chi value for kaon hypothesis

double	m_chip { -1.}
	chi value for proton hypothesis

double	m_chid { -1.}
	chi value for deuteron hypothesis

double	m_prese { -1.}
	pred reso for electron hypothesis

double	m_presmu { -1.}
	pred reso for muon hypothesis

double	m_prespi { -1.}
	pred reso for pion hypothesis

double	m_presk { -1.}
	pred reso for kaon hypothesis

double	m_presp { -1.}
	pred reso for proton hypothesis

double	m_presd { -1.}
	pred reso for deuteron hypothesis

double	m_pmeane { -1.}
	pred mean for electron hypothesis

double	m_pmeanmu { -1.}
	pred mean for muon hypothesis

double	m_pmeanpi { -1.}
	pred mean for pion hypothesis

double	m_pmeank { -1.}
	pred mean for kaon hypothesis

double	m_pmeanp { -1.}
	pred mean for proton hypothesis

double	m_pmeand { -1.}
	pred mean for deuteron hypothesis

int	l_nhits { -1}
	the total number of layer hits for this Track

int	l_nhitsused { -1}
	the total number of layer hits used for this Track

int	l_nhitscombined [kMaxHits] = {}
	the number of hits combined this layer

int	l_wirelongesthit [kMaxHits] = {}
	the wire number of longest hit in this layer

int	l_layer [kMaxHits] = {}
	layer number

double	l_path [kMaxHits] = {}
	distance travelled in this layer

double	l_dedx [kMaxHits] = {}
	dE/dx for this layer

int	h_nhits { -1}
	the number of good hits for this Track

int	h_lwire [kMaxHits] = {}
	sense wire within layer

int	h_wire [kMaxHits] = {}
	sense wire ID

int	h_layer [kMaxHits] = {}
	layer number

double	h_path [kMaxHits] = {}
	path length in cell

double	h_dedx [kMaxHits] = {}
	charge per path length

double	h_adcraw [kMaxHits] = {}
	charge per hit

double	h_adccorr [kMaxHits] = {}
	charge per hit corr by nonlinear ADC

double	h_doca [kMaxHits] = {}
	distance of closest approach

double	h_ndoca [kMaxHits] = {}
	normalized distance of closest approach

double	h_ndocaRS [kMaxHits] = {}
	normalized +RS distance of closest approach

double	h_enta [kMaxHits] = {}
	entrance angle

double	h_entaRS [kMaxHits] = {}
	normalized + RS distance of entrance angle

double	h_driftT [kMaxHits] = {}
	drift time

double	h_driftD [kMaxHits] = {}
	drift distance

double	h_facnladc [kMaxHits] = {}
	calibration hit gain

double	h_wireGain [kMaxHits] = {}
	calibration hit gain

double	h_twodCor [kMaxHits] = {}
	calibration 2D correction

double	h_onedCor [kMaxHits] = {}
	calibration 1D cleanup correction

double	h_WeightPionHypo [kMaxHits] = {}
	weight for pion hypothesis from KalmanFitterInfo

double	h_WeightKaonHypo [kMaxHits] = {}
	weight for kaon hypothesis from KalmanFitterInfo

double	h_WeightProtonHypo [kMaxHits] = {}
	weight for proton hypothesis from KalmanFitterInfo

int	h_foundByTrackFinder [kMaxHits] = {}
	the 'found by track finder' flag for the given hit

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

DBObjPtr< CDCDedxWireGain >	m_DBWireGains
	Wire gain DB object.

DBObjPtr< CDCDedxRunGain >	m_DBRunGain
	Run gain DB object.

DBObjPtr< CDCDedxCosineCor >	m_DBCosineCor
	Electron saturation correction DB object.

DBObjPtr< CDCDedx2DCell >	m_DB2DCell
	2D correction DB object

DBObjPtr< CDCDedx1DCell >	m_DB1DCell
	1D correction DB object

DBObjPtr< CDCDedxADCNonLinearity >	m_DBNonlADC
	hadron saturation non linearity

DBObjPtr< CDCDedxCosineEdge >	m_DBCosEdgeCor
	cosine edge calibration

bool	nodeadwire
	write only active wires

bool	enableHitLevel
	Flag to switch on/off hit level info.

bool	enableExtraVar
	Flag to switch on/off extra level info and some available w/ release/5 only.

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.

Static Private Attributes
static const int	kMaxHits = 200
	default hit level index

Detailed Description

Extracts dE/dx information for calibration testing.

Writes a ROOT file.

Definition at line 59 of file HitLevelInfoWriter.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

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

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

Definition at line 77 of file Module.h.

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

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

This method can be implemented by subclasses.

Definition at line 147 of file Module.h.

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

◆ event()

void event ( void )

overridevirtual

This method is called for each event.

All processing of the event takes place in this method.

Reimplemented from Module.

Definition at line 61 of file HitLevelInfoWriter.cc.

 {
  
   int nParticleList = m_strParticleList.size();
  
   // **************************************************
   //  LOOP OVER dE/dx measurements for all tracks if
   //    no particle list is specified.
   // **************************************************
   if (nParticleList == 0) {
     for (int idedx = 0; idedx < m_dedxTracks.getEntries(); idedx++) {
  
       CDCDedxTrack* dedxTrack = m_dedxTracks[idedx];
       if (!dedxTrack) {
         B2WARNING("No dedx related track...");
         continue;
       }
  
       const Track* track = dedxTrack->getRelatedFrom<Track>();
       if (!track) {
         B2WARNING("No related track...");
         continue;
       }
  
       const TrackFitResult* fitResult = track->getTrackFitResultWithClosestMass(Const::pion);
       if (!fitResult) {
         B2WARNING("No related fit for this track...");
         continue;
       }
  
       if (dedxTrack->size() == 0 || dedxTrack->size() > 200) continue;
       if (dedxTrack->getCosTheta() < -1.0 || dedxTrack->getCosTheta() > 1.0) continue;
  
       // fill the event meta data
       StoreObjPtr<EventMetaData> evtMetaData;
       m_expID = evtMetaData->getExperiment();
       m_runID = evtMetaData->getRun();
       m_eventID = evtMetaData->getEvent();
  
       // fill the E/P
       const ECLCluster* eclCluster = track->getRelated<ECLCluster>();
       if (eclCluster and eclCluster->hasHypothesis(ECLCluster::EHypothesisBit::c_nPhotons)) {
         m_eop = (eclCluster->getEnergy(ECLCluster::EHypothesisBit::c_nPhotons)) / (fitResult->getMomentum().Mag());
         m_e = eclCluster->getEnergy(ECLCluster::EHypothesisBit::c_nPhotons);
         m_e1_9 = eclCluster->getE1oE9();
         m_e9_21 = eclCluster->getE9oE21();
         // fill the muon depth
         const KLMCluster* klmCluster = eclCluster->getRelated<KLMCluster>();
         if (klmCluster) m_klmLayers = klmCluster->getLayers();
       }
  
       // fill the TTree with the Track information
       fillTrack(fitResult);
  
       // fill the TTree with the CDCDedxTrack information
       fillDedx(dedxTrack);
  
       // fill the TTree
       m_tree[0]->Fill();
     }
   }
  
   // **************************************************
   //
   //  LOOP OVER particles in the given particle lists
   //
   // **************************************************
  
   for (int iList = 0; iList < nParticleList; iList++) {
     // make sure the list exists and is not empty
     StoreObjPtr<ParticleList> particlelist(m_strParticleList[iList]);
     if (!particlelist or particlelist->getListSize(true) == 0) {
       //B2WARNING("ParticleList " << m_strParticleList[iList] << " not found or empty, skipping");
       continue;
     }
  
     // loop over the particles in the list and follow the links to the
     // dE/dx information (Particle -> PIDLikelihood -> Track -> CDCDedxTrack)
     for (unsigned int iPart = 0; iPart < particlelist->getListSize(true); iPart++) {
       Particle* part = particlelist->getParticle(iPart, true);
       if (!part) {
         B2WARNING("No particles...");
         continue;
       }
       PIDLikelihood* pid = part->getRelatedTo<PIDLikelihood>();
       if (!pid) {
         B2WARNING("No related PID likelihood...");
         continue;
       }
       Track* track = pid->getRelatedFrom<Track>();
       if (!track) {
         B2WARNING("No related track...");
         continue;
       }
       CDCDedxTrack* dedxTrack = track->getRelatedTo<CDCDedxTrack>();
       if (!dedxTrack) {
         B2WARNING("No related CDCDedxTrack...");
         continue;
       }
       std::string ptype = m_strParticleList[iList].substr(0, m_strParticleList[iList].find(":"));
       const TrackFitResult* fitResult = track->getTrackFitResult(Const::pion);
       if (ptype != "pi+") {
         if (ptype == "K+") fitResult = track->getTrackFitResultWithClosestMass(Const::kaon);
         else if (ptype == "p+") fitResult = track->getTrackFitResultWithClosestMass(Const::proton);
         else if (ptype == "deuteron") fitResult = track->getTrackFitResultWithClosestMass(Const::deuteron);
         else if (ptype == "mu+") fitResult = track->getTrackFitResultWithClosestMass(Const::muon);
         else if (ptype == "e+") fitResult = track->getTrackFitResultWithClosestMass(Const::electron);
       }
       if (!fitResult) {
         B2WARNING("No related fit for this track...");
         continue;
       }
  
       if (dedxTrack->size() == 0 || dedxTrack->size() > 200) continue;
       //if out CDC (dont add as we dont correct via correctionmodules)
       if (dedxTrack->getCosTheta() < TMath::Cos(150.0 * TMath::DegToRad()))continue; //-0.866
       if (dedxTrack->getCosTheta() > TMath::Cos(17.0 * TMath::DegToRad())) continue; //0.95
  
       // fill the event meta data
       StoreObjPtr<EventMetaData> evtMetaData;
       m_expID = evtMetaData->getExperiment();
       m_runID = evtMetaData->getRun();
       m_eventID = evtMetaData->getEvent();
  
       // fill the E/P
       const ECLCluster* eclCluster = track->getRelated<ECLCluster>();
       if (eclCluster and eclCluster->hasHypothesis(ECLCluster::EHypothesisBit::c_nPhotons)) {
         m_eop = (eclCluster->getEnergy(ECLCluster::EHypothesisBit::c_nPhotons)) / (fitResult->getMomentum().Mag());
  
         // fill the muon depth
         const KLMCluster* klmCluster = eclCluster->getRelated<KLMCluster>();
         if (klmCluster) m_klmLayers = klmCluster->getLayers();
       }
  
       // fill the TTree with the Track information
       fillTrack(fitResult);
  
       // fill the TTree with the CDCDedxTrack information
       fillDedx(dedxTrack);
  
       // fill the TTree
       m_tree[iList]->Fill();
     }
   }
 }

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

reconstruction/modules/HitLevelInfoWriter/include/HitLevelInfoWriter.h
reconstruction/modules/HitLevelInfoWriter/src/HitLevelInfoWriter.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ event()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()