Read SKB PVs, simulated measurements of BEAST sensors, and write scaled simulated Ntuple in BEAST phase 1 data format. More...

#include <NtuplePhase1_v6Module.h>

Inheritance diagram for NtuplePhase1_v6Module:

[legend]

Collaboration diagram for NtuplePhase1_v6Module:

[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
	NtuplePhase1_v6Module ()
	Constructor.

virtual	~NtuplePhase1_v6Module ()
	Destructor.

virtual void	initialize () override
	Initialize the Module. More...

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

virtual void	event () override
	Event processor.

virtual void	endRun () override
	End-of-run action. More...

virtual void	terminate () override
	Termination action. More...

void	printModuleParams () const
	Prints module parameters.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules. 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
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
double	m_input_Time_eqv
	time stamp eqv

std::vector< Int_t >	m_input_ts
	time stamp start and stop

std::vector< std::string >	m_inputFileNames
	list of file names

Double_t	m_input_Z_scaling [4]
	time stamp start and stop

std::vector< Double_t >	m_input_Z
	input Z

Int_t	m_input_BGSol
	time stamp start and stop

Int_t	m_input_ToSol
	time stamp start and stop

Int_t	m_input_part
	which components to take into account

std::vector< Double_t >	m_input_GasCorrection
	time stamp start and stop

std::vector< std::string >	m_inputRateHistoNames
	list of file names

std::vector< std::string >	m_inputDoseHistoNames
	list of file names

std::vector< std::string >	m_inputRateHistoNamesVrs
	list of file names

std::vector< std::string >	m_inputDoseHistoNamesVrs
	list of file names

std::vector< Double_t >	m_input_LT_DIA_dose
	list of DIA LT dose

std::vector< Double_t >	m_input_HT_DIA_dose
	list of DIA HT dose

std::vector< Double_t >	m_input_LC_DIA_dose [12]
	list of DIA LC dose

std::vector< Double_t >	m_input_HC_DIA_dose [12]
	list of DIA HC dose

std::vector< Double_t >	m_input_LB_DIA_dose [12]
	list of DIA LB dose

std::vector< Double_t >	m_input_HB_DIA_dose [12]
	list of DIA HB dose

std::vector< Double_t >	m_input_LC_DIA_dose_av
	list of DIA LC dose

std::vector< Double_t >	m_input_HC_DIA_dose_av
	list of DIA HC dose

std::vector< Double_t >	m_input_LB_DIA_dose_av
	list of DIA LB dose

std::vector< Double_t >	m_input_HB_DIA_dose_av
	list of DIA HB dose

std::vector< Double_t >	m_input_LT_PIN_dose
	list of PIN LT dose

std::vector< Double_t >	m_input_HT_PIN_dose
	list of PIN HT dose

std::vector< Double_t >	m_input_LC_PIN_dose [12]
	list of PIN LC dose

std::vector< Double_t >	m_input_HC_PIN_dose [12]
	list of PIN HC dose

std::vector< Double_t >	m_input_LB_PIN_dose [12]
	list of PIN LB dose

std::vector< Double_t >	m_input_HB_PIN_dose [12]
	list of PIN HB dose

std::vector< Double_t >	m_input_LC_PIN_dose_av
	list of PIN LC dose

std::vector< Double_t >	m_input_HC_PIN_dose_av
	list of PIN HC dose

std::vector< Double_t >	m_input_LB_PIN_dose_av
	list of PIN LB dose

std::vector< Double_t >	m_input_HB_PIN_dose_av
	list of PIN HB dose

std::vector< Double_t >	m_input_LT_BGO_dose
	list of BGO LT dose

std::vector< Double_t >	m_input_HT_BGO_dose
	list of BGO HT dose

std::vector< Double_t >	m_input_LC_BGO_dose [12]
	list of BGO LC dose

std::vector< Double_t >	m_input_HC_BGO_dose [12]
	list of BGO HC dose

std::vector< Double_t >	m_input_LB_BGO_dose [12]
	list of BGO LB dose

std::vector< Double_t >	m_input_HB_BGO_dose [12]
	list of BGO HB dose

std::vector< Double_t >	m_input_LC_BGO_dose_av
	list of BGO LC dose

std::vector< Double_t >	m_input_HC_BGO_dose_av
	list of BGO HC dose

std::vector< Double_t >	m_input_LB_BGO_dose_av
	list of BGO LB dose

std::vector< Double_t >	m_input_HB_BGO_dose_av
	list of BGO HB dose

std::vector< Double_t >	m_input_LT_HE3_rate
	list of HE3 LT rate

std::vector< Double_t >	m_input_HT_HE3_rate
	list of HE3 HT rate

std::vector< Double_t >	m_input_LC_HE3_rate [12]
	list of HE3 LC rate

std::vector< Double_t >	m_input_HC_HE3_rate [12]
	list of HE3 HC rate

std::vector< Double_t >	m_input_LB_HE3_rate [12]
	list of HE3 LB rate

std::vector< Double_t >	m_input_HB_HE3_rate [12]
	list of HE3 HB rate

std::vector< Double_t >	m_input_LC_HE3_rate_av
	list of HE3 LC rate

std::vector< Double_t >	m_input_HC_HE3_rate_av
	list of HE3 HC rate

std::vector< Double_t >	m_input_LB_HE3_rate_av
	list of HE3 LB rate

std::vector< Double_t >	m_input_HB_HE3_rate_av
	list of HE3 HB rate

std::vector< Double_t >	m_input_LT_TPC_rate
	list of TPC LT rate

std::vector< Double_t >	m_input_HT_TPC_rate
	list of TPC HT rate

std::vector< Double_t >	m_input_LC_TPC_rate [12]
	list of TPC LC rate

std::vector< Double_t >	m_input_HC_TPC_rate [12]
	list of TPC HC rate

std::vector< Double_t >	m_input_LB_TPC_rate [12]
	list of TPC LB rate

std::vector< Double_t >	m_input_HB_TPC_rate [12]
	list of TPC HB rate

std::vector< Double_t >	m_input_LC_TPC_rate_av
	list of TPC LC rate

std::vector< Double_t >	m_input_HC_TPC_rate_av
	list of TPC HC rate

std::vector< Double_t >	m_input_LB_TPC_rate_av
	list of TPC LB rate

std::vector< Double_t >	m_input_HB_TPC_rate_av
	list of TPC HB rate

std::vector< Double_t >	m_input_LT_TPC_dose
	list of TPC LT dose

std::vector< Double_t >	m_input_HT_TPC_dose
	list of TPC HT dose

std::vector< Double_t >	m_input_LC_TPC_dose [12]
	list of TPC LC dose

std::vector< Double_t >	m_input_HC_TPC_dose [12]
	list of TPC HC dose

std::vector< Double_t >	m_input_LB_TPC_dose [12]
	list of TPC LB dose

std::vector< Double_t >	m_input_HB_TPC_dose [12]
	list of TPC HB dose

std::vector< Double_t >	m_input_LC_TPC_dose_av
	list of TPC LC dose

std::vector< Double_t >	m_input_HC_TPC_dose_av
	list of TPC HC dose

std::vector< Double_t >	m_input_LB_TPC_dose_av
	list of TPC LB dose

std::vector< Double_t >	m_input_HB_TPC_dose_av
	list of TPC HB dose

std::vector< Double_t >	m_input_LT_TPC_angular_rate
	list of TPC_angular LT rate

std::vector< Double_t >	m_input_HT_TPC_angular_rate
	list of TPC_angular HT rate

std::vector< Double_t >	m_input_LC_TPC_angular_rate [12]
	list of TPC_angular LC rate

std::vector< Double_t >	m_input_HC_TPC_angular_rate [12]
	list of TPC_angular HC rate

std::vector< Double_t >	m_input_LB_TPC_angular_rate [12]
	list of TPC_angular LB rate

std::vector< Double_t >	m_input_HB_TPC_angular_rate [12]
	list of TPC_angular HB rate

std::vector< Double_t >	m_input_LC_TPC_angular_rate_av
	list of TPC_angular LC rate

std::vector< Double_t >	m_input_HC_TPC_angular_rate_av
	list of TPC_angular HC rate

std::vector< Double_t >	m_input_LB_TPC_angular_rate_av
	list of TPC_angular LB rate

std::vector< Double_t >	m_input_HB_TPC_angular_rate_av
	list of TPC_angular HB rate

std::vector< Double_t >	m_input_LT_TPC_angular_dose
	list of TPC_angular LT dose

std::vector< Double_t >	m_input_HT_TPC_angular_dose
	list of TPC_angular HT dose

std::vector< Double_t >	m_input_LC_TPC_angular_dose [12]
	list of TPC_angular LC dose

std::vector< Double_t >	m_input_HC_TPC_angular_dose [12]
	list of TPC_angular HC dose

std::vector< Double_t >	m_input_LB_TPC_angular_dose [12]
	list of TPC_angular LB dose

std::vector< Double_t >	m_input_HB_TPC_angular_dose [12]
	list of TPC_angular HB dose

std::vector< Double_t >	m_input_LC_TPC_angular_dose_av
	list of TPC_angular LC dose

std::vector< Double_t >	m_input_HC_TPC_angular_dose_av
	list of TPC_angular HC dose

std::vector< Double_t >	m_input_LB_TPC_angular_dose_av
	list of TPC_angular LB dose

std::vector< Double_t >	m_input_HB_TPC_angular_dose_av
	list of TPC_angular HB dose

std::vector< Double_t >	m_input_LT_CSI_dose
	list of CSI LT dose

std::vector< Double_t >	m_input_HT_CSI_dose
	list of CSI HT dose

std::vector< Double_t >	m_input_LC_CSI_dose [12]
	list of CSI LC dose

std::vector< Double_t >	m_input_HC_CSI_dose [12]
	list of CSI HC dose

std::vector< Double_t >	m_input_LB_CSI_dose [12]
	list of CSI LB dose

std::vector< Double_t >	m_input_HB_CSI_dose [12]
	list of CSI HB dose

std::vector< Double_t >	m_input_LC_CSI_dose_av
	list of CSI LC dose

std::vector< Double_t >	m_input_HC_CSI_dose_av
	list of CSI HC dose

std::vector< Double_t >	m_input_LB_CSI_dose_av
	list of CSI LB dose

std::vector< Double_t >	m_input_HB_CSI_dose_av
	list of CSI HB dose

std::vector< Double_t >	m_input_LT_CSI_dose_binE
	list of CSI LT dose_binE

std::vector< Double_t >	m_input_HT_CSI_dose_binE
	list of CSI HT dose_binE

std::vector< Double_t >	m_input_LC_CSI_dose_binE [12]
	list of CSI LC dose_binE

std::vector< Double_t >	m_input_HC_CSI_dose_binE [12]
	list of CSI HC dose_binE

std::vector< Double_t >	m_input_LB_CSI_dose_binE [12]
	list of CSI LB dose_binE

std::vector< Double_t >	m_input_HB_CSI_dose_binE [12]
	list of CSI HB dose_binE

std::vector< Double_t >	m_input_LC_CSI_dose_binE_av
	list of CSI LC dose_binE

std::vector< Double_t >	m_input_HC_CSI_dose_binE_av
	list of CSI HC dose_binE

std::vector< Double_t >	m_input_LB_CSI_dose_binE_av
	list of CSI LB dose_binE

std::vector< Double_t >	m_input_HB_CSI_dose_binE_av
	list of CSI HB dose_binE

std::vector< Double_t >	m_input_LT_CSI_rate
	list of CSI LT rate

std::vector< Double_t >	m_input_HT_CSI_rate
	list of CSI HT rate

std::vector< Double_t >	m_input_LC_CSI_rate [12]
	list of CSI LC rate

std::vector< Double_t >	m_input_HC_CSI_rate [12]
	list of CSI HC rate

std::vector< Double_t >	m_input_LB_CSI_rate [12]
	list of CSI LB rate

std::vector< Double_t >	m_input_HB_CSI_rate [12]
	list of CSI HB rate

std::vector< Double_t >	m_input_LC_CSI_rate_av
	list of CSI LC rate

std::vector< Double_t >	m_input_HC_CSI_rate_av
	list of CSI HC rate

std::vector< Double_t >	m_input_LB_CSI_rate_av
	list of CSI LB rate

std::vector< Double_t >	m_input_HB_CSI_rate_av
	list of CSI HB rate

std::vector< Double_t >	m_input_LT_CLAWS_rate
	list of CLAWS_rate LT

std::vector< Double_t >	m_input_HT_CLAWS_rate
	list of CLAWS_rate HT

std::vector< Double_t >	m_input_LC_CLAWS_rate [12]
	list of CLAWS_rate LC

std::vector< Double_t >	m_input_HC_CLAWS_rate [12]
	list of CLAWS_rate HC

std::vector< Double_t >	m_input_LB_CLAWS_rate [12]
	list of CLAWS_rate LB

std::vector< Double_t >	m_input_HB_CLAWS_rate [12]
	list of CLAWS_rate HB

std::vector< Double_t >	m_input_LC_CLAWS_rate_av
	list of CLAWS_rate LC

std::vector< Double_t >	m_input_HC_CLAWS_rate_av
	list of CLAWS_rate HC

std::vector< Double_t >	m_input_LB_CLAWS_rate_av
	list of CLAWS_rate LB

std::vector< Double_t >	m_input_HB_CLAWS_rate_av
	list of CLAWS_rate HB

std::vector< Double_t >	m_input_LT_QCSS_rate
	list of QCSS_rate LT

std::vector< Double_t >	m_input_HT_QCSS_rate
	list of QCSS_rate HT

std::vector< Double_t >	m_input_LC_QCSS_rate [12]
	list of QCSS_rate LC

std::vector< Double_t >	m_input_HC_QCSS_rate [12]
	list of QCSS_rate HC

std::vector< Double_t >	m_input_LB_QCSS_rate [12]
	list of QCSS_rate LB

std::vector< Double_t >	m_input_HB_QCSS_rate [12]
	list of QCSS_rate HB

std::vector< Double_t >	m_input_LC_QCSS_rate_av
	list of QCSS_rate LC

std::vector< Double_t >	m_input_HC_QCSS_rate_av
	list of QCSS_rate HC

std::vector< Double_t >	m_input_LB_QCSS_rate_av
	list of QCSS_rate LB

std::vector< Double_t >	m_input_HB_QCSS_rate_av
	list of QCSS_rate HB

std::vector< Double_t >	m_input_I_HER
	HER current and error.

std::vector< Double_t >	m_input_I_LER
	LER current and error.

std::vector< Double_t >	m_input_P_LER
	LER pressure and error.

std::vector< Double_t >	m_input_P_HER
	HER pressure and error.

std::vector< Double_t >	m_input_bunchNb_LER
	LER bunch number and error.

std::vector< Double_t >	m_input_bunchNb_HER
	HER bunch number and error.

Double_t	m_input_data_bunchNb_LER
	LER bunch number and error.

Double_t	m_input_data_bunchNb_HER
	HER bunch number and error.

std::string	m_input_data_SingleBeam
	LER or HER or Both.

std::vector< Double_t >	m_input_sigma_x_LER
	LER beam size and errors.

std::vector< Double_t >	m_input_sigma_x_HER
	HER beam size and errors.

std::vector< Double_t >	m_input_sigma_y_LER
	LER beam size and errors.

std::vector< Double_t >	m_input_sigma_y_HER
	HER beam size and errors.

std::vector< Double_t >	m_input_LB_SAD_RLR
	list of SAD_RLR LB dose

std::vector< Double_t >	m_input_HB_SAD_RLR
	list of SAD_RLR HB dose

std::vector< Double_t >	m_input_LC_SAD_RLR
	list of SAD_RLR LC dose

std::vector< Double_t >	m_input_HC_SAD_RLR
	list of SAD_RLR HC dose

std::vector< Double_t >	m_input_LB_SAD_RLR_av
	list of SAD_RLR LB dose

std::vector< Double_t >	m_input_HB_SAD_RLR_av
	list of SAD_RLR HB dose

std::vector< Double_t >	m_input_LC_SAD_RLR_av
	list of SAD_RLR LC dose

std::vector< Double_t >	m_input_HC_SAD_RLR_av
	list of SAD_RLR HC dose

std::vector< Double_t >	m_input_LT_SAD_RLR
	list of SAD_RLR LT dose

std::vector< Double_t >	m_input_HT_SAD_RLR
	list of SAD_RLR HT dose

std::vector< Double_t >	m_input_LT_DOSI
	list of PIN LT dose

std::vector< Double_t >	m_input_HT_DOSI
	list of PIN HT dose

std::vector< Double_t >	m_input_LC_DOSI [12]
	list of PIN LC dose

std::vector< Double_t >	m_input_HC_DOSI [12]
	list of PIN HC dose

std::vector< Double_t >	m_input_LB_DOSI [12]
	list of PIN LB dose

std::vector< Double_t >	m_input_HB_DOSI [12]
	list of PIN HB dose

std::vector< Double_t >	m_input_LC_DOSI_av
	list of PIN LC dose

std::vector< Double_t >	m_input_HC_DOSI_av
	list of PIN HC dose

std::vector< Double_t >	m_input_LB_DOSI_av
	list of PIN LB dose

std::vector< Double_t >	m_input_HB_DOSI_av
	list of PIN HB dose

Double_t	m_input_PIN_width
	PIN width.

std::vector< Double_t >	m_input_HE3_EfCor
	HE3 inefficiency correction.

TF1 *	fctRate_HB = nullptr
	fct HB

TF1 *	fctRate_HC = nullptr
	fct HC

TF1 *	fctRate_LB = nullptr
	fct LB

TF1 *	fctRate_LC = nullptr
	fct LC

TTree *	m_treeBEAST = 0
	BEAST tree pointer.

TTree *	m_treeTruth = 0
	Truth tree pointer.

TChain *	m_tree = 0
	tree pointer

std::string	m_inputFileName
	input file name

std::vector< std::string >	m_inputHistoFileNames
	list of histo. More...

std::string	m_outputFileName
	output file name

TFile *	m_file
	TFile.

BEAST_v5::BEASTTree_v5	m_beast
	BEAST structure.

int	m_numEntries
	number of ntuple entries

int	m_entryCounter
	entry counter

unsigned	m_numEvents = 0
	number of events (tree entries) in the sample

unsigned	m_eventCount = 0
	current event (tree entry)

unsigned	m_exp = 0
	Date of the day.

Int_t	m_DayBin
	day bin

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

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

Read SKB PVs, simulated measurements of BEAST sensors, and write scaled simulated Ntuple in BEAST phase 1 data format.

Definition at line 28 of file NtuplePhase1_v6Module.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()

void beginRun ( void )

overridevirtual

Called when entering a new run.

Set run dependent things like run header parameters, alignment, etc.

Reimplemented from Module.

Definition at line 1034 of file NtuplePhase1_v6Module.cc.

1035 {

1036 }

◆ 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()

void endRun ( void )

overridevirtual

End-of-run action.

Save run-related stuff, such as statistics.

Reimplemented from Module.

Definition at line 1773 of file NtuplePhase1_v6Module.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

◆ initialize()

void initialize ( void )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

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

◆ terminate()

void terminate ( void )

overridevirtual

Termination action.

Clean-up, close files, summarize statistics, etc.

Reimplemented from Module.

Definition at line 1777 of file NtuplePhase1_v6Module.cc.

Member Data Documentation

◆ m_inputHistoFileNames

std::vector<std::string> m_inputHistoFileNames

private

list of histo.

file names

Definition at line 292 of file NtuplePhase1_v6Module.h.

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

beast/analysis/modules/include/NtuplePhase1_v6Module.h
beast/analysis/modules/src/NtuplePhase1_v6Module.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ m_inputHistoFileNames