Belle II Software development
SplitNMergeSimTask Class Reference
Inheritance diagram for SplitNMergeSimTask:
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)
 
 requires (self)
 
 process (self)
 
 on_success (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.
 
 random_seed = b2luigi.Parameter()
 Random basf2 seed.
 
 n_events = b2luigi.IntParameter()
 Number of events to generate.
 
 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 289 of file combined_cdc_to_svd_ckf_mva_training.py.

Member Function Documentation

◆ on_success()

on_success ( self)
On success method.

Definition at line 370 of file combined_cdc_to_svd_ckf_mva_training.py.

370 def on_success(self):
371 """
372 On success method.
373 """
374 print("Finished merging. Now remove the input files to save space.")
375 file_list = [f for f in self.get_all_input_file_names()]
376 for input_file in file_list:
377 try:
378 os.remove(input_file)
379 except FileNotFoundError:
380 pass
381

◆ 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 326 of file combined_cdc_to_svd_ckf_mva_training.py.

326 def output(self):
327 """
328 Generate list of output files that the task should produce.
329 The task is considered finished if and only if the outputs all exist.
330 """
331 yield self.add_to_output(self.output_file_name())
332

◆ 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 312 of file combined_cdc_to_svd_ckf_mva_training.py.

312 def output_file_name(self, n_events=None, random_seed=None):
313 """
314 Create output file name depending on number of events and production
315 mode that is specified in the random_seed string.
316
317 :param n_events: Number of events to simulate.
318 :param random_seed: Random seed to use for the simulation to create independent samples.
319 """
320 if n_events is None:
321 n_events = self.n_events
322 if random_seed is None:
323 random_seed = self.random_seed
324 return "generated_mc_N" + str(n_events) + "_" + random_seed + ".root"
325

◆ process()

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

Definition at line 357 of file combined_cdc_to_svd_ckf_mva_training.py.

357 def process(self):
358 """
359 When all GenerateSimTasks finished, merge the output.
360 """
361 create_output_dirs(self)
362
363 file_list = [f for f in self.get_all_input_file_names()]
364 print("Merge the following files:")
365 print(file_list)
366 cmd = ["b2file-merge", "-f"]
367 args = cmd + [self.get_output_file_name(self.output_file_name())] + file_list
368 subprocess.check_call(args)
369

◆ remove_output()

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

Definition at line 382 of file combined_cdc_to_svd_ckf_mva_training.py.

382 def remove_output(self):
383 """
384 Default function from base b2luigi.Task class.
385 """
386 self._remove_output()
387
388

◆ requires()

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

Definition at line 333 of file combined_cdc_to_svd_ckf_mva_training.py.

333 def requires(self):
334 """
335 This task requires several GenerateSimTask to be finished so that he required number of events is created.
336 """
337 n_events_per_task = SummaryTask.n_events_per_task
338 quotient, remainder = divmod(self.n_events, n_events_per_task)
339 for i in range(quotient):
340 yield GenerateSimTask(
341 bkgfiles_dir=self.bkgfiles_dir,
342 num_processes=SummaryTask.num_processes,
343 random_seed=self.random_seed + '_' + str(i).zfill(3),
344 n_events=n_events_per_task,
345 experiment_number=self.experiment_number,
346 )
347 if remainder > 0:
348 yield GenerateSimTask(
349 bkgfiles_dir=self.bkgfiles_dir,
350 num_processes=SummaryTask.num_processes,
351 random_seed=self.random_seed + '_' + str(quotient).zfill(3),
352 n_events=remainder,
353 experiment_number=self.experiment_number,
354 )
355

Member Data Documentation

◆ batch_system

str batch_system = 'lsf'
staticinherited

batch system

Definition at line 189 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ bkgfiles_dir

bkgfiles_dir
static
Initial value:
= b2luigi.Parameter(
)

Directory with overlay background root files.

Definition at line 305 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ experiment_number

experiment_number = b2luigi.IntParameter()
static

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 298 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ job_name

job_name = self.task_id
inherited

set the job name (inherited variable)

Definition at line 197 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ n_events

n_events = b2luigi.IntParameter()
static

Number of events to generate.

Definition at line 303 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ queue

str queue = 's'
staticinherited

queue

Definition at line 191 of file combined_cdc_to_svd_ckf_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 301 of file combined_cdc_to_svd_ckf_mva_training.py.


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