Inheritance diagram for SplitNMergeSimTask:

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.

	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 277 of file cdc_and_svd_ckf_merger_mva_training.py.

Member Function Documentation

◆ on_success()

on_success ( self )

On success method.

Definition at line 359 of file cdc_and_svd_ckf_merger_mva_training.py.

    def on_success(self):
        """
        On success method.
        """
        print("Finished merging. Now remove the input files to save space.")
        file_list = [f for f in self.get_all_input_file_names()]
        for input_file in file_list:
            try:
                os.remove(input_file)
            except FileNotFoundError:
                pass
 

◆ 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 315 of file cdc_and_svd_ckf_merger_mva_training.py.

    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.
        """
        yield self.add_to_output(self.output_file_name())
 

◆ 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 301 of file cdc_and_svd_ckf_merger_mva_training.py.

    def output_file_name(self, n_events=None, random_seed=None):
        """
        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.
        """
        if n_events is None:
            n_events = self.n_events
        if random_seed is None:
            random_seed = self.random_seed
        return "generated_mc_N" + str(n_events) + "_" + random_seed + ".root"
 

◆ process()

process ( self )

When all GenerateSimTasks finished, merge the output.

Definition at line 346 of file cdc_and_svd_ckf_merger_mva_training.py.

    def process(self):
        """
        When all GenerateSimTasks finished, merge the output.
        """
        create_output_dirs(self)
 
        file_list = [f for f in self.get_all_input_file_names()]
        print("Merge the following files:")
        print(file_list)
        cmd = ["b2file-merge", "-f"]
        args = cmd + [self.get_output_file_name(self.output_file_name())] + file_list
        subprocess.check_call(args)
 

◆ remove_output()

remove_output ( self )

Default function from base b2luigi.Task class.

Definition at line 371 of file cdc_and_svd_ckf_merger_mva_training.py.

    def remove_output(self):
        """
        Default function from base b2luigi.Task class.
        """
        self._remove_output()
 
 

◆ requires()

requires ( self )

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

Definition at line 322 of file cdc_and_svd_ckf_merger_mva_training.py.

    def requires(self):
        """
        This task requires several GenerateSimTask to be finished so that he required number of events is created.
        """
        n_events_per_task = SummaryTask.n_events_per_task
        quotient, remainder = divmod(self.n_events, n_events_per_task)
        for i in range(quotient):
            yield GenerateSimTask(
                bkgfiles_dir=self.bkgfiles_dir,
                num_processes=SummaryTask.num_processes,
                random_seed=self.random_seed + '_' + str(i).zfill(3),
                n_events=n_events_per_task,
                experiment_number=self.experiment_number,
                )
        if remainder > 0:
            yield GenerateSimTask(
                bkgfiles_dir=self.bkgfiles_dir,
                num_processes=SummaryTask.num_processes,
                random_seed=self.random_seed + '_' + str(quotient).zfill(3),
                n_events=remainder,
                experiment_number=self.experiment_number,
                )
 

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 294 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 287 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 289 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 292 of file cdc_and_svd_ckf_merger_mva_training.py.

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

tracking/scripts/ckf_training/cdc_and_svd_merger/cdc_and_svd_ckf_merger_mva_training.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ on_success()

◆ output()

◆ output_file_name()

◆ process()

◆ remove_output()

◆ requires()

Member Data Documentation

◆ batch_system

◆ bkgfiles_dir

◆ experiment_number

◆ job_name

◆ n_events

◆ queue

◆ random_seed