The trainer module for the neural networks of the CDC trigger. More...

#include <GRLNeuroTrainerModule.h>

Inheritance diagram for GRLNeuroTrainerModule:

Collaboration diagram for GRLNeuroTrainerModule:

[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
	GRLNeuroTrainerModule ()
	Constructor, for setting module description and parameters.

virtual	~GRLNeuroTrainerModule ()
	Destructor.

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

virtual void	event () override
	Called once for each event. More...

virtual void	terminate () override
	Do the training for all sectors.

void	updateRelevantID (unsigned isector)
	calculate and set the relevant id range for given sector based on hit counters of the track segments.

void	train (unsigned isector)
	Train a single MLP.

void	saveTraindata (const std::string &filename, const std::string &arrayname="trainSets")
	Save all training samples. More...

bool	loadTraindata (const std::string &filename, const std::string &arrayname="trainSets")
	Load saved training samples. More...

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.

Protected Attributes
std::string	m_TrgECLClusterName
	Name of the StoreArray containing the ECL clusters.

std::string	m_2DfinderCollectionName
	Name of the StoreArray containing the input 2D tracks.

std::string	m_GRLCollectionName
	Name of the StoreObj containing the input GRL.

std::string	m_filename
	Name of file where network weights etc. More...

std::string	m_trainFilename
	Name of file where training samples are stored.

std::string	m_logFilename
	Name of file where training log is stored.

std::string	m_arrayname
	Name of the TObjArray holding the networks.

std::string	m_trainArrayname
	Name of the TObjArray holding the training samples.

bool	m_saveDebug
	If true, save training curve and parameter distribution of training data.

bool	m_load
	Switch to load saved parameters from a previous run.

GRLNeuro::Parameters	m_parameters
	Parameters for the NeuroTrigger.

double	m_nTrainMin
	Minimal number of training samples.

double	m_nTrainMax
	Maximal number of training samples.

bool	m_multiplyNTrain
	Switch to multiply number of samples with number of weights.

int	m_nValid
	Number of validation samples.

int	m_nTest
	Number of test samples.

double	m_wMax
	Limit for weights.

int	m_nThreads
	Number of threads for training.

int	m_checkInterval
	Training is stopped if validation error is higher than checkInterval epochs ago, i.e. More...

int	m_maxEpochs
	Maximal number of training epochs.

int	m_repeatTrain
	Number of training runs with different random start weights.

GRLNeuro	m_GRLNeuro
	Instance of the NeuroTrigger.

std::vector< GRLMLPData >	m_trainSets
	Sets of training data for all sectors.

std::vector< int >	TCThetaID

std::vector< float >	TCPhiLab

std::vector< float >	TCcotThetaLab

std::vector< float >	TCPhiCOM

std::vector< float >	TCThetaCOM

std::vector< float >	TC1GeV

double	radtodeg = 0
	convert radian to degree

int	n_cdc_sector = 0
	Number of CDC sectors.

int	n_ecl_sector = 0
	Number of ECL sectors.

int	n_sector = 0
	Number of Total sectors.

std::vector< TH1D * >	h_cdc2d_phi_sig
	Histograms for monitoring.

std::vector< TH1D * >	h_cdc2d_pt_sig

std::vector< TH1D * >	h_selE_sig

std::vector< TH1D * >	h_selPhi_sig

std::vector< TH1D * >	h_selTheta_sig

std::vector< TH1D * >	h_result_sig

std::vector< TH1D * >	h_cdc2d_phi_bg

std::vector< TH1D * >	h_cdc2d_pt_bg

std::vector< TH1D * >	h_selE_bg

std::vector< TH1D * >	h_selPhi_bg

std::vector< TH1D * >	h_selTheta_bg

std::vector< TH1D * >	h_result_bg

std::vector< TH1D * >	h_ncdc_sig

std::vector< TH1D * >	h_ncdcf_sig

std::vector< TH1D * >	h_ncdcs_sig

std::vector< TH1D * >	h_ncdci_sig

std::vector< TH1D * >	h_necl_sig

std::vector< TH1D * >	h_ncdc_bg

std::vector< TH1D * >	h_ncdcf_bg

std::vector< TH1D * >	h_ncdcs_bg

std::vector< TH1D * >	h_ncdci_bg

std::vector< TH1D * >	h_necl_bg

std::vector< int >	scale_bg
	BG scale factor for training.

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
std::string	m_name
	The name of the module, saved as a string (user-modifiable)

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

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

std::string	m_description
	The description of the module.

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

LogConfig	m_logConfig
	The log system configuration of the module.

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

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

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

Detailed Description

The trainer module for the neural networks of the CDC trigger.

Prepare training data for several neural networks and train them using the Fast Artificial Neural Network library (FANN). For documentation of FANN see http://leenissen.dk/fann/wp/

Definition at line 29 of file GRLNeuroTrainerModule.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

Called once for each event.

Prepare input and target for each track and store it.

Reimplemented from Module.

Definition at line 233 of file GRLNeuroTrainerModule.cc.

 {
   //inputs and outputs
   std::vector<float> input;
   std::vector<float> output;
  
   std::vector<float> cdc2d_phi;
   std::vector<float> cdc2d_pt;
  
   //GRL input
   StoreObjPtr<TRGGRLUnpackerStore> GRLStore(m_GRLCollectionName);
   int n_cdcf = 0;
   int n_cdcs = 0;
   int n_cdci = 0;
   int n_cdc = 0;
   int map_cdcf[36];
   int map_cdcs[36];
   int map_cdci[36];
   for (int i = 0; i < 36; i++) {
     map_cdcf[i] = 0;
     map_cdcs[i] = 0;
     map_cdci[i] = 0;
   }
  
   //full track
   for (int i = 0; i < 36; i++) {
     if (GRLStore->get_phi_CDC(i)) {
       map_cdcf[i] = 1;
     }
   }
  
   //short track
   for (int i = 0; i < 64; i++) {
     if (GRLStore->get_map_ST2(i)) {
       int j = i * (36. / 64.);
       map_cdcs[j] = 1;
     }
   }
  
   //inner track
   for (int i = 0; i < 64; i++) {
     if (GRLStore->get_map_TSF0(i)) {
       int j = i * (36. / 64.);
       int j1 = i - 4;
       if (j1 < 0) j1 = j1 + 64;
       int j2 = i - 3;
       if (j2 < 0) j2 = j2 + 64;
       int j3 = i - 2;
       if (j3 < 0) j3 = j3 + 64;
       int j4 = i - 1;
       if (j4 < 0) j4 = j4 + 64;
       int j5 = i;
       int j6 = i + 1;
       if (j6 > 63) j6 = j6 - 64;
       int j7 = i + 2;
       if (j7 > 63) j7 = j7 - 64;
       if (
         (GRLStore->get_map_TSF1(j1) || GRLStore->get_map_TSF1(j2) || GRLStore->get_map_TSF1(j3) || GRLStore->get_map_TSF1(j4)
          || GRLStore->get_map_TSF1(j5))
         &&
         (GRLStore->get_map_TSF2(j3) || GRLStore->get_map_TSF2(j4) || GRLStore->get_map_TSF2(j5) || GRLStore->get_map_TSF2(j6)
          || GRLStore->get_map_TSF2(j7))
       )
         map_cdci[j] = 1;
     }
   }
  
   //avoid overlap
   for (int i = 0; i < 36; i++) {
     if (map_cdcf[i] == 1) {
       int i1 = i - 2;
       if (i1 < 0) i1 = i1 + 36;
       int i2 = i - 1;
       if (i2 < 0) i2 = i2 + 36;
       int i3 = i;
       int i4 = i + 1;
       // cppcheck-suppress knownConditionTrueFalse
       if (i4 > 36) i4 = i4 - 36;
       int i5 = i + 2;
       if (i5 > 36) i5 = i5 - 36;
       //map_cdcs[i1]=0;
       map_cdcs[i2] = 0;
       map_cdcs[i3] = 0;
       map_cdcs[i4] = 0;
       //map_cdcs[i5]=0;
       //map_cdci[i1]=0;
       map_cdci[i2] = 0;
       map_cdci[i3] = 0;
       map_cdci[i4] = 0;
       //map_cdci[i5]=0;
     }
   }
   for (int i = 0; i < 36; i++) {
     if (map_cdcs[i] == 1) {
       int i1 = i - 2;
       if (i1 < 0) i1 = i1 + 36;
       int i2 = i - 1;
       if (i2 < 0) i2 = i2 + 36;
       int i3 = i;
       int i4 = i + 1;
       // cppcheck-suppress knownConditionTrueFalse
       if (i4 > 36) i4 = i4 - 36;
       int i5 = i + 2;
       if (i5 > 36) i5 = i5 - 36;
       //map_cdci[i1]=0;
       map_cdci[i2] = 0;
       map_cdci[i3] = 0;
       map_cdci[i4] = 0;
       //map_cdci[i5]=0;
     }
   }
  
   //for (int i = 0; i < 36; i++) {
   //  std::cout << map_cdcf[i] << " " ;
   //}
   //std::cout << std::endl;
   //for (int i = 0; i < 36; i++) {
   //  std::cout << map_cdcs[i] << " " ;
   //}
   //std::cout << std::endl;
   //for (int i = 0; i < 36; i++) {
   //  std::cout << map_cdci[i] << " " ;
   //}
   //std::cout << std::endl;
  
   //count
   for (int i = 0; i < 36; i++) {
     if (map_cdcf[i] == 1) {n_cdcf++; n_cdc++;}
     if (map_cdcs[i] == 1) {n_cdcs++; n_cdc++;}
     if (map_cdci[i] == 1) {n_cdci++; n_cdc++;}
   }
  
   //input
   for (int i = 0; i < 36; i++) {
     input.push_back((map_cdcf[i] - 0.5) * 2);
   }
   for (int i = 0; i < 36; i++) {
     input.push_back((map_cdcs[i] - 0.5) * 2);
   }
   for (int i = 0; i < 36; i++) {
     input.push_back((map_cdci[i] - 0.5) * 2);
   }
  
   //ECL input
   //..Use only clusters within 100 ns of event timing (from ECL).
   StoreArray<TRGECLTrg> trgArray;
   StoreArray<TRGECLCluster> eclTrgClusterArray(m_TrgECLClusterName);
   int ntrgArray = trgArray.getEntries();
   double EventTiming = -9999.;
   if (ntrgArray > 0) {EventTiming = trgArray[0]->getEventTiming();}
   std::vector<int> selTC;
   std::vector<float> selTheta;
   std::vector<float> selPhi;
   std::vector<float> selE;
   for (int ic = 0; ic < eclTrgClusterArray.getEntries(); ic++) {
     double tcT = abs(eclTrgClusterArray[ic]->getTimeAve() - EventTiming);
     //if (tcT < 100.) {
     int TC = eclTrgClusterArray[ic]->getMaxTCId();
     selTC.push_back(TC);
     selTheta.push_back(TCcotThetaLab[TC - 1]);
     selPhi.push_back(TCPhiLab[TC - 1]);
     selE.push_back(eclTrgClusterArray[ic]->getEnergyDep() * 0.001);
     input.push_back(TCcotThetaLab[TC - 1] / TMath::Pi());
     input.push_back(TCPhiLab[TC - 1] / TMath::Pi());
     input.push_back((eclTrgClusterArray[ic]->getEnergyDep() * 0.001 - 3.5) / 3.5);
     //}
     B2DEBUG(50, "InputECL " << ic << " " << tcT << " " << TC << " " << TCcotThetaLab[TC - 1] << " " << TCPhiLab[TC - 1] << " " <<
             eclTrgClusterArray[ic]->getEnergyDep() << " " << EventTiming);
   }
  
   //output
   bool accepted_signal = false;
   bool accepted_bg     = false;
   bool accepted_hadron = false;
   bool accepted_filter = false;
   bool accepted_bhabha = false;
   StoreObjPtr<SoftwareTriggerResult> result_soft;
   if (result_soft.isValid()) {
     const std::map<std::string, int>& skim_map = result_soft->getResults();
     if (skim_map.find("software_trigger_cut&skim&accept_hadronb2") != skim_map.end()) {
       accepted_hadron = (result_soft->getResult("software_trigger_cut&skim&accept_hadronb2") == SoftwareTriggerCutResult::c_accept);
     }
     if (skim_map.find("software_trigger_cut&filter&total_result") != skim_map.end()) {
       accepted_filter = (result_soft->getResult("software_trigger_cut&filter&total_result") == SoftwareTriggerCutResult::c_accept);
     }
     if (skim_map.find("software_trigger_cut&skim&accept_bhabha") != skim_map.end()) {
       accepted_bhabha = (result_soft->getResult("software_trigger_cut&skim&accept_bhabha") == SoftwareTriggerCutResult::c_accept);
     }
   }
  
   accepted_signal = accepted_hadron && accepted_filter;
   accepted_bg     = !accepted_filter;
  
   //input and output for NN training
   int cdc_sector = cdc2d_phi.size();
   int ecl_sector = selTC.size();
   int isector = cdc_sector * n_ecl_sector + ecl_sector;
   B2DEBUG(50, "Input " << cdc_sector << " " << ecl_sector << " " << accepted_signal << " " << accepted_bg);
   if (accepted_signal
       && !accepted_filter)B2DEBUG(50, "Input " << cdc_sector << " " << ecl_sector << " " << accepted_signal << " " << accepted_filter <<
                                     " " << accepted_bhabha);
  
   if (accepted_signal) {
     output.push_back(1);
   } else if (accepted_bg) {
     scale_bg[isector]++;
     if (isector == 3) {
       if (scale_bg[isector] == 100) {
         output.push_back(-1);
         scale_bg[isector] = 1;
       } else return;
     }
     if (isector == 4) {
       if (scale_bg[isector] == 5) {
         output.push_back(-1);
         scale_bg[isector] = 1;
       } else return;
     } else {
       output.push_back(-1);
     }
   } else {
     return;
   }
  
  
  
   if (cdc_sector < n_cdc_sector && ecl_sector < n_ecl_sector) {
     m_trainSets[isector].addSample(input, output);
     if (m_saveDebug) {
       if (accepted_signal) {
         for (int i = 0; i < cdc_sector; i++)     h_cdc2d_phi_sig[isector]->Fill(cdc2d_phi[i]);
         for (int i = 0; i < cdc_sector; i++)     h_cdc2d_pt_sig[isector]->Fill(cdc2d_pt[i]);
         for (int i = 0; i < ecl_sector; i++)     h_selTheta_sig[isector]->Fill(selTheta[i]);
         for (int i = 0; i < ecl_sector; i++)     h_selPhi_sig[isector]->Fill(selPhi[i]);
         for (int i = 0; i < ecl_sector; i++)     h_selE_sig[isector]->Fill(selE[i]);
         h_ncdcf_sig[0]->Fill(n_cdcf);
         h_ncdcs_sig[0]->Fill(n_cdcs);
         h_ncdci_sig[0]->Fill(n_cdci);
         h_ncdc_sig[0]->Fill(n_cdc);
         h_necl_sig[0]->Fill(ecl_sector);
       } else if (accepted_bg) {
         for (int i = 0; i < cdc_sector; i++)     h_cdc2d_phi_bg[isector]->Fill(cdc2d_phi[i]);
         for (int i = 0; i < cdc_sector; i++)     h_cdc2d_pt_bg[isector]->Fill(cdc2d_pt[i]);
         for (int i = 0; i < ecl_sector; i++)     h_selTheta_bg[isector]->Fill(selTheta[i]);
         for (int i = 0; i < ecl_sector; i++)     h_selPhi_bg[isector]->Fill(selPhi[i]);
         for (int i = 0; i < ecl_sector; i++)     h_selE_bg[isector]->Fill(selE[i]);
         h_ncdcf_bg[0]->Fill(n_cdcf);
         h_ncdcs_bg[0]->Fill(n_cdcs);
         h_ncdci_bg[0]->Fill(n_cdci);
         h_ncdc_bg[0]->Fill(n_cdc);
         h_necl_bg[0]->Fill(ecl_sector);
       }
     }
   }
 }

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

Initialize the networks and register datastore objects.

Reimplemented from Module.

Definition at line 141 of file GRLNeuroTrainerModule.cc.

◆ loadTraindata()

bool loadTraindata	(	const std::string &	filename,
		const std::string &	arrayname = `"trainSets"`
	)

Load saved training samples.

Parameters

filename	name of the TFile to read from
arrayname	name of the TObjArray holding the training samples in the file

Returns: true if the training sets were loaded correctly

◆ saveTraindata()

void saveTraindata	(	const std::string &	filename,
		const std::string &	arrayname = `"trainSets"`
	)

Save all training samples.

Parameters

filename	name of the TFile to write to
arrayname	name of the TObjArray holding the training samples in the file

Definition at line 653 of file GRLNeuroTrainerModule.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.

Member Data Documentation

◆ m_checkInterval

int m_checkInterval

protected

Training is stopped if validation error is higher than checkInterval epochs ago, i.e.

either the validation error is increasing or the gain is less than the fluctuations.

Definition at line 111 of file GRLNeuroTrainerModule.h.

◆ m_filename

std::string m_filename

protected

Name of file where network weights etc.

are stored after training.

Definition at line 79 of file GRLNeuroTrainerModule.h.

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

trg/grl/modules/trggrlneuralnet/include/GRLNeuroTrainerModule.h
trg/grl/modules/trggrlneuralnet/src/GRLNeuroTrainerModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

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

◆ initialize()

◆ loadTraindata()

◆ saveTraindata()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_checkInterval

◆ m_filename