Inheritance diagram for HarvestingValidationBaseTask:

Public Member Functions
TrackQETeacherBaseTask	teacher_task (self)

None	add_tracking_with_quality_estimation (self, basf2.Path path)

def	requires (self)

def	output (self)

def	create_path (self)

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

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

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

b2luigi	process_type
	Define which kind of process shall be used.

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

b2luigi	fast_bdt_option
	Hyperparameter option of the FastBDT algorithm.

str	validation_output_file_name = "harvesting_validation.root"
	Name of the "harvested" ROOT output file with variables that can be used for validation.

str	reco_output_file_name = "reconstruction.root"
	Name of the output of the RootOutput module with reconstructed events.

None	components = None
	Components for the MC matching and track fit creation.

Detailed Description

Run track reconstruction with MVA quality estimator and write out
(="harvest") a root file with variables useful for the validation.

Definition at line 1411 of file combined_quality_estimator_teacher.py.

Member Function Documentation

◆ add_tracking_with_quality_estimation()

None add_tracking_with_quality_estimation	(		self,
		basf2.Path	path
	)

Add modules for track reconstruction to basf2 path that are to be
validated.  Besides track finding it should include MC matching, fitted
track creation and a quality estimator module.

Reimplemented in VXDQEHarvestingValidationTask, CDCQEHarvestingValidationTask, and RecoTrackQEHarvestingValidationTask.

Definition at line 1458 of file combined_quality_estimator_teacher.py.

    def add_tracking_with_quality_estimation(self, path: basf2.Path) -> None:
        """
        Add modules for track reconstruction to basf2 path that are to be
        validated.  Besides track finding it should include MC matching, fitted
        track creation and a quality estimator module.
        """
        raise NotImplementedError()
 

◆ create_path()

def create_path ( self )

Create a basf2 path that uses ``add_tracking_with_quality_estimation()``
and adds the ``CombinedTrackingValidationModule`` to write out variables
for validation.

Definition at line 1501 of file combined_quality_estimator_teacher.py.

    def create_path(self):
        """
        Create a basf2 path that uses ``add_tracking_with_quality_estimation()``
        and adds the ``CombinedTrackingValidationModule`` to write out variables
        for validation.
        """
        # prepare track finding
        path = basf2.create_path()
        if 'USE' in self.process_type:
            if 'BB' in self.process_type:
                process = 'BBBAR'
            elif 'EE' in self.process_type:
                process = 'BHABHA'
            inputFileNames = ['datafiles/generated_mc_N' + str(self.n_events_testing) + '_' + process + '_test.root']
        else:
            inputFileNames = self.get_input_file_names(GenerateSimTask.output_file_name(
                GenerateSimTask, n_events=self.n_events_testing, random_seed=self.process_type + '_test'))
        path.add_module(
            "RootInput",
            inputFileNames=inputFileNames,
        )
        path.add_module("Gearbox")
        tracking.add_geometry_modules(path)
        tracking.add_hit_preparation_modules(path)  # only needed for simulated hits
        # add track finding module that needs to be validated
        self.add_tracking_with_quality_estimation(path)
        # add modules for validation
        path.add_module(
            CombinedTrackingValidationModule(
                name=None,
                contact=None,
                expert_level=200,
                output_file_name=self.get_output_file_name(
                    self.validation_output_file_name
                ),
            )
        )
        path.add_module(
            "RootOutput",
            outputFileName=self.get_output_file_name(self.reco_output_file_name),
        )
        return path
 
 

◆ 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 1493 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.
        """
        yield self.add_to_output(self.validation_output_file_name)
        yield self.add_to_output(self.reco_output_file_name)
 

◆ requires()

def requires ( self )

Generate list of luigi Tasks that this Task depends on.

Reimplemented in CDCQEHarvestingValidationTask, and RecoTrackQEHarvestingValidationTask.

Definition at line 1466 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,
            exclude_variables=self.exclude_variables,
            fast_bdt_option=self.fast_bdt_option,
        )
        if 'USE' in self.process_type:  # USESIM and USEREC
            if 'BB' in self.process_type:
                process = 'BBBAR'
            elif 'EE' in self.process_type:
                process = 'BHABHA'
            yield CheckExistingFile(
                filename='datafiles/generated_mc_N' + str(self.n_events_testing) + '_' + process + '_test.root'
                )
        else:
            yield SplitNMergeSimTask(
                bkgfiles_dir=MasterTask.bkgfiles_by_exp[self.experiment_number],
                random_seed=self.process_type + '_test',
                n_events=self.n_events_testing,
                experiment_number=self.experiment_number,
                )
 

◆ teacher_task()

TrackQETeacherBaseTask teacher_task ( self )

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

Definition at line 1452 of file combined_quality_estimator_teacher.py.

    def teacher_task(self) -> TrackQETeacherBaseTask:
        """
        Teacher task to require to provide a quality estimator weightfile for ``add_tracking_with_quality_estimation``
        """
        raise NotImplementedError()
 

Member Data Documentation

◆ components

None components = None

static

Components for the MC matching and track fit creation.

Definition at line 1449 of file combined_quality_estimator_teacher.py.

◆ exclude_variables

b2luigi 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 1433 of file combined_quality_estimator_teacher.py.

◆ experiment_number

b2luigi experiment_number = b2luigi.IntParameter()

static

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 1422 of file combined_quality_estimator_teacher.py.

◆ fast_bdt_option

b2luigi fast_bdt_option

static

Initial value:

=  b2luigi.ListParameter(
        
    )

Hyperparameter option of the FastBDT algorithm.

default are the FastBDT default values.

Definition at line 1439 of file combined_quality_estimator_teacher.py.

◆ n_events_testing

b2luigi n_events_testing = b2luigi.IntParameter()

static

Number of events to generate for the test data set.

Definition at line 1418 of file combined_quality_estimator_teacher.py.

◆ n_events_training

b2luigi n_events_training = b2luigi.IntParameter()

static

Number of events to generate for the training data set.

Definition at line 1420 of file combined_quality_estimator_teacher.py.

◆ process_type

b2luigi 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 1426 of file combined_quality_estimator_teacher.py.

◆ reco_output_file_name

str reco_output_file_name = "reconstruction.root"

static

Name of the output of the RootOutput module with reconstructed events.

Definition at line 1447 of file combined_quality_estimator_teacher.py.

◆ validation_output_file_name

str validation_output_file_name = "harvesting_validation.root"

static

Name of the "harvested" ROOT output file with variables that can be used for validation.

Definition at line 1445 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

Static Public Attributes

Detailed Description

Member Function Documentation

◆ add_tracking_with_quality_estimation()

◆ create_path()

◆ output()

◆ requires()

◆ teacher_task()

Member Data Documentation

◆ components

◆ exclude_variables

◆ experiment_number

◆ fast_bdt_option

◆ n_events_testing

◆ n_events_training

◆ process_type

◆ reco_output_file_name

◆ validation_output_file_name