Belle II Software development
GenerateSimTask Class Reference
Inheritance diagram for GenerateSimTask:
LSFTask

Public Member Functions

 output_file_name (self, n_events=None, random_seed=None)
 Name of the ROOT output file with generated and simulated events.
 
 output (self)
 
 create_path (self)
 
 remove_output (self)
 

Public Attributes

 job_name = self.task_id
 set the job name (inherited variable)
 

Static Public Attributes

 experiment_number = b2luigi.IntParameter()
 Experiment number of the conditions database, e.g.
 
 n_events = b2luigi.IntParameter()
 Number of events to generate.
 
 random_seed = b2luigi.Parameter()
 Random basf2 seed.
 
 bkgfiles_dir
 Directory with overlay background root files.
 
str batch_system = 'lsf'
 batch system
 
str queue = 's'
 queue
 

Detailed Description

Generate simulated Monte Carlo with background overlay.

Make sure to use different ``random_seed`` parameters for the training data
format the classifier trainings and for the test data for the respective
evaluation/validation tasks.

Definition at line 197 of file cdc_and_svd_ckf_merger_mva_training.py.

Member Function Documentation

◆ create_path()

create_path ( self)
Create basf2 path to process with event generation and simulation.

Definition at line 242 of file cdc_and_svd_ckf_merger_mva_training.py.

242 def create_path(self):
243 """
244 Create basf2 path to process with event generation and simulation.
245 """
246 basf2.set_random_seed(self.random_seed)
247 path = basf2.create_path()
248 path.add_module(
249 "EventInfoSetter", evtNumList=[self.n_events], runList=[0], expList=[self.experiment_number]
250 )
251 path.add_module("EvtGenInput")
252 bkg_files = ""
253 # \cond suppress doxygen warning
254 if self.experiment_number == 0:
256 else:
257 bkg_files = background.get_background_files(self.bkgfiles_dir)
258 # \endcond
259
260 simulation.add_simulation(path, bkgfiles=bkg_files, bkgOverlay=True, usePXDDataReduction=False)
261
262 path.add_module(
263 "RootOutput",
264 outputFileName=self.get_output_file_name(self.output_file_name()),
265 )
266 return path
267
get_background_files(folder=None, output_file_info=True)
Definition background.py:17
add_simulation(path, components=None, bkgfiles=None, bkgOverlay=True, forceSetPXDDataReduction=False, usePXDDataReduction=True, cleanupPXDDataReduction=True, generate_2nd_cdc_hits=False, simulateT0jitter=True, isCosmics=False, FilterEvents=False, usePXDGatedMode=False, skipExperimentCheckForBG=False, save_slow_pions_in_mc=False, save_all_charged_particles_in_mc=False)

◆ output()

output ( self)
Generate list of output files that the task should produce.
The task is considered finished if and only if the outputs all exist.

Definition at line 235 of file cdc_and_svd_ckf_merger_mva_training.py.

235 def output(self):
236 """
237 Generate list of output files that the task should produce.
238 The task is considered finished if and only if the outputs all exist.
239 """
240 yield self.add_to_output(self.output_file_name())
241

◆ output_file_name()

output_file_name ( self,
n_events = None,
random_seed = None )

Name of the ROOT output file with generated and simulated events.

Create output file name depending on number of events and production
mode that is specified in the random_seed string.

:param n_events: Number of events to simulate.
:param random_seed: Random seed to use for the simulation to create independent samples.

Definition at line 221 of file cdc_and_svd_ckf_merger_mva_training.py.

221 def output_file_name(self, n_events=None, random_seed=None):
222 """
223 Create output file name depending on number of events and production
224 mode that is specified in the random_seed string.
225
226 :param n_events: Number of events to simulate.
227 :param random_seed: Random seed to use for the simulation to create independent samples.
228 """
229 if n_events is None:
230 n_events = self.n_events
231 if random_seed is None:
232 random_seed = self.random_seed
233 return "generated_mc_N" + str(n_events) + "_" + random_seed + ".root"
234

◆ remove_output()

remove_output ( self)
Default function from base b2luigi.Task class.

Definition at line 268 of file cdc_and_svd_ckf_merger_mva_training.py.

268 def remove_output(self):
269 """
270 Default function from base b2luigi.Task class.
271 """
272 self._remove_output()
273
274
275# I don't use the default MergeTask or similar because they only work if every input file is called the same.
276# Additionally, I want to add more features like deleting the original input to save storage space.

Member Data Documentation

◆ batch_system

str batch_system = 'lsf'
staticinherited

batch system

Definition at line 177 of file cdc_and_svd_ckf_merger_mva_training.py.

◆ bkgfiles_dir

bkgfiles_dir
static
Initial value:
= b2luigi.Parameter(
)

Directory with overlay background root files.

Definition at line 214 of file cdc_and_svd_ckf_merger_mva_training.py.

◆ experiment_number

experiment_number = b2luigi.IntParameter()
static

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 207 of file cdc_and_svd_ckf_merger_mva_training.py.

◆ job_name

job_name = self.task_id
inherited

set the job name (inherited variable)

Definition at line 185 of file cdc_and_svd_ckf_merger_mva_training.py.

◆ n_events

n_events = b2luigi.IntParameter()
static

Number of events to generate.

Definition at line 209 of file cdc_and_svd_ckf_merger_mva_training.py.

◆ queue

str queue = 's'
staticinherited

queue

Definition at line 179 of file cdc_and_svd_ckf_merger_mva_training.py.

◆ random_seed

random_seed = b2luigi.Parameter()
static

Random basf2 seed.

It is further used to read of the production process to preserve clearness in the b2luigi output.

Definition at line 212 of file cdc_and_svd_ckf_merger_mva_training.py.


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