Inheritance diagram for CDCQEHarvestingValidationTask:

Public Member Functions
	requires (self)

	add_tracking_with_quality_estimation (self, path)

TrackQETeacherBaseTask	teacher_task (self)

	output (self)

	create_path (self)

Static Public Attributes
	training_target = b2luigi.Parameter()
	Feature/variable to use as truth label in the quality estimator MVA classifier.

	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.

# USESIM and USEREC	process_type
	Define which kind of process shall be used.

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

	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.

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

str	cdc_training_target = "truth"
	Feature/variable to use as truth label for the CDC track quality estimator.

Detailed Description

Run CDC reconstruction and write out (="harvest") a root file with variables
useful for validation of the CDC Quality Estimator.

Definition at line 1711 of file combined_quality_estimator_teacher.py.

Member Function Documentation

◆ add_tracking_with_quality_estimation()

add_tracking_with_quality_estimation	(		self,
			path )

Add modules for CDC standalone tracking with CDC quality estimator to basf2 path.

Reimplemented from HarvestingValidationBaseTask.

Definition at line 1754 of file combined_quality_estimator_teacher.py.

    def add_tracking_with_quality_estimation(self, path):
        """
        Add modules for CDC standalone tracking with CDC quality estimator to basf2 path.
        """
        add_cdc_track_finding(
            path,
            output_reco_tracks="RecoTracks",
            add_mva_quality_indicator=True,
        )
        # change weightfile of quality estimator to the one produced by this training script
        basf2.conditions.prepend_testing_payloads("localdb/database.txt")
        cdc_qe_mva_filter_parameters = {
            "identifier": self.get_input_file_names(
                CDCQETeacherTask.get_weightfile_identifier(
                    CDCQETeacherTask,
                    fast_bdt_option=self.fast_bdt_option) + '.xml')[0],
            'DBPayloadName': 'trackfindingcdc_TrackQualityEstimatorParameters'}
 
        name = 'TrackingMVAFilterParameters'
        cdc_qe_mva_filter_parameters = {'DBPayloadName': name}
        basf2.set_module_parameters(
            path,
            name="TFCDC_TrackQualityEstimator",
            filterParameters=cdc_qe_mva_filter_parameters,
            deactivateIfDeadBoard=False,  # original behavior before deactivateIfDeadBoard was introduced
        )
        tracking.add_mc_matcher(path, components=["CDC"], relate_tracks_to_mcparticles=False)
        add_track_fit_and_track_creator(path, components=["CDC"])
 
 

◆ create_path()

create_path ( self )

inherited

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

Definition at line 1604 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.
        """
        basf2.conditions.prepend_testing_payloads("localdb/database.txt")
        # 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()

output ( self )

inherited

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 1596 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()

requires ( self )

Generate list of luigi Tasks that this Task depends on.

Reimplemented from HarvestingValidationBaseTask.

Definition at line 1726 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,
        )
        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 )

inherited

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

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

◆ cdc_training_target

str cdc_training_target = "truth"

staticinherited

Feature/variable to use as truth label for the CDC track quality estimator.

Definition at line 1552 of file combined_quality_estimator_teacher.py.

◆ components

components = None

staticinherited

Components for the MC matching and track fit creation.

Definition at line 1550 of file combined_quality_estimator_teacher.py.

◆ exclude_variables

exclude_variables

staticinherited

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

◆ experiment_number

experiment_number = b2luigi.IntParameter()

staticinherited

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 1523 of file combined_quality_estimator_teacher.py.

◆ fast_bdt_option

fast_bdt_option

staticinherited

Initial value:

=  b2luigi.ListParameter(
        
    )

Hyperparameter option of the FastBDT algorithm.

default are the FastBDT default values.

Definition at line 1540 of file combined_quality_estimator_teacher.py.

◆ n_events_testing

n_events_testing = b2luigi.IntParameter()

staticinherited

Number of events to generate for the test data set.

Definition at line 1519 of file combined_quality_estimator_teacher.py.

◆ n_events_training

n_events_training = b2luigi.IntParameter()

staticinherited

Number of events to generate for the training data set.

Definition at line 1521 of file combined_quality_estimator_teacher.py.

◆ process_type

# USESIM and USEREC process_type

staticinherited

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

◆ reco_output_file_name

reco_output_file_name = "reconstruction.root"

staticinherited

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

Definition at line 1548 of file combined_quality_estimator_teacher.py.

◆ training_target

training_target = b2luigi.Parameter()

static

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

Definition at line 1717 of file combined_quality_estimator_teacher.py.

◆ validation_output_file_name

validation_output_file_name = "harvesting_validation.root"

staticinherited

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

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

◆ cdc_training_target

◆ components

◆ exclude_variables

◆ experiment_number

◆ fast_bdt_option

◆ n_events_testing

◆ n_events_training

◆ process_type

◆ reco_output_file_name

◆ training_target

◆ validation_output_file_name