Belle II Software  release-05-01-25
TrackQEEvaluationBaseTask Class Reference
Inheritance diagram for TrackQEEvaluationBaseTask:
Collaboration diagram for TrackQEEvaluationBaseTask:

Public Member Functions

TrackQETeacherBaseTask teacher_task (self)
 
Basf2PathTask data_collection_task (self)
 
def task_acronym (self)
 
def requires (self)
 
def output (self)
 
def run (self)
 

Static Public Attributes

 git_hash = b2luigi.Parameter(default=get_basf2_git_hash())
 Use git hash / release of basf2 version as additional luigi parameter. More...
 
 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. More...
 
 process_type = b2luigi.Parameter(default="BBBAR")
 Define which kind of process shall be used. More...
 
 training_target = b2luigi.Parameter(default="truth")
 Feature/variable to use as truth label in the quality estimator MVA classifier.
 
 exclude_variables = b2luigi.ListParameter(hashed=True)
 List of collected variables to not use in the training of the QE MVA classifier. More...
 
 fast_bdt_option = b2luigi.ListParameter(hashed=True, default=[200, 8, 3, 0.1])
 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 1568 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 1610 of file combined_quality_estimator_teacher.py.

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

◆ requires()

def requires (   self)
Generate list of luigi Tasks that this Task depends on.

Reimplemented in RecoTrackQEEvaluationTask.

Definition at line 1628 of file combined_quality_estimator_teacher.py.

◆ run()

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.

Definition at line 1667 of file combined_quality_estimator_teacher.py.

◆ task_acronym()

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

Definition at line 1620 of file combined_quality_estimator_teacher.py.

◆ teacher_task()

TrackQETeacherBaseTask teacher_task (   self)
Property defining specific teacher task to require.

Definition at line 1601 of file combined_quality_estimator_teacher.py.

Member Data Documentation

◆ exclude_variables

exclude_variables = b2luigi.ListParameter(hashed=True)
static

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

◆ git_hash

git_hash = b2luigi.Parameter(default=get_basf2_git_hash())
static

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

◆ process_type

process_type = b2luigi.Parameter(default="BBBAR")
static

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


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