SplitNMergeSimTask Class Reference

Inheritance 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 257 of file combined_cdc_to_svd_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 296 of file combined_cdc_to_svd_ckf_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()

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 282 of file combined_cdc_to_svd_ckf_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()

def process

(

self

)

When all GenerateSimTasks finished, merge the output.

Definition at line 327 of file combined_cdc_to_svd_ckf_mva_training.py.

    def process(self):
        """
        When all GenerateSimTasks finished, merge the output.
        """
        create_output_dirs(self)
 
        file_list = [item for sublist in self.get_input_file_names().values() for item in sublist]
        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)
        print("Finished merging. Now remove the input files to save space.")
        for input_file in file_list:
            try:
                os.remove(input_file)
            except FileNotFoundError:
                pass
 
 

requires()

def requires

(

self

)

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

Definition at line 303 of file combined_cdc_to_svd_ckf_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 = MainTask.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=MainTask.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=MainTask.num_processes,
                random_seed=self.random_seed + '_' + str(quotient).zfill(3),
                n_events=remainder,
                experiment_number=self.experiment_number,
                )
 

Member Data Documentation

bkgfiles_dir

b2luigi bkgfiles_dir

static

Initial value:

=  b2luigi.Parameter(
        
 
 
    )

Directory with overlay background root files.

Definition at line 273 of file combined_cdc_to_svd_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 266 of file combined_cdc_to_svd_ckf_mva_training.py.

n_events

b2luigi n_events = b2luigi.IntParameter()

static

Number of events to generate.

Definition at line 271 of file combined_cdc_to_svd_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 279 of file combined_cdc_to_svd_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 269 of file combined_cdc_to_svd_ckf_mva_training.py.

---

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

• tracking/scripts/ckf_training/cdc_to_svd_spacepoint/combined_cdc_to_svd_ckf_mva_training.py