Belle II Software release-09-00-00
SplitNMergeSimTask Class Reference
Inheritance diagram for SplitNMergeSimTask:
Collaboration diagram for SplitNMergeSimTask:

Public Member Functions

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

Static Public Attributes

b2luigi experiment_number = b2luigi.IntParameter()
 Experiment number of the conditions database, e.g.
 
b2luigi random_seed = b2luigi.Parameter()
 Random basf2 seed.
 
b2luigi n_events = b2luigi.IntParameter()
 Number of events to generate.
 
b2luigi bkgfiles_dir
 Directory with overlay background root files.
 
str queue = 'sx'
 specify 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 254 of file combined_to_pxd_ckf_mva_training.py.

Member Function Documentation

◆ output()

def 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 294 of file combined_to_pxd_ckf_mva_training.py.

294 def output(self):
295 """
296 Generate list of output files that the task should produce.
297 The task is considered finished if and only if the outputs all exist.
298 """
299 yield self.add_to_output(self.output_file_name())
300

◆ output_file_name()

def 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 280 of file combined_to_pxd_ckf_mva_training.py.

280 def output_file_name(self, n_events=None, random_seed=None):
281 """
282 Create output file name depending on number of events and production
283 mode that is specified in the random_seed string.
284
285 :param n_events: Number of events to simulate.
286 :param random_seed: Random seed to use for the simulation to create independent samples.
287 """
288 if n_events is None:
289 n_events = self.n_events
290 if random_seed is None:
291 random_seed = self.random_seed
292 return "generated_mc_N" + str(n_events) + "_" + random_seed + ".root"
293

◆ process()

def process (   self)
When all GenerateSimTasks finished, merge the output.

Definition at line 325 of file combined_to_pxd_ckf_mva_training.py.

325 def process(self):
326 """
327 When all GenerateSimTasks finished, merge the output.
328 """
329 create_output_dirs(self)
330
331 file_list = [item for sublist in self.get_input_file_names().values() for item in sublist]
332 print("Merge the following files:")
333 print(file_list)
334 cmd = ["b2file-merge", "-f"]
335 args = cmd + [self.get_output_file_name(self.output_file_name())] + file_list
336 subprocess.check_call(args)
337 print("Finished merging. Now remove the input files to save space.")
338 cmd2 = ["rm", "-f"]
339 for tempfile in file_list:
340 args = cmd2 + [tempfile]
341 subprocess.check_call(args)
342
343

◆ requires()

def requires (   self)
This task requires several GenerateSimTask to be finished so that he required number of events is created.

Definition at line 301 of file combined_to_pxd_ckf_mva_training.py.

301 def requires(self):
302 """
303 This task requires several GenerateSimTask to be finished so that he required number of events is created.
304 """
305 n_events_per_task = MainTask.n_events_per_task
306 quotient, remainder = divmod(self.n_events, n_events_per_task)
307 for i in range(quotient):
308 yield GenerateSimTask(
309 bkgfiles_dir=self.bkgfiles_dir,
310 num_processes=MainTask.num_processes,
311 random_seed=self.random_seed + '_' + str(i).zfill(3),
312 n_events=n_events_per_task,
313 experiment_number=self.experiment_number,
314 )
315 if remainder > 0:
316 yield GenerateSimTask(
317 bkgfiles_dir=self.bkgfiles_dir,
318 num_processes=MainTask.num_processes,
319 random_seed=self.random_seed + '_' + str(quotient).zfill(3),
320 n_events=remainder,
321 experiment_number=self.experiment_number,
322 )
323

Member Data Documentation

◆ bkgfiles_dir

b2luigi bkgfiles_dir
static
Initial value:
= b2luigi.Parameter(
)

Directory with overlay background root files.

Definition at line 271 of file combined_to_pxd_ckf_mva_training.py.

◆ experiment_number

b2luigi experiment_number = b2luigi.IntParameter()
static

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 264 of file combined_to_pxd_ckf_mva_training.py.

◆ n_events

b2luigi n_events = b2luigi.IntParameter()
static

Number of events to generate.

Definition at line 269 of file combined_to_pxd_ckf_mva_training.py.

◆ queue

str queue = 'sx'
static

specify queue.

E.g. choose between 'l' (long), 's' (short) or 'sx' (short, extra ram)

Definition at line 277 of file combined_to_pxd_ckf_mva_training.py.

◆ random_seed

b2luigi 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 267 of file combined_to_pxd_ckf_mva_training.py.


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