Belle II Software  release-05-02-19
ClassificationOverview Class Reference

Public Member Functions

def __init__ (self, output_file_name, truth_name=None, select=[], exclude=[], groupbys=[], auxiliaries=[], filters=[])
 
def train (self, input_tree)
 

Public Attributes

 output_file_name
 cached output filename
 
 truth_name
 cached truth name
 
 select
 cached selection-specifier array
 
 exclude
 cached exclusion-specifier array
 
 groupbys
 cached groupby-specifier array
 
 auxiliaries
 cached auxiliary-specifier array
 
 filters
 cached filter-specifier array
 
 classification_analyses
 array of classification analyses
 

Detailed Description

Class to generate overview plots for the classification power of various variables from a TTree.

In order to get an overview, which variables from a diverse set, generated from a recording filter
or some other sort of validation, perform well in classification task.

Definition at line 29 of file train.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  output_file_name,
  truth_name = None,
  select = [],
  exclude = [],
  groupbys = [],
  auxiliaries = [],
  filters = [] 
)
Constructor

Definition at line 37 of file train.py.

37  def __init__(self,
38  output_file_name,
39  truth_name=None,
40  select=[],
41  exclude=[],
42  groupbys=[],
43  auxiliaries=[],
44  filters=[]):
45  """Constructor"""
46 
47  self.output_file_name = output_file_name
48 
49  self.truth_name = truth_name
50 
51  self.select = select
52 
53  self.exclude = exclude
54 
55  self.groupbys = groupbys
56 
57  self.auxiliaries = auxiliaries
58 
59  self.filters = filters
60 
61 
62  self.classification_analyses = []
63 

Member Function Documentation

◆ train()

def train (   self,
  input_tree 
)
Main method feed with a TTree containing the truth variable and the variables to be investigated.

Branches that contain "truth" in the name are considered to directly contain information about
true classification target and are not analysed here.

Args:
    input_tree (ROOT.TTree) : Tree containing the variables to be investigated
as well as the classification target.
    truth_name (str, optional) : Name of the branch of the classification target.
If not given the Branch with the shortest name containing "truth" is selected.

Definition at line 64 of file train.py.


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