Belle II Software  release-08-01-10
Public Member Functions | Static Public Attributes | List of all members
VXDQETeacherTask Class Reference
Inheritance diagram for VXDQETeacherTask:
Inheritance graph
[legend]
Collaboration diagram for VXDQETeacherTask:
Collaboration graph
[legend]

Public Member Functions

def weightfile_identifier_basename (self)
 
def get_weightfile_xml_identifier (self, fast_bdt_option=None, recotrack_option=None)
 
def tree_name (self)
 
def random_seed (self)
 
Basf2PathTask data_collection_task (self)
 
def requires (self)
 
def output (self)
 
def process (self)
 

Static Public Attributes

string weightfile_identifier_basename = "vxdtf2_mva_qe"
 Name of the weightfile that is created.
 
string tree_name = "tree"
 Name of the TTree in the ROOT file from the data_collection_task that contains the training data for the MVA teacher.
 
string random_seed = "train_vxd"
 Random basf2 seed used to create the training data set.
 
 data_collection_task = VXDQEDataCollectionTask
 Defines DataCollectionTask to require by tha base class to collect features for the MVA training.
 
 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
 Define which kind of process shall be used. More...
 
 training_target
 Feature/variable to use as truth label in the quality estimator MVA classifier. More...
 
 exclude_variables
 List of collected variables to not use in the training of the QE MVA classifier. More...
 
 fast_bdt_option
 Hyperparameter option of the FastBDT algorithm. More...
 

Detailed Description

Task to run basf2 mva teacher on collected data for VXDTF2 track quality estimator

Definition at line 1319 of file combined_quality_estimator_teacher.py.

Member Function Documentation

◆ data_collection_task()

Basf2PathTask data_collection_task (   self)
inherited 
Property defining the specific ``DataCollectionTask`` to require.  Must
implemented by the inheriting specific teacher task class.

Definition at line 1243 of file combined_quality_estimator_teacher.py.

◆ get_weightfile_xml_identifier()

def get_weightfile_xml_identifier (   self,
  fast_bdt_option = None,
  recotrack_option = None 
)
inherited 
Name of the xml weightfile that is created by the teacher task.
It is subsequently used as a local weightfile in the following validation tasks.

Definition at line 1207 of file combined_quality_estimator_teacher.py.

◆ output()

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

◆ process()

def process (   self)
inherited 
Use basf2_mva teacher to create MVA weightfile from collected training
data variables.

This is the main process that is dispatched by the ``run`` method that
is inherited from ``Basf2Task``.

Definition at line 1279 of file combined_quality_estimator_teacher.py.

◆ random_seed()

def random_seed (   self)
inherited 
Property defining random seed to be used by the ``GenerateSimTask``.
Should differ from the random seed in the test data samples.  Must
implemented by the inheriting specific teacher task class.

Definition at line 1234 of file combined_quality_estimator_teacher.py.

◆ requires()

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

Reimplemented in RecoTrackQETeacherTask.

Definition at line 1252 of file combined_quality_estimator_teacher.py.

◆ tree_name()

def tree_name (   self)
inherited 
Property defining the name of the tree in the ROOT file from the
``data_collection_task`` that contains the recorded training data.  Must
implemented by the inheriting specific teacher task class.

Definition at line 1225 of file combined_quality_estimator_teacher.py.

◆ weightfile_identifier_basename()

def weightfile_identifier_basename (   self)
inherited 
Property defining the basename for the .xml and .root weightfiles that are created.
Has to be implemented by the inheriting teacher task class.

Definition at line 1198 of file combined_quality_estimator_teacher.py.

Member Data Documentation

◆ 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 1187 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 1172 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 1192 of file combined_quality_estimator_teacher.py.

◆ process_type

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

◆ training_target

training_target
staticinherited
Initial value:
= b2luigi.Parameter(
)

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

Definition at line 1181 of file combined_quality_estimator_teacher.py.

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