Inheritance diagram for TrackQEEvaluationBaseTask:

Public Member Functions
TrackQETeacherBaseTask	teacher_task (self)
	Teacher task to require to provide a quality estimator weightfile for `add_tracking_with_quality_estimation`

Basf2PathTask	data_collection_task (self)

	task_acronym (self)

	requires (self)

	output (self)

	run (self)

Public Attributes
	teacher_task = None
	Task that is required by the evaluation base class to create the MVA weightfile that needs to be evaluated.

Static Public Attributes
	git_hash
	Use git hash / release of basf2 version as additional luigi parameter.

	n_events_testing = b2luigi.IntParameter()
	Number of events to generate for the test data set.

	n_events_training = b2luigi.IntParameter()
	Number of events to generate for the training data set.

	experiment_number = b2luigi.IntParameter()
	Experiment number of the conditions database, e.g.

	process_type
	Define which kind of process shall be used.

	training_target
	Feature/variable to use as truth label in the quality estimator MVA classifier.

	exclude_variables
	List of collected variables to not use in the training of the QE MVA classifier.

	fast_bdt_option
	Hyperparameter options for the FastBDT algorithm.

Detailed Description

Base class for evaluating a quality estimator ``basf2_mva_evaluate.py`` on a
separate test data set.

Evaluation tasks for VXD, CDC and combined QE can inherit from it.

Definition at line 1878 of file combined_quality_estimator_teacher.py.

Member Function Documentation

◆ data_collection_task()

Basf2PathTask data_collection_task ( self )

Property defining the specific ``DataCollectionTask`` to require.  Must
implemented by the inheriting specific teacher task class.

Definition at line 1941 of file combined_quality_estimator_teacher.py.

    def data_collection_task(self) -> Basf2PathTask:
        """
        Property defining the specific ``DataCollectionTask`` to require.  Must
        implemented by the inheriting specific teacher task class.
        """
        raise NotImplementedError(
            "Evaluation Tasks must define a data collection task to require "
        )
 

◆ 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 2002 of file combined_quality_estimator_teacher.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.
        """
        weightfile_details = create_fbdt_option_string(self.fast_bdt_option)
        evaluation_pdf_output = self.teacher_task.weightfile_identifier_basename + weightfile_details + ".zip"
        yield self.add_to_output(evaluation_pdf_output)
 

◆ requires()

requires ( self )

Generate list of luigi Tasks that this Task depends on.

Reimplemented in RecoTrackQEEvaluationTask.

Definition at line 1959 of file combined_quality_estimator_teacher.py.

    def requires(self):
        """
        Generate list of luigi Tasks that this Task depends on.
        """
        yield self.teacher_task(
            n_events_training=self.n_events_training,
            experiment_number=self.experiment_number,
            process_type=self.process_type,
            training_target=self.training_target,
            exclude_variables=self.exclude_variables,
            fast_bdt_option=self.fast_bdt_option,
        )
 
        # Reconstruct output file path
        weightfile_details = create_fbdt_option_string(self.fast_bdt_option)
        output_basename = self.teacher_task.weightfile_identifier_basename + weightfile_details + ".zip"
        output_path = self.get_output_file_name(output_basename)
 
        # Delete the output file if it exists so that the script does not think
        # that it ran succesfully if no new file is created
        if os.path.exists(output_path):
            try:
                os.remove(output_path)
                print(f"[INFO] Cleared folder of old file: {output_path}")
            except Exception as e:
                print(f"[WARNING] Failed to remove output file {output_path}: {e}")
        if 'USEREC' in self.process_type:
            if 'USERECBB' in self.process_type:
                process = 'BBBAR'
            elif 'USERECEE' in self.process_type:
                process = 'BHABHA'
            yield CheckExistingFile(
                filename='datafiles/qe_records_N' + str(self.n_events_testing) + '_' + process + '_test_' +
                         self.task_acronym + '.root'
                )
        else:
            yield self.data_collection_task(
                num_processes=MasterTask.num_processes,
                n_events=self.n_events_testing,
                experiment_number=self.experiment_number,
                random_seed=self.process_type + '_test',
                )
 

◆ run()

run ( self )

Run ``basf2_mva_evaluate.py`` subprocess to evaluate QE MVA.

The MVA weight file created from training on the training data set is
evaluated on separate test data.

Definition at line 2011 of file combined_quality_estimator_teacher.py.

    def run(self):
        """
        Run ``basf2_mva_evaluate.py`` subprocess to evaluate QE MVA.
 
        The MVA weight file created from training on the training data set is
        evaluated on separate test data.
        """
        weightfile_details = create_fbdt_option_string(self.fast_bdt_option)
        evaluation_pdf_output_basename = self.teacher_task.weightfile_identifier_basename + weightfile_details + ".zip"
        evaluation_pdf_output_path = self.get_output_file_name(evaluation_pdf_output_basename)
 
        if 'USEREC' in self.process_type:
            if 'USERECBB' in self.process_type:
                process = 'BBBAR'
            elif 'USERECEE' in self.process_type:
                process = 'BHABHA'
            datafiles = 'datafiles/qe_records_N' + str(self.n_events_testing) + '_' + \
                process + '_test_' + self.task_acronym + '.root'
        else:
            datafiles = self.get_input_file_names(
                self.data_collection_task.get_records_file_name(
                    self.data_collection_task,
                    n_events=self.n_events_testing,
                    random_seed=self.process_type + '_test_' +
                    self.task_acronym))[0]
        teacher_task = None
        for req in b2luigi.task.flatten(self.requires()):
            if isinstance(req, self.teacher_task):
                teacher_task = req
                break
        if hasattr(teacher_task, 'recotrack_option') and isinstance(self, RecoTrackQEEvaluationTask):
            records_files = teacher_task.get_input_file_names(
                self.data_collection_task.get_records_file_name(
                    self.data_collection_task,
                    n_events=self.n_events_training,
                    random_seed=self.process_type + '_' + teacher_task.random_seed,
                    recotrack_option=teacher_task.recotrack_option))
        else:
            records_files = teacher_task.get_input_file_names(
                self.data_collection_task.get_records_file_name(
                    self.data_collection_task,
                    n_events=self.n_events_training,
                    random_seed=self.process_type + '_' + teacher_task.random_seed))
        cmd = [
            "basf2_mva_evaluate.py",
            "--identifiers",
            self.get_input_file_names(
                self.teacher_task.get_weightfile_identifier(
                    self.teacher_task,
                    fast_bdt_option=self.fast_bdt_option) + '.xml')[0],
            "--train_datafiles",
            records_files[0],
            "--datafiles",
            datafiles,
            "--treename",
            self.teacher_task.tree_name,
            "--outputfile",
            evaluation_pdf_output_path
        ]
        print(
            'The weightfile for QE Evaluate is:',
            self.get_input_file_names(
                self.teacher_task.get_weightfile_identifier(
                    
                    self.teacher_task,
                    fast_bdt_option=self.fast_bdt_option) +
                '.xml')[0])
 
        subprocess.run(cmd, check=True)  # code to actually run the basf2_mva_evaluate.py process
 
 

◆ task_acronym()

task_acronym ( self )

Acronym to distinguish between cdc, vxd and rec(o) MVA

Definition at line 1951 of file combined_quality_estimator_teacher.py.

    def task_acronym(self):
        """
        Acronym to distinguish between cdc, vxd and rec(o) MVA
        """
        raise NotImplementedError(
            "Evaluation Tasks must define a task acronym."
        )
 

◆ teacher_task()

TrackQETeacherBaseTask teacher_task ( self )

Teacher task to require to provide a quality estimator weightfile for add_tracking_with_quality_estimation

Property defining specific teacher task to require.

Definition at line 1932 of file combined_quality_estimator_teacher.py.

    def teacher_task(self) -> TrackQETeacherBaseTask:
        """
        Property defining specific teacher task to require.
        """
        raise NotImplementedError(
            "Evaluation Tasks must define a teacher task to require "
        )
 

Member Data Documentation

◆ exclude_variables

exclude_variables

static

Initial value:

=  b2luigi.ListParameter(
        
    )

List of collected variables to not use in the training of the QE MVA classifier.

In addition to variables containing the "truth" substring, which are excluded by default.

Definition at line 1918 of file combined_quality_estimator_teacher.py.

◆ experiment_number

experiment_number = b2luigi.IntParameter()

static

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 1901 of file combined_quality_estimator_teacher.py.

◆ fast_bdt_option

fast_bdt_option

static

Initial value:

=  b2luigi.ListParameter(
        
    )

Hyperparameter options for the FastBDT algorithm.

Definition at line 1924 of file combined_quality_estimator_teacher.py.

◆ git_hash

git_hash

static

Initial value:

=  b2luigi.Parameter(
        
    )

Use git hash / release of basf2 version as additional luigi parameter.

This parameter is already set in all other tasks that inherit from Basf2Task. For this task, I decided against inheriting from Basf2Task because it already calls a subprocess and therefore does not need a dispatchable process method.

Definition at line 1891 of file combined_quality_estimator_teacher.py.

◆ n_events_testing

n_events_testing = b2luigi.IntParameter()

static

Number of events to generate for the test data set.

Definition at line 1897 of file combined_quality_estimator_teacher.py.

◆ n_events_training

n_events_training = b2luigi.IntParameter()

static

Number of events to generate for the training data set.

Definition at line 1899 of file combined_quality_estimator_teacher.py.

◆ process_type

process_type

static

Initial value:

=  b2luigi.Parameter(
        
    )

Define which kind of process shall be used.

Decide between simulating BBBAR or BHABHA, MUMU, YY, DDBAR, UUBAR, SSBAR, CCBAR, reconstructing DATA or already simulated files (USESIMBB/EE) or running on existing reconstructed files (USERECBB/EE)

Definition at line 1905 of file combined_quality_estimator_teacher.py.

◆ teacher_task

teacher_task = None

Task that is required by the evaluation base class to create the MVA weightfile that needs to be evaluated.

Definition at line 2038 of file combined_quality_estimator_teacher.py.

◆ training_target

training_target

static

Initial value:

=  b2luigi.Parameter(
        
    )

Feature/variable to use as truth label in the quality estimator MVA classifier.

Definition at line 1911 of file combined_quality_estimator_teacher.py.

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

tracking/scripts/tracking/train/combined_quality_estimator_teacher.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ data_collection_task()

◆ output()

◆ requires()

◆ run()

◆ task_acronym()

◆ teacher_task()

Member Data Documentation

◆ exclude_variables

◆ experiment_number

◆ fast_bdt_option

◆ git_hash

◆ n_events_testing

◆ n_events_training

◆ process_type

◆ teacher_task

◆ training_target